ChartnautDocs

List runs

GET/runs

Returns your runs, newest first, without console. Call it to find a run you started earlier, or the study runs you made in the app.

Scope

Heavy call

Long poll

CLI

scripts:read

No

No

chartnaut runs

Guidance

  • By default only runs started through the API come back. source=app lists the study runs you made in the app, with ids starting srun_, and source=all lists both. Every run endpoint works on either kind of id.

  • script=bull-bar keeps runs of that script at any version; script=bull-bar@4 keeps one version. Runs of inline source have script inline.

  • status=failed with a script filter is the quick way to see why a script keeps failing: each run's failure says what went wrong.

  • For an indicator or definition run, results_expire_at says when its results go; past it, Get run results answers 410. Study results do not expire.

  • To follow one run, call Get a run with wait rather than polling this list.

Query parameters

Name

Type

Required

Default

Description

source

string

No

api

api for runs started through the API, app for study runs made in the app, all for both

script

string

No

None

Keeps runs whose script is this ref, or this ref with any version. Ignored with source=app

status

string

No

None

queued, running, succeeded, failed or cancelled

limit

integer

No

50

Most 200

cursor

string

No

None

From the previous page's next_cursor

Response

200 with a page whose data is an array of Run, without console.

Status codes

Status

Code

Meaning

200

-

A page of your runs

400

invalid_request

source is not api, app or all

500

internal

Your runs could not be read. Retry