List runs
/runsReturns 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 |
|---|---|---|---|
| No | No |
|
Guidance
By default only runs started through the API come back.
source=applists the study runs you made in the app, with ids startingsrun_, andsource=alllists both. Every run endpoint works on either kind of id.script=bull-barkeeps runs of that script at any version;script=bull-bar@4keeps one version. Runs of inline source havescriptinline.status=failedwith ascriptfilter is the quick way to see why a script keeps failing: each run'sfailuresays what went wrong.For an indicator or definition run,
results_expire_atsays when its results go; past it, Get run results answers410. Study results do not expire.To follow one run, call Get a run with
waitrather than polling this list.
Query parameters
Name | Type | Required | Default | Description |
|---|---|---|---|---|
| string | No |
|
|
| string | No | None | Keeps runs whose |
| string | No | None |
|
| integer | No | 50 | Most 200 |
| string | No | None | From the previous page's |
Response
200 with a page whose data is an array of Run, without console.
Status codes
Status | Code | Meaning |
|---|---|---|
| - | A page of your runs |
|
|
|
|
| Your runs could not be read. Retry |
