List schedulers

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,
          "exportPivotedData": true,
          "asAttachment": true
        },
        "appName": "<string>",
        "appUuid": null,
        "savedSqlName": "<string>",
        "savedSqlUuid": null,
        "dashboardName": "<string>",
        "dashboardUuid": null,
        "savedChartName": "<string>",
        "savedChartUuid": "<string>",
        "cron": "<string>",
        "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>"
          }
        ],
        "projectName": "<string>",
        "projectUuid": "<string>",
        "thresholds": [
          {
            "value": 123,
            "fieldId": "<string>"
          }
        ],
        "projectSchedulerTimezone": "<string>",
        "timezone": "<string>",
        "message": "<string>",
        "parameters": {},
        "filters": {
          "tableCalculations": {
            "or": [
              {
                "id": "<string>",
                "target": {
                  "fieldId": "<string>"
                },
                "includeNull": true,
                "values": [
                  "<unknown>"
                ],
                "settings": "<unknown>",
                "disabled": true,
                "required": true,
                "caseSensitive": true
              }
            ],
            "id": "<string>"
          },
          "metrics": {
            "or": [
              {
                "id": "<string>",
                "target": {
                  "fieldId": "<string>"
                },
                "includeNull": true,
                "values": [
                  "<unknown>"
                ],
                "settings": "<unknown>",
                "disabled": true,
                "required": true,
                "caseSensitive": true
              }
            ],
            "id": "<string>"
          },
          "dimensions": {
            "or": [
              {
                "id": "<string>",
                "target": {
                  "fieldId": "<string>"
                },
                "includeNull": true,
                "values": [
                  "<unknown>"
                ],
                "settings": "<unknown>",
                "disabled": true,
                "required": true,
                "caseSensitive": true
              }
            ],
            "id": "<string>"
          }
        },
        "latestRun": {
          "createdByUserName": "<string>",
          "createdByUserUuid": "<string>",
          "resourceName": "<string>",
          "resourceUuid": "<string>",
          "logCounts": {
            "error": 123,
            "completed": 123,
            "started": 123,
            "scheduled": 123,
            "total": 123
          },
          "details": {},
          "createdAt": "2023-11-07T05:31:56Z",
          "scheduledTime": "2023-11-07T05:31:56Z",
          "schedulerName": "<string>",
          "schedulerUuid": "<string>",
          "runId": "<string>"
        }
      }
    ],
    "pagination": {
      "page": 123,
      "pageSize": 123,
      "totalResults": 123,
      "totalPageCount": 123
    }
  },
  "status": "ok"
}

{
  "error": {
    "name": "<string>",
    "statusCode": 123,
    "data": "<unknown>",
    "message": "<string>"
  },
  "status": "error"
}

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, googlechat)

includeLatestRun · boolean

Response

200

application/json

Success

results · object · required

Show child attributes

status · enum<string> · required

Available options: ok