Get apiv1schedulers list

List all schedulers with pagination, search, sorting, and filtering

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

Error

A valid request URL is required to generate request examples

200

{
  "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

200

application/json

Success

results · object · required

Show child attributes

results. data · object[] · required

Option 1

Option 2

Show child attributes

results.data. includeLinks · boolean · required

results.data. enabled · boolean · required

results.data. options · object · required

Option 1

Option 2

Option 3

Show child attributes

results.data.options. limit · required

results.data.options. formatted · boolean · required

results.data.options. asAttachment · boolean

results.data. dashboardName · string | null · required

results.data. dashboardUuid · null · required

Available options:

results.data. savedChartName · string | null · required

results.data. savedChartUuid · string · required

results.data. cron · string · required

results.data. format · enum<string> · required

Available options: csv, xlsx, image, gsheets

results.data. createdByName · string | null · required

results.data. createdBy · string · required

results.data. updatedAt · string<date-time> · required

results.data. createdAt · string<date-time> · required

results.data. name · string · required

results.data. schedulerUuid · string · required

results.data. targets · object[] · required

Option 1

Option 2

Option 3

Show child attributes

results.data.targets. channel · string · required

results.data.targets. schedulerUuid · string · required

results.data.targets. updatedAt · string<date-time> · required

results.data.targets. createdAt · string<date-time> · required

results.data.targets. schedulerSlackTargetUuid · string · required

results.data. notificationFrequency · enum<string>

Available options: always, once

results.data. thresholds · object[]

Show child attributes

results.data.thresholds. value · number<double> · required

results.data.thresholds. fieldId · string · required

results.data.thresholds. operator · enum<string> · required

Available options: greaterThan, lessThan, increasedBy, decreasedBy

results.data. timezone · string

results.data. message · string

results.data. latestRun · object

Show child attributes

results.data.latestRun. format · enum<string> · required

Available options: csv, xlsx, image, gsheets

results.data.latestRun. createdByUserName · string · required

results.data.latestRun. createdByUserUuid · string · required

results.data.latestRun. resourceName · string · required

results.data.latestRun. resourceUuid · string · required

results.data.latestRun. resourceType · enum<string> · required

Available options: chart, dashboard

results.data.latestRun. logCounts · object · required

Show child attributes

results.data.latestRun.logCounts. error · number<double> · required

results.data.latestRun.logCounts. completed · number<double> · required

results.data.latestRun.logCounts. started · number<double> · required

results.data.latestRun.logCounts. scheduled · number<double> · required

results.data.latestRun.logCounts. total · number<double> · required

results.data.latestRun. details · object · required

Construct a type with a set of properties K of type T

Show child attributes

results.data.latestRun.details. {key} · any

results.data.latestRun. createdAt · string<date-time> · required

results.data.latestRun. runStatus · enum<string> · required

Available options: completed, partial_failure, failed, running, scheduled

results.data.latestRun. status · enum<string> · required

Available options: scheduled, started, completed, error

results.data.latestRun. scheduledTime · string<date-time> · required

results.data.latestRun. schedulerName · string · required

results.data.latestRun. schedulerUuid · string · required

results.data.latestRun. runId · string · required

results. pagination · object

Show child attributes

results.pagination. page · number<double> · required

results.pagination. pageSize · number<double> · required

results.pagination. totalResults · number<double> · required

results.pagination. totalPageCount · number<double> · required

status · enum<string> · required

Available options: ok