List All Runs

Every run the team has made, last executed first.

By when it last ran rather than when it was made: an instance is forked, edited and only then executed, so the two orders differ. Includes runs somebody deleted, which are exactly the ones asked about afterwards. A cursor carries the order it was issued under, so a page token does not survive sort or order changing.

GET/api/v1/runs

Authorization

AuthorizationBearer token · headerrequired

AuthorizationOAuth2 access token · headerrequired

Query parameters

statusRunStatus[] | any

Only runs in these states; repeat for several

ownerstring[] | any

Clerk user ids of whoever started them

daysinteger

How far back to look

min 1 · max 365 · default: 7

sortRunSort

Which column orders the feed

Allowed:created_atstarted_atcredits_totalstatusgraph_nameowner_nameduration_seconds

orderSortOrder

Which way that field runs

Allowed:ascdesc

limitinteger

min 1 · max 100 · default: 50

afterstring | any

The `next_cursor` of the page before this one

Responses

200Successful Response

successboolean

default: true

dataRunMonitorList | any

Show properties

Any of:

RunMonitorList

rowsRunMonitorRow[]required

Show properties

Array of RunMonitorRow

idstringrequired

graph_idstring | any

Show properties

Any of:

string

string

any

any

graph_namestring

default: ""

owner_idstringrequired

owner_namestringrequired

owner_image_urlstring | any

Show properties

Any of:

string

string

any

any

task_namestring | any

Show properties

Any of:

string

string

any

any

statusRunStatusrequired

Allowed:draftqueuedrunningawaiting_inputsucceededfailedcancelled

created_atstring<date-time>required

started_atstring<date-time> | any

Show properties

Any of:

string<date-time>

string<date-time>

any

any

finished_atstring<date-time> | any

Show properties

Any of:

string<date-time>

string<date-time>

any

any

credits_totalnumber

default: 0

errorstring | any

Show properties

Any of:

string

string

any

any

node_idstring | any

Show properties

Any of:

string

string

any

any

exported_atstring<date-time> | any

Show properties

Any of:

string<date-time>

string<date-time>

any

any

deleted_atstring<date-time> | any

Show properties

Any of:

string<date-time>

string<date-time>

any

any

ownersRunOwner[]

Show properties

Array of RunOwner

idstringrequired

namestringrequired

image_urlstring | any

Show properties

Any of:

string

string

any

any

next_cursorstring | any

Show properties

Any of:

string

string

any

any

any

any

messagestring | any

Show properties

Any of:

string

string

any

any

errorsstring[] | any

Show properties

Any of:

string[]

Array of string

string

any

any

422Validation Error

detailValidationError[]

Show properties

Array of ValidationError

locstring | integer[]required

Show properties

Array of string | integer

Any of:

string

string

integer

integer

msgstringrequired

typestringrequired

inputany

ctxobject

Request

curl -X GET "/api/v1/runs" \
  -H "Authorization: Bearer YOUR_TOKEN"

const response = await fetch("/api/v1/runs", {
  method: "GET",
  headers: {
    "Authorization": "Bearer YOUR_TOKEN"
  }
});

import requests

response = requests.get(
    "/api/v1/runs",
    headers={
        "Authorization": "Bearer YOUR_TOKEN"
    },
)

Response

{
  "success": true,
  "data": {
    "rows": [
      {
        "id": "string",
        "graph_id": "string",
        "graph_name": "",
        "owner_id": "string",
        "owner_name": "string",
        "owner_image_url": "string",
        "task_name": "string",
        "status": "draft",
        "created_at": "2019-08-24T14:15:22Z",
        "started_at": "2019-08-24T14:15:22Z",
        "finished_at": "2019-08-24T14:15:22Z",
        "credits_total": 0,
        "error": "string",
        "node_id": "string",
        "exported_at": "2019-08-24T14:15:22Z",
        "deleted_at": "2019-08-24T14:15:22Z"
      }
    ],
    "owners": [
      {
        "id": "string",
        "name": "string",
        "image_url": "string"
      }
    ],
    "next_cursor": "string"
  },
  "message": "string",
  "errors": [
    "string"
  ]
}