Create SQL chart scheduler

Create a scheduler for a SQL chart

POST /api/v1/projects/{projectUuid}/sqlRunner/saved/{savedSqlUuid}/schedulers

Error

A valid request URL is required to generate request examples

201

{
  "results": {
    "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>"
    }
  },
  "status": "ok"
}

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

Path Parameters

projectUuid · string · required

savedSqlUuid · string · required

Body

application/json

Construct a type with the properties of T except for those in type K.

name · string · required

cron · string · required

enabled · boolean · required

format · enum<string> · required

Available options: csv, xlsx, image, gsheets, pdf

appUuid · string | null · required

appName · string | null · required

options · object · required

Option 1

Option 2

Option 3

Option 4

Show child attributes

includeLinks · boolean · required

targets · object[] · required

From T, pick a set of properties whose keys are in the union K

Option 1

Option 2

Option 3

Option 4

Show child attributes

projectUuid · string | null

timezone · string

message · string

projectSchedulerTimezone · string

thresholds · object[]

Show child attributes

notificationFrequency · enum<string>

Available options: always, once

projectName · string | null

aiAugmentation · object

Enterprise-only AI augmentation attached to a scheduled delivery. On each fire the agent (or ambient fast model) writes the delivery message from the delivery's content and the prompt. Persisted in the EE scheduler_ai_augmentation satellite table, not on the scheduler itself, so OSS carries none of it.

Option 1

Option 2

Show child attributes

Response

201

application/json

Created

results · object · required

Option 1

Option 2

Option 3

Option 4

Show child attributes

status · enum<string> · required

Available options: ok