Skip to main content
Return a page of runs, newest first. Use each run ID to get its current status. The listAll* variant yields items across every page. The other variant returns one page with pagination metadata. See Pagination.

Signature

Method signatures on client.runs:

Parameters

listAll()

string
required
Pipeline ID with prefix pl..
number
default:"20"
Maximum number of results to return; defaults to 20.
number
default:"0"
Number of results to skip before this page; defaults to 0.

listPage()

string
required
Pipeline ID with prefix pl..
number
default:"20"
Maximum number of results to return; defaults to 20.
number
default:"0"
Number of results to skip before this page; defaults to 0.

Returns

listAll() result

AsyncGenerator<RunSummary> Yields one item at a time. The fields below describe each yielded item. A pipeline run summary; poll GET /runs/:runId for status.
RunId
required
Pipeline run ID with prefix plr..
DatasetId
required
Dataset ID with prefix ds..
string
required
Time the run was created, as an ISO 8601 timestamp.

listPage() result

Promise<{ runs: RunSummary[]; pagination: Pagination }>
RunSummary[]
required
Pipeline runs in this page.
Pagination
required
Pagination information for this page.

Errors

HTTP errors throw PotatoApiError. The endpoint documents these error responses: HTTP endpoint: GET /pipelines/{pipelineId}/runs.