List scheduler runs

Get paginated scheduler runs with aggregated child job counts

GET /api/v1/schedulers/{projectUuid}/runs

Error

A valid request URL is required to generate request examples

200

{
  "results": {
    "data": [
      {
        "format": "csv",
        "createdByUserName": "<string>",
        "createdByUserUuid": "<string>",
        "resourceName": "<string>",
        "resourceUuid": "<string>",
        "resourceType": "chart",
        "logCounts": {
          "error": 123,
          "completed": 123,
          "started": 123,
          "scheduled": 123,
          "total": 123
        },
        "details": {},
        "createdAt": "2023-11-07T05:31:56Z",
        "runStatus": "completed",
        "status": "scheduled",
        "scheduledTime": "2023-11-07T05:31:56Z",
        "schedulerName": "<string>",
        "schedulerUuid": "<string>",
        "runId": "<string>"
      }
    ],
    "pagination": {
      "page": 123,
      "pageSize": 123,
      "totalResults": 123,
      "totalPageCount": 123
    }
  },
  "status": "ok"
}

Path Parameters

projectUuid · string · required

The uuid of the project

Query Parameters

pageSize · number<double>

number of items per page

page · number<double>

page number

searchQuery · string

search query to filter runs by scheduler name

sortBy · enum<string>

column to sort by (scheduledTime, createdAt)

Available options: scheduledTime, createdAt

sortDirection · enum<string>

sort direction (asc or desc)

Available options: asc, desc

schedulerUuids · string

filter by specific scheduler UUIDs (comma-separated)

statuses · string

filter by run statuses (comma-separated: completed, partial_failure, failed, running, scheduled)

createdByUserUuids · string

filter by creator user UUIDs (comma-separated)

destinations · string

filter by destination types (comma-separated: email, slack, msteams)

resourceType · enum<string>

filter by resource type (chart or dashboard)

Available options: chart, dashboard

resourceUuids · string

filter by resource UUIDs (comma-separated)

Response

200

application/json

Success

results · object · required

Show child attributes

status · enum<string> · required

Available options: ok