Skip to main content
GET
/
api
/
v1
/
schedulers
/
{projectUuid}
/
list
Error
A valid request URL is required to generate request examples
{
  "results": {
    "data": [
      {
        "includeLinks": true,
        "enabled": true,
        "options": {
          "limit": 123,
          "formatted": true,
          "asAttachment": true
        },
        "dashboardName": "<string>",
        "dashboardUuid": null,
        "savedChartName": "<string>",
        "savedChartUuid": "<string>",
        "cron": "<string>",
        "format": "csv",
        "createdByName": "<string>",
        "createdBy": "<string>",
        "updatedAt": "2023-11-07T05:31:56Z",
        "createdAt": "2023-11-07T05:31:56Z",
        "name": "<string>",
        "schedulerUuid": "<string>",
        "targets": [
          {
            "channel": "<string>",
            "schedulerUuid": "<string>",
            "updatedAt": "2023-11-07T05:31:56Z",
            "createdAt": "2023-11-07T05:31:56Z",
            "schedulerSlackTargetUuid": "<string>"
          }
        ],
        "notificationFrequency": "always",
        "thresholds": [
          {
            "value": 123,
            "fieldId": "<string>",
            "operator": "greaterThan"
          }
        ],
        "timezone": "<string>",
        "message": "<string>",
        "latestRun": {
          "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

Query Parameters

​
pageSize
number<double>

number of items per page

​
page
number<double>

page number

​
searchQuery
string

search query to filter schedulers by name

​
sortBy
enum<string>

column to sort by

Available options:
name,
createdAt
​
sortDirection
enum<string>

sort direction (asc or desc)

Available options:
asc,
desc
​
createdByUserUuids
string

filter by creator user UUIDs (comma-separated)

​
formats
string

filter by scheduler formats (comma-separated)

​
resourceType
enum<string>

filter by resource type (chart or dashboard)

Available options:
chart,
dashboard
​
resourceUuids
string

filter by resource UUIDs (comma-separated)

​
destinations
string

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

​
includeLatestRun
boolean

Response

Success

​
results
object
required
​
status
enum<string>
required
Available options:
ok