Referencev2
List dashboard scheduler runs
Get the run history of a single scheduler on a dashboard
GET/api/v2/dashboards/{dashboardUuid}/schedulers/{schedulerUuid}/runs
Authentication: personal access token. The spec defines an api_key security
scheme — send an Authorization: ApiKey <your-personal-access-token> header
(value format: ApiKey <your key>). A session_cookie scheme (connect.sid)
exists for browser sessions. Operations in this spec declare security: [], an
artifact of the upstream spec generator — authentication is still enforced by the
server.
Path parameters
| Name | Type | Required | Description |
|---|---|---|---|
dashboardUuid | string | Yes | The uuid of the dashboard |
schedulerUuid | string | Yes | The uuid of the scheduler |
Query parameters
| Name | Type | Required | Description |
|---|---|---|---|
pageSize | number | No | number of items per page |
page | number | No | page number |
searchQuery | string | No | filter runs by scheduler name |
sortBy | string | No | column to sort by (scheduledTime, createdAt) |
sortDirection | string | No | sort direction (asc or desc) |
statuses | string | No | comma-separated list of run statuses to include |
destinations | string | No | comma-separated list of destination types to include |
Responses
200 — Success
{
"results": {
"pagination": {
"page": 0,
"pageSize": 0,
"totalResults": 0,
"totalPageCount": 0
},
"data": [
{
"format": "csv",
"createdByUserName": "string",
"createdByUserUuid": "string",
"resourceName": "string",
"resourceUuid": "string",
"resourceType": "chart",
"logCounts": {
"error": 0,
"completed": 0,
"started": 0,
"scheduled": 0,
"total": 0
},
"details": {},
"createdAt": "2024-01-01T00:00:00.000Z",
"runStatus": "completed",
"status": "scheduled",
"scheduledTime": "2024-01-01T00:00:00.000Z",
"schedulerName": "string",
"schedulerUuid": "string",
"runId": "string"
}
]
},
"status": "ok"
}default — Error
{
"error": {
"data": "string",
"message": "string",
"name": "string",
"statusCode": 0
},
"status": "error"
}