ovidens
API reference

The app's run history, newest first

GET/v1/apps/{app}/runs

One page of the app's run history, newest first, with the applied limit and offset echoed so a paging loop is self-describing. Requires the workspace:read scope. Runs whose target is draft are previews of unpublished work: they are listed, and counted in total, only for a credential that also holds pipeline:run_draft. Runs whose output data retention has already removed are INCLUDED and flagged dataAvailable: false, because a client holding the identifier of a run it started itself must still find it. triggeredBy names the credential when an unattended system started the run and is null when a person or the workspace assistant did.

Authorization

bearerAuth
AuthorizationBearer <token>

Obtain a token from https://id.ovidens.com/oauth/token using the client_credentials grant.

In: header

Path Parameters

app*string

The app's stable technicalId, as reported by listApps. It is a snake_case identifier, never a numeric id, and it survives a rename of the app.

Length1 <= length <= 64

Query Parameters

limit?integer

How many runs to return, newest first. 1 to 100; defaults to 20.

Range1 <= value <= 100
Default20
offset?integer

How many runs to skip before the page begins. Defaults to 0.

Range0 <= value <= 9007199254740991
Default0
curl -X GET "https://example.com/v1/apps/string/runs"
{  "runs": [    {      "runId": 0,      "status": "running",      "target": "published",      "startedAt": "string",      "finishedAt": "string",      "durationMs": 0,      "dataAvailable": true,      "triggeredBy": {        "clientId": "string",        "name": "string"      },      "nodeSummary": {        "total": 0,        "success": 0,        "failed": 0,        "skipped": 0      }    }  ],  "total": 0,  "limit": 0,  "offset": 0}

Response Body

application/json

application/json

application/json

application/json

application/json

application/json

Was this page helpful?