Data alerts

Supports chart sharing, chart monitoring and alerting features. The legacy sharing APIs refer to chart sharing and chart monitoring, which is a feature that allows the user to send an e-mail with an embedded chart either manually (chart sharing) or in a recurring manner (chart monitoring). It also stores the history related to these actions. The alerting/ data-alerts APIs support the alerting feature, where a user is able to create alerts that trigger notifications in case a condition in the dataset of an app is fulfilled.

Endpoints

Skip to section
GET/v1/data-alerts
POST/v1/data-alerts
GET/v1/data-alerts/{alertId}
PATCH/v1/data-alerts/{alertId}
DELETE/v1/data-alerts/{alertId}
GET/v1/data-alerts/{alertId}/condition
GET/v1/data-alerts/{alertId}/executions/{executionId}
DELETE/v1/data-alerts/{alertId}/executions/{executionId}
GET/v1/data-alerts/{alertId}/recipient-stats
GET/v1/data-alerts/{taskId}/executions
GET/v1/data-alerts/{taskId}/executions/{executionId}/evaluations
GET/v1/data-alerts/{taskId}/executions/stats
POST/v1/data-alerts/actions/trigger
POST/v1/data-alerts/actions/validate
GET/v1/data-alerts/settings
PUT/v1/data-alerts/settings

Get a list of alerting tasks.

manage

Facts GET /v1/data-alerts

Rate limit
Tier 1 (1000 requests per minute)

Query Parameters GET /v1/data-alerts

appID
optional
string

The app ID you would like to filter by

conditionId
optional
string

The conditionId you would like to filter by

limit
optional, default=20, minimum=1, maximum=100
integer

Limit the returned result set

next
optional
string

The cursor to the next page of data. Only one of next or previous may be specified.

offset
optional
integer

Offset for finding a list of entities - used for pagination

ownerId
optional
string

The id of the owner you would like to filter by

ownerName
optional
string

The name of the owner you would like to filter by

prev
optional
string

The cursor to the previous page of data. Only one of next or previous may be specified.

role
optional
Array<string>

No description

Enum:

owner

recipient

notowner

sort
optional
Array<string>

No description

Enum:

-datecreated

datecreated

+datecreated

-ownername

ownername

+ownername

lasttrigger

-lasttrigger

+lasttrigger

lastscan

-lastscan

+lastscan

name

-name

+name

enabled

-enabled

+enabled

status

-status

+status

nextexecutiontime

-nextexecutiontime

+nextexecutiontime

status
optional
Array<string>

No description

Enum:

INVALID_RECIPIENT

INVALID_OWNER

DISABLED

VALID

Responses GET /v1/data-alerts

200
optional, application/json

The alerting tasks list has been successfully returned.

400
optional, application/json

Bad request, malformed syntax or errors in parameters.

500
optional, application/json

Internal server error.

default
optional, application/json

Error response.

GET/v1/data-alerts

curl "https://your-tenant.us.qlikcloud.com/api/v1/data-alerts" \
 -H "Authorization: Bearer <API-key>"

Response GET /v1/data-alerts

{
  "undefined": {
    "totalCount": 0,
    "currentPageCount": 0,
    "links": {
      "next": {
        "href": "http://localhost:8787/v1/items?limit=12",
        "type": "next",
        "token": "JwAAAAJfaWQAGQAAADVjZjUwM2NjMjVkYzlhMTM1MzYwZTVjZAAA"
      },
      "prev": {
        "href": "http://localhost:8787/v1/items?limit=12",
        "type": "next",
        "token": "JwAAAAJfaWQAGQAAADVjZjUwM2NjMjVkYzlhMTM1MzYwZTVjZAAA"
      },
      "self": {
        "href": "http://localhost:8787/v1/items/5da5825325dc9a0dd0260af9"
      }
    },
    "tasks": [
      {
        "id": "5da5825325dc9a0dd0260af9",
        "name": "string",
        "appId": "string",
        "links": {
          "self": {
            "href": "http://localhost:8787/v1/items/5da5825325dc9a0dd0260af9"
          }
        },
        "status": "creating",
        "enabled": true,
        "ownerId": "string",
        "sheetId": "string",
        "lastScan": "string",
        "tenantId": "string",
        "ownerName": "string",
        "accessMode": "SOURCE_ACCESS",
        "bookmarkId": "string",
        "recipients": {
          "userIds": [
            {
              "value": "1b263bs8m0mm_s21s3f",
              "groups": [
                "addedIndividually",
                "group1",
                "group2"
              ],
              "enabled": true,
              "subscribed": true,
              "taskRecipientErrors": [
                {
                  "value": "USER_IS_DELETED",
                  "timestamp": "2019-10-15T16:07:01.492Z"
                }
              ],
              "alertingTaskRecipientErrors": [
                {
                  "added": "2019-10-15T16:07:01.492Z",
                  "value": "USER_IS_DELETED"
                }
              ]
            }
          ],
          "groupIds": [
            {
              "value": "group1",
              "enabled": true,
              "taskGroupRecipientErrors": [
                {
                  "value": "GROUP_IS_DISABLED",
                  "timestamp": "2019-10-15T16:07:01.492Z"
                }
              ],
              "alertingTaskGroupRecipientErrors": [
                {
                  "added": "2019-10-15T16:07:01.492Z",
                  "value": "GROUP_IS_DISABLED"
                }
              ]
            }
          ]
        },
        "throttling": {
          "capacity": 0,
          "timezone": "Etc/UTC",
          "replenishRate": 0,
          "recurrenceRule": "string",
          "initialTokenCount": 0,
          "referenceTimestamp": "string"
        },
        "conditionId": "string",
        "dateCreated": "2019-10-15T16:07:01.492Z",
        "description": "string",
        "errorStatus": "OK",
        "lastTrigger": "string",
        "lastUpdated": "2019-10-15T16:07:01.492Z",
        "triggerType": "RELOAD",
        "triggerStats": {
          "totalScans": 0,
          "last10Scans": 0,
          "last100Scans": 0
        },
        "hideSelections": true,
        "evaluationCount": 0,
        "scheduleOptions": {
          "timezone": "Canada/Pacific",
          "recurrence": [
            "RRULE:FREQ=HOURLY;INTERVAL=2"
          ],
          "endDateTime": "2026-01-02T16:04:05",
          "chronosJobID": "string",
          "startDateTime": "2006-01-02T16:04:05",
          "lastExecutionTime": "2020-11-20T12:00:55.000Z",
          "nextExecutionTime": "2020-11-20T12:00:55.000Z"
        },
        "subscriptionIds": [],
        "absoluteLastScan": "string",
        "conditionResponse": {},
        "alertingTaskErrors": [
          {
            "added": "2019-10-15T16:07:01.492Z",
            "value": "OWNER_DISABLED"
          }
        ],
        "absoluteLastTrigger": "string",
        "hasHistoryCondition": true,
        "lastExecutionStatus": "OK",
        "recipientsChangeHistory": [
          {
            "dateTime": "string",
            "patchAction": [
              {
                "op": "add",
                "value": {
                  "value": "recipient-1",
                  "enabled": true
                },
                "recipientType": "userid"
              },
              {
                "op": "remove",
                "value": "I6mWVd60wRWIbOXZr1ZKV8QTnxhnitb",
                "recipientType": "userid"
              },
              {
                "op": "enable",
                "value": "I6mWVd60wRWIbOXZr1ZKV8QTnxhnitb",
                "recipientType": "userid"
              },
              {
                "op": "disable",
                "value": "I6mWVd60wRWIbOXZr1ZKV8QTnxhnitb",
                "recipientType": "userid"
              },
              {
                "op": "replace",
                "value": [
                  {
                    "value": "recipient-1",
                    "enabled": true
                  },
                  {
                    "value": "recipient-2",
                    "enabled": false
                  }
                ],
                "recipientType": "userid"
              }
            ]
          }
        ],
        "lastEvaluationCountUpdate": "string"
      }
    ]
  }
}

Creates a new alerting task.

manage

Facts POST /v1/data-alerts

Rate limit
Tier 2 (100 requests per minute)

Request Body POST /v1/data-alerts

The alerting task create request definition.

Responses POST /v1/data-alerts

202
optional, application/json

Alert creation has been accepted. The alerting task will have status creating, until status is set to either valid or invalid.

400
optional, application/json

Bad request, malformed syntax or errors in parameters.

500
optional, application/json

Internal server error.

default
optional, application/json

Error response.

POST/v1/data-alerts

curl "https://your-tenant.us.qlikcloud.com/api/v1/data-alerts" \
 -X POST \
 -H "Authorization: Bearer <API-key>" \
 -H "Content-type: application/json" \
 -d '{"name":"string","appId":"string","enabled":true,"sheetId":"string","bookmarkId":"string","recipients":{"userIds":[{"value":"1b263bs8m0mm_s21s3f","groups":["addedIndividually","group1","group2"],"enabled":true,"subscribed":true,"taskRecipientErrors":[{"value":"USER_IS_DELETED","timestamp":"2019-10-15T16:07:01.492Z"}],"alertingTaskRecipientErrors":[{"added":"2019-10-15T16:07:01.492Z","value":"USER_IS_DELETED"}]}],"groupIds":[{"value":"group1","enabled":true,"taskGroupRecipientErrors":[{"value":"GROUP_IS_DISABLED","timestamp":"2019-10-15T16:07:01.492Z"}],"alertingTaskGroupRecipientErrors":[{"added":"2019-10-15T16:07:01.492Z","value":"GROUP_IS_DISABLED"}]}]},"throttling":{"capacity":0,"timezone":"Etc/UTC","replenishRate":0,"recurrenceRule":"string","initialTokenCount":0,"referenceTimestamp":"string"},"conditionId":"string","description":"string","triggerType":"RELOAD","scheduleOptions":{"timezone":"Canada/Pacific","recurrence":["RRULE:FREQ=HOURLY;INTERVAL=2"],"endDateTime":"2026-01-02T16:04:05","chronosJobID":"string","startDateTime":"2006-01-02T16:04:05","lastExecutionTime":"2020-11-20T12:00:55.000Z","nextExecutionTime":"2020-11-20T12:00:55.000Z"}}'

Request POST /v1/data-alerts

{
  "name": "string",
  "appId": "string",
  "enabled": true,
  "sheetId": "string",
  "bookmarkId": "string",
  "recipients": {
    "userIds": [
      {
        "value": "1b263bs8m0mm_s21s3f",
        "groups": [
          "addedIndividually",
          "group1",
          "group2"
        ],
        "enabled": true,
        "subscribed": true,
        "taskRecipientErrors": [
          {
            "value": "USER_IS_DELETED",
            "timestamp": "2019-10-15T16:07:01.492Z"
          }
        ],
        "alertingTaskRecipientErrors": [
          {
            "added": "2019-10-15T16:07:01.492Z",
            "value": "USER_IS_DELETED"
          }
        ]
      }
    ],
    "groupIds": [
      {
        "value": "group1",
        "enabled": true,
        "taskGroupRecipientErrors": [
          {
            "value": "GROUP_IS_DISABLED",
            "timestamp": "2019-10-15T16:07:01.492Z"
          }
        ],
        "alertingTaskGroupRecipientErrors": [
          {
            "added": "2019-10-15T16:07:01.492Z",
            "value": "GROUP_IS_DISABLED"
          }
        ]
      }
    ]
  },
  "throttling": {
    "capacity": 0,
    "timezone": "Etc/UTC",
    "replenishRate": 0,
    "recurrenceRule": "string",
    "initialTokenCount": 0,
    "referenceTimestamp": "string"
  },
  "conditionId": "string",
  "description": "string",
  "triggerType": "RELOAD",
  "scheduleOptions": {
    "timezone": "Canada/Pacific",
    "recurrence": [
      "RRULE:FREQ=HOURLY;INTERVAL=2"
    ],
    "endDateTime": "2026-01-02T16:04:05",
    "chronosJobID": "string",
    "startDateTime": "2006-01-02T16:04:05",
    "lastExecutionTime": "2020-11-20T12:00:55.000Z",
    "nextExecutionTime": "2020-11-20T12:00:55.000Z"
  }
}

Response POST /v1/data-alerts

{
  "id": "5da5825325dc9a0dd0260af9",
  "name": "string",
  "appId": "string",
  "links": {
    "self": {
      "href": "http://localhost:8787/v1/items/5da5825325dc9a0dd0260af9"
    }
  },
  "status": "creating",
  "enabled": true,
  "ownerId": "string",
  "sheetId": "string",
  "lastScan": "string",
  "tenantId": "string",
  "ownerName": "string",
  "accessMode": "SOURCE_ACCESS",
  "bookmarkId": "string",
  "recipients": {
    "userIds": [
      {
        "value": "1b263bs8m0mm_s21s3f",
        "groups": [
          "addedIndividually",
          "group1",
          "group2"
        ],
        "enabled": true,
        "subscribed": true,
        "taskRecipientErrors": [
          {
            "value": "USER_IS_DELETED",
            "timestamp": "2019-10-15T16:07:01.492Z"
          }
        ],
        "alertingTaskRecipientErrors": [
          {
            "added": "2019-10-15T16:07:01.492Z",
            "value": "USER_IS_DELETED"
          }
        ]
      }
    ],
    "groupIds": [
      {
        "value": "group1",
        "enabled": true,
        "taskGroupRecipientErrors": [
          {
            "value": "GROUP_IS_DISABLED",
            "timestamp": "2019-10-15T16:07:01.492Z"
          }
        ],
        "alertingTaskGroupRecipientErrors": [
          {
            "added": "2019-10-15T16:07:01.492Z",
            "value": "GROUP_IS_DISABLED"
          }
        ]
      }
    ]
  },
  "throttling": {
    "capacity": 0,
    "timezone": "Etc/UTC",
    "replenishRate": 0,
    "recurrenceRule": "string",
    "initialTokenCount": 0,
    "referenceTimestamp": "string"
  },
  "conditionId": "string",
  "dateCreated": "2019-10-15T16:07:01.492Z",
  "description": "string",
  "errorStatus": "OK",
  "lastTrigger": "string",
  "lastUpdated": "2019-10-15T16:07:01.492Z",
  "triggerType": "RELOAD",
  "triggerStats": {
    "totalScans": 0,
    "last10Scans": 0,
    "last100Scans": 0
  },
  "hideSelections": true,
  "evaluationCount": 0,
  "scheduleOptions": {
    "timezone": "Canada/Pacific",
    "recurrence": [
      "RRULE:FREQ=HOURLY;INTERVAL=2"
    ],
    "endDateTime": "2026-01-02T16:04:05",
    "chronosJobID": "string",
    "startDateTime": "2006-01-02T16:04:05",
    "lastExecutionTime": "2020-11-20T12:00:55.000Z",
    "nextExecutionTime": "2020-11-20T12:00:55.000Z"
  },
  "subscriptionIds": [],
  "absoluteLastScan": "string",
  "conditionResponse": {},
  "alertingTaskErrors": [
    {
      "added": "2019-10-15T16:07:01.492Z",
      "value": "OWNER_DISABLED"
    }
  ],
  "absoluteLastTrigger": "string",
  "hasHistoryCondition": true,
  "lastExecutionStatus": "OK",
  "recipientsChangeHistory": [
    {
      "dateTime": "string",
      "patchAction": [
        {
          "op": "add",
          "value": {
            "value": "recipient-1",
            "enabled": true
          },
          "recipientType": "userid"
        },
        {
          "op": "remove",
          "value": "I6mWVd60wRWIbOXZr1ZKV8QTnxhnitb",
          "recipientType": "userid"
        },
        {
          "op": "enable",
          "value": "I6mWVd60wRWIbOXZr1ZKV8QTnxhnitb",
          "recipientType": "userid"
        },
        {
          "op": "disable",
          "value": "I6mWVd60wRWIbOXZr1ZKV8QTnxhnitb",
          "recipientType": "userid"
        },
        {
          "op": "replace",
          "value": [
            {
              "value": "recipient-1",
              "enabled": true
            },
            {
              "value": "recipient-2",
              "enabled": false
            }
          ],
          "recipientType": "userid"
        }
      ]
    }
  ],
  "lastEvaluationCountUpdate": "string"
}

Get an alerting task by its id

manage

Facts GET /v1/data-alerts/{alertId}

Rate limit
Tier 1 (1000 requests per minute)

Path Parameters GET /v1/data-alerts/{alertId}

alertId
string

The alerting task identifier.

Responses GET /v1/data-alerts/{alertId}

200
optional, application/json

Alert has been successfully returned.

400
optional, application/json

Bad request, malformed syntax or errors in parameters.

404
optional, application/json

Task or execution not found.

500
optional, application/json

Internal server error.

default
optional, application/json

Error response.

GET/v1/data-alerts/{alertId}

curl "https://your-tenant.us.qlikcloud.com/api/v1/data-alerts/{alertId}" \
 -H "Authorization: Bearer <API-key>"

Response GET /v1/data-alerts/{alertId}

{
  "id": "5da5825325dc9a0dd0260af9",
  "name": "string",
  "appId": "string",
  "links": {
    "self": {
      "href": "http://localhost:8787/v1/items/5da5825325dc9a0dd0260af9"
    }
  },
  "status": "creating",
  "enabled": true,
  "ownerId": "string",
  "sheetId": "string",
  "lastScan": "string",
  "tenantId": "string",
  "ownerName": "string",
  "accessMode": "SOURCE_ACCESS",
  "bookmarkId": "string",
  "recipients": {
    "userIds": [
      {
        "value": "1b263bs8m0mm_s21s3f",
        "groups": [
          "addedIndividually",
          "group1",
          "group2"
        ],
        "enabled": true,
        "subscribed": true,
        "taskRecipientErrors": [
          {
            "value": "USER_IS_DELETED",
            "timestamp": "2019-10-15T16:07:01.492Z"
          }
        ],
        "alertingTaskRecipientErrors": [
          {
            "added": "2019-10-15T16:07:01.492Z",
            "value": "USER_IS_DELETED"
          }
        ]
      }
    ],
    "groupIds": [
      {
        "value": "group1",
        "enabled": true,
        "taskGroupRecipientErrors": [
          {
            "value": "GROUP_IS_DISABLED",
            "timestamp": "2019-10-15T16:07:01.492Z"
          }
        ],
        "alertingTaskGroupRecipientErrors": [
          {
            "added": "2019-10-15T16:07:01.492Z",
            "value": "GROUP_IS_DISABLED"
          }
        ]
      }
    ]
  },
  "throttling": {
    "capacity": 0,
    "timezone": "Etc/UTC",
    "replenishRate": 0,
    "recurrenceRule": "string",
    "initialTokenCount": 0,
    "referenceTimestamp": "string"
  },
  "conditionId": "string",
  "dateCreated": "2019-10-15T16:07:01.492Z",
  "description": "string",
  "errorStatus": "OK",
  "lastTrigger": "string",
  "lastUpdated": "2019-10-15T16:07:01.492Z",
  "triggerType": "RELOAD",
  "triggerStats": {
    "totalScans": 0,
    "last10Scans": 0,
    "last100Scans": 0
  },
  "hideSelections": true,
  "evaluationCount": 0,
  "scheduleOptions": {
    "timezone": "Canada/Pacific",
    "recurrence": [
      "RRULE:FREQ=HOURLY;INTERVAL=2"
    ],
    "endDateTime": "2026-01-02T16:04:05",
    "chronosJobID": "string",
    "startDateTime": "2006-01-02T16:04:05",
    "lastExecutionTime": "2020-11-20T12:00:55.000Z",
    "nextExecutionTime": "2020-11-20T12:00:55.000Z"
  },
  "subscriptionIds": [],
  "absoluteLastScan": "string",
  "conditionResponse": {},
  "alertingTaskErrors": [
    {
      "added": "2019-10-15T16:07:01.492Z",
      "value": "OWNER_DISABLED"
    }
  ],
  "absoluteLastTrigger": "string",
  "hasHistoryCondition": true,
  "lastExecutionStatus": "OK",
  "recipientsChangeHistory": [
    {
      "dateTime": "string",
      "patchAction": [
        {
          "op": "add",
          "value": {
            "value": "recipient-1",
            "enabled": true
          },
          "recipientType": "userid"
        },
        {
          "op": "remove",
          "value": "I6mWVd60wRWIbOXZr1ZKV8QTnxhnitb",
          "recipientType": "userid"
        },
        {
          "op": "enable",
          "value": "I6mWVd60wRWIbOXZr1ZKV8QTnxhnitb",
          "recipientType": "userid"
        },
        {
          "op": "disable",
          "value": "I6mWVd60wRWIbOXZr1ZKV8QTnxhnitb",
          "recipientType": "userid"
        },
        {
          "op": "replace",
          "value": [
            {
              "value": "recipient-1",
              "enabled": true
            },
            {
              "value": "recipient-2",
              "enabled": false
            }
          ],
          "recipientType": "userid"
        }
      ]
    }
  ],
  "lastEvaluationCountUpdate": "string"
}

Updates an existing alerting task

manage

Facts PATCH /v1/data-alerts/{alertId}

Rate limit
Tier 2 (100 requests per minute)

Path Parameters PATCH /v1/data-alerts/{alertId}

alertId
string

The alerting task identifier.

Request Body PATCH /v1/data-alerts/{alertId}

optional, application/json

Patch request definition for an alerting task.

Responses PATCH /v1/data-alerts/{alertId}

204
optional
object

The alerting task has been successfully updated.

400
optional, application/json

The specified alerting task ID or body is invalid (e.g. not a number).

404
optional, application/json

An alerting task with the specified ID was not found.

500
optional, application/json

Internal server error.

default
optional, application/json

Error response.

PATCH/v1/data-alerts/{alertId}

curl "https://your-tenant.us.qlikcloud.com/api/v1/data-alerts/{alertId}" \
 -X PATCH \
 -H "Authorization: Bearer <API-key>" \
 -H "Content-type: application/json" \
 -d '{"op":"replace","path":"/ownerName","value":{}}'

Request PATCH /v1/data-alerts/{alertId}

{
  "op": "replace",
  "path": "/ownerName",
  "value": {}
}

Deletes an alerting task.

manage

Facts DELETE /v1/data-alerts/{alertId}

Rate limit
Tier 2 (100 requests per minute)

Path Parameters DELETE /v1/data-alerts/{alertId}

alertId
string

The alerting task identifier.

Responses DELETE /v1/data-alerts/{alertId}

204
optional
object

The alerting task has been successfully deleted.

400
optional, application/json

The specified alerting task ID is invalid (e.g. not a number).

404
optional, application/json

An alerting task with the specified ID was not found.

500
optional, application/json

Internal server error.

default
optional, application/json

Error response.

DELETE/v1/data-alerts/{alertId}

curl "https://your-tenant.us.qlikcloud.com/api/v1/data-alerts/{alertId}" \
 -X DELETE \
 -H "Authorization: Bearer <API-key>"

Get the condition associated with an alerting task

manage

Facts GET /v1/data-alerts/{alertId}/condition

Rate limit
Tier 1 (1000 requests per minute)

Path Parameters GET /v1/data-alerts/{alertId}/condition

alertId
string

The alerting task identifier.

Responses GET /v1/data-alerts/{alertId}/condition

200
optional, application/json

Condition associated with the alerting task has been successfully returned. See ConditionResponse in condition-manager api docs

400
optional, application/json

Bad request, malformed syntax or errors in parameters.

404
optional, application/json

Task or condition not found.

500
optional, application/json

Internal server error.

default
optional, application/json

Error response.

GET/v1/data-alerts/{alertId}/condition

curl "https://your-tenant.us.qlikcloud.com/api/v1/data-alerts/{alertId}/condition" \
 -H "Authorization: Bearer <API-key>"

Response GET /v1/data-alerts/{alertId}/condition

{
  "hideSelections": true,
  "conditionResponse": {}
}

Gets a specified alerting execution.

manage

Facts GET /v1/data-alerts/{alertId}/executions/{executionId}

Rate limit
Tier 1 (1000 requests per minute)

Path Parameters GET /v1/data-alerts/{alertId}/executions/{executionId}

alertId
string

The alerting task identifier.

executionId
string

The execution identifier. If value is "latest", the latest execution will be returned

Responses GET /v1/data-alerts/{alertId}/executions/{executionId}

200
optional, application/json

The execution has been successfully returned.

400
optional, application/json

The specified task or execution ID is invalid (e.g. not a number).

404
optional, application/json

Task or execution not found.

500
optional, application/json

Internal server error.

default
optional, application/json

Error response.

GET/v1/data-alerts/{alertId}/executions/{executionId}

curl "https://your-tenant.us.qlikcloud.com/api/v1/data-alerts/{alertId}/executions/{executionId}" \
 -H "Authorization: Bearer <API-key>"

Response GET /v1/data-alerts/{alertId}/executions/{executionId}

{
  "undefined": {
    "id": "string",
    "errors": [
      {
        "code": "string",
        "title": "string",
        "detail": "string"
      }
    ],
    "result": {
      "alertTriggerStatus": "alertSent",
      "throttlerTokensLeft": 5
    },
    "alertId": "string",
    "ownerId": "string",
    "measures": [],
    "tenantId": "string",
    "accessMode": "SOURCE_ACCESS",
    "bookmarkId": "string",
    "dimensions": [],
    "workflowId": "string",
    "conditionId": "string",
    "triggerTime": "string",
    "evaluationId": "string",
    "executionType": "INDIVIDUAL",
    "conditionStatus": "FINISHED",
    "executionEvaluationStatus": "CONDITION_MET",
    "links": {
      "self": {
        "href": "http://localhost:8787/v1/items/5da5825325dc9a0dd0260af9"
      }
    },
    "evaluation": {
      "id": "string",
      "result": "success",
      "status": "RUNNING",
      "endTime": "string",
      "ownerId": "string",
      "tenantId": "string",
      "contextId": "string",
      "startTime": "string",
      "resultData": {},
      "causalEvent": {},
      "conditionId": "string",
      "dataConditionEvaluatorId": "string"
    }
  }
}

Deletes an execution.

manage

Facts DELETE /v1/data-alerts/{alertId}/executions/{executionId}

Rate limit
Tier 2 (100 requests per minute)

Path Parameters DELETE /v1/data-alerts/{alertId}/executions/{executionId}

alertId
string

The alerting task identifier.

executionId
string

The execution identifier.

Responses DELETE /v1/data-alerts/{alertId}/executions/{executionId}

204
optional
object

The execution has been successfully deleted.

400
optional, application/json

The specified task or execution ID is invalid (e.g. not a number).

404
optional, application/json

Task or execution not found.

500
optional, application/json

Internal server error.

default
optional, application/json

Error response.

DELETE/v1/data-alerts/{alertId}/executions/{executionId}

curl "https://your-tenant.us.qlikcloud.com/api/v1/data-alerts/{alertId}/executions/{executionId}" \
 -X DELETE \
 -H "Authorization: Bearer <API-key>"

Get the recipient stats for an alerting task

manage

Facts GET /v1/data-alerts/{alertId}/recipient-stats

Rate limit
Tier 1 (1000 requests per minute)

Path Parameters GET /v1/data-alerts/{alertId}/recipient-stats

alertId
string

The alerting task identifier.

Query Parameters GET /v1/data-alerts/{alertId}/recipient-stats

groups
optional
Array<string>

The name of the groups you would like to filter by

sort
optional
Array<string>

No description

Enum:

+userID

-userID

subscribed

+subscribed

subscribed
optional
boolean

Subscribed property you would like to filter by

userID
optional
string

The recipients ID you would like to filter by

Responses GET /v1/data-alerts/{alertId}/recipient-stats

200
optional, application/json

Alert recipient stats have been successfully returned.

400
optional, application/json

Bad request, malformed syntax or errors in parameters.

404
optional, application/json

Task or execution not found.

500
optional, application/json

Internal server error.

default
optional, application/json

Error response.

GET/v1/data-alerts/{alertId}/recipient-stats

curl "https://your-tenant.us.qlikcloud.com/api/v1/data-alerts/{alertId}/recipient-stats" \
 -H "Authorization: Bearer <API-key>"

Response GET /v1/data-alerts/{alertId}/recipient-stats

{
  "recipientStats": [
    {
      "type": "userid",
      "value": "string",
      "errors": [
        {
          "code": "string",
          "title": "string",
          "detail": "string"
        }
      ],
      "groups": [
        "addedIndividually",
        "group1",
        "group2"
      ],
      "enabled": true,
      "lastScan": "string",
      "subscribed": true,
      "lastTrigger": "string",
      "conditionStatus": "OK"
    }
  ]
}

Lists all alerting-executions linked to a user and a tenant.

manage

Facts GET /v1/data-alerts/{taskId}/executions

Rate limit
Tier 1 (1000 requests per minute)

Path Parameters GET /v1/data-alerts/{taskId}/executions

taskId
string

The alerting task identifier.

Query Parameters GET /v1/data-alerts/{taskId}/executions

conditionId
optional
string

Filter by condition id related to the executions.

conditionStatus
optional
string

Filter by whether the alerting task execution status is FINISHED or FAILED.

Enum:

FINISHED

FAILED

ALL

daysOfMonth
optional
Array<integer>

Specifies required days of the month that the execution was created in

daysOfWeek
optional
Array<string>

Specifies a filter for custom handled periods of time in which the executions were handled

Enum:

MONDAY

TUESDAY

WEDNESDAY

THURSDAY

FRIDAY

SATURDAY

SUNDAY

fields
optional
Array<string>

Specifies specific properties to be populated

Enum:

evaluationId

triggerTime

conditionStatus

executionEvaluationStatus

evaluation

evaluation.endTime

evaluation.resultData

evaluation.resultData.count

evaluation.resultData.headers

evaluation.resultData.positive

evaluation.resultData.negative

evaluation.resultData.dimensions

evaluation.resultData.measures

includeEvaluation
optional
boolean

Specifies whether to include evaluation details

lastEachDay
optional
boolean

Specifies whether to only show the last execution in each day

limit
optional, default=20, minimum=1, maximum=100
integer

Limit the returned result set

minimumGapDays
optional
integer

Specifies the number of days required between each entry. This should require a sort by triggertime

next
optional
string

The cursor to the next page of data. Only one of next or previous may be specified.

offset
optional
integer

Offset for pagination - how many elements to skip

prev
optional
string

The cursor to the previous page of data. Only one of next or previous may be specified.

searchResultsLimit
optional
integer

Specifies a limit number for the search query, affects total count and is not related to pagination

since
optional
string

Specifies a date that executions should have been created after. Date in RFC3339Nano format, such as 2020-01-01T00:00:00.000Z

sort
optional
Array<string>

No description

Enum:

triggertime

-triggertime

+triggertime

timezone
optional
string

Specifies a timezone the other time-based filters in this query should consider. Expecting a momentjs format, such as America/Los_Angeles

triggered
optional
boolean

Filter by whether the alerting task is triggered.

until
optional
string

Specifies a date that executions should have been created before. Date in RFC3339Nano format, such as 2020-01-01T00:00:00.000Z

Responses GET /v1/data-alerts/{taskId}/executions

200
optional, application/json

The alerting-executions list has been successfully returned.

400
optional, application/json

Bad request, malformed syntax or errors in parameters.

404
optional, application/json

Task or execution not found.

500
optional, application/json

Internal server error.

default
optional, application/json

Error response.

GET/v1/data-alerts/{taskId}/executions

curl "https://your-tenant.us.qlikcloud.com/api/v1/data-alerts/{taskId}/executions" \
 -H "Authorization: Bearer <API-key>"

Response GET /v1/data-alerts/{taskId}/executions

{
  "undefined": {
    "totalCount": 0,
    "currentPageCount": 0,
    "links": {
      "next": {
        "href": "http://localhost:8787/v1/items?limit=12",
        "type": "next",
        "token": "JwAAAAJfaWQAGQAAADVjZjUwM2NjMjVkYzlhMTM1MzYwZTVjZAAA"
      },
      "prev": {
        "href": "http://localhost:8787/v1/items?limit=12",
        "type": "next",
        "token": "JwAAAAJfaWQAGQAAADVjZjUwM2NjMjVkYzlhMTM1MzYwZTVjZAAA"
      },
      "self": {
        "href": "http://localhost:8787/v1/items/5da5825325dc9a0dd0260af9"
      }
    },
    "executions": [
      {
        "id": "string",
        "errors": [
          {
            "code": "string",
            "title": "string",
            "detail": "string"
          }
        ],
        "result": {
          "alertTriggerStatus": "alertSent",
          "throttlerTokensLeft": 5
        },
        "alertId": "string",
        "ownerId": "string",
        "measures": [],
        "tenantId": "string",
        "accessMode": "SOURCE_ACCESS",
        "bookmarkId": "string",
        "dimensions": [],
        "workflowId": "string",
        "conditionId": "string",
        "triggerTime": "string",
        "evaluationId": "string",
        "executionType": "INDIVIDUAL",
        "conditionStatus": "FINISHED",
        "executionEvaluationStatus": "CONDITION_MET",
        "links": {
          "self": {
            "href": "http://localhost:8787/v1/items/5da5825325dc9a0dd0260af9"
          }
        },
        "evaluation": {
          "id": "string",
          "result": "success",
          "status": "RUNNING",
          "endTime": "string",
          "ownerId": "string",
          "tenantId": "string",
          "contextId": "string",
          "startTime": "string",
          "resultData": {},
          "causalEvent": {},
          "conditionId": "string",
          "dataConditionEvaluatorId": "string"
        }
      }
    ]
  }
}

Gets the content of an evaluation from an execution

manage

Facts GET /v1/data-alerts/{taskId}/executions/{executionId}/evaluations

Rate limit
Tier 1 (1000 requests per minute)

Path Parameters GET /v1/data-alerts/{taskId}/executions/{executionId}/evaluations

executionId
string

The execution identifier.

taskId
string

The alerting task identifier.

Responses GET /v1/data-alerts/{taskId}/executions/{executionId}/evaluations

200
optional, application/json

Evaluation successfully returned.

404
optional, application/json

A task or execution with the specified ID was not found.

500
optional, application/json

Internal server error.

default
optional, application/json

Error response.

GET/v1/data-alerts/{taskId}/executions/{executionId}/evaluations

curl "https://your-tenant.us.qlikcloud.com/api/v1/data-alerts/{taskId}/executions/{executionId}/evaluations" \
 -H "Authorization: Bearer <API-key>"

Response GET /v1/data-alerts/{taskId}/executions/{executionId}/evaluations

{
  "condition": {},
  "evaluation": {
    "id": "string",
    "result": "success",
    "status": "RUNNING",
    "endTime": "string",
    "ownerId": "string",
    "tenantId": "string",
    "contextId": "string",
    "startTime": "string",
    "resultData": {},
    "causalEvent": {},
    "conditionId": "string",
    "dataConditionEvaluatorId": "string"
  },
  "hideSelections": true
}

Gets the stats for alerting task executions

managedeprecated

Facts GET /v1/data-alerts/{taskId}/executions/stats

Rate limit
Tier 1 (1000 requests per minute)

Path Parameters GET /v1/data-alerts/{taskId}/executions/stats

taskId
string

The alerting task identifier.

Query Parameters GET /v1/data-alerts/{taskId}/executions/stats

period
string

The period by which the stats aggregation needs to be performed.

Enum:

month

Responses GET /v1/data-alerts/{taskId}/executions/stats

200
optional, application/json

Evaluation successfully returned.

404
optional, application/json

A task or execution with the specified ID was not found.

500
optional, application/json

Internal server error.

default
optional, application/json

Error response.

GET/v1/data-alerts/{taskId}/executions/stats

curl "https://your-tenant.us.qlikcloud.com/api/v1/data-alerts/{taskId}/executions/stats" \
 -H "Authorization: Bearer <API-key>"

Response GET /v1/data-alerts/{taskId}/executions/stats

{
  "undefined": {
    "totalCount": 0,
    "currentPageCount": 0,
    "links": {
      "next": {
        "href": "http://localhost:8787/v1/items?limit=12",
        "type": "next",
        "token": "JwAAAAJfaWQAGQAAADVjZjUwM2NjMjVkYzlhMTM1MzYwZTVjZAAA"
      },
      "prev": {
        "href": "http://localhost:8787/v1/items?limit=12",
        "type": "next",
        "token": "JwAAAAJfaWQAGQAAADVjZjUwM2NjMjVkYzlhMTM1MzYwZTVjZAAA"
      },
      "self": {
        "href": "http://localhost:8787/v1/items/5da5825325dc9a0dd0260af9"
      }
    },
    "executionsStats": [
      {
        "endTime": "string",
        "periodKey": "string",
        "startTime": "string",
        "totalExecutions": "string",
        "triggeredExecutions": "string"
      }
    ]
  }
}

Creates a new alerting trigger action.

manage

Facts POST /v1/data-alerts/actions/trigger

Rate limit
Tier 2 (100 requests per minute)

Request Body POST /v1/data-alerts/actions/trigger

The alerting trigger action create request definition.

Responses POST /v1/data-alerts/actions/trigger

202
optional, application/json

Action has been successfully done. Request to eventing was successfully triggered.

400
optional, application/json

Bad request, malformed syntax or errors in parameters.

500
optional, application/json

Internal server error.

default
optional, application/json

Error response.

POST/v1/data-alerts/actions/trigger

curl "https://your-tenant.us.qlikcloud.com/api/v1/data-alerts/actions/trigger" \
 -X POST \
 -H "Authorization: Bearer <API-key>" \
 -H "Content-type: application/json" \
 -d '{"alertingTaskID":"a1b2c3d4f5"}'

Request POST /v1/data-alerts/actions/trigger

{
  "alertingTaskID": "a1b2c3d4f5"
}

Response POST /v1/data-alerts/actions/trigger

{
  "workflowID": "a1b2c3d4f5"
}

Validates a new alerting task. Current support includes validation for recipients only.

manage

Facts POST /v1/data-alerts/actions/validate

Rate limit
Tier 2 (100 requests per minute)

Request Body POST /v1/data-alerts/actions/validate

The alerting validate action validates a new alerting task.

Responses POST /v1/data-alerts/actions/validate

200
optional, application/json

Alerting task has been validated successfully.

400
optional, application/json

Bad request, malformed syntax or errors in parameters.

500
optional, application/json

Internal server error.

default
optional, application/json

Error response.

POST/v1/data-alerts/actions/validate

curl "https://your-tenant.us.qlikcloud.com/api/v1/data-alerts/actions/validate" \
 -X POST \
 -H "Authorization: Bearer <API-key>" \
 -H "Content-type: application/json" \
 -d '{"name":"string","appId":"string","enabled":true,"sheetId":"string","bookmarkId":"string","recipients":{"userIds":[{"value":"1b263bs8m0mm_s21s3f","groups":["addedIndividually","group1","group2"],"enabled":true,"subscribed":true,"taskRecipientErrors":[{"value":"USER_IS_DELETED","timestamp":"2019-10-15T16:07:01.492Z"}],"alertingTaskRecipientErrors":[{"added":"2019-10-15T16:07:01.492Z","value":"USER_IS_DELETED"}]}],"groupIds":[{"value":"group1","enabled":true,"taskGroupRecipientErrors":[{"value":"GROUP_IS_DISABLED","timestamp":"2019-10-15T16:07:01.492Z"}],"alertingTaskGroupRecipientErrors":[{"added":"2019-10-15T16:07:01.492Z","value":"GROUP_IS_DISABLED"}]}]},"throttling":{"capacity":0,"timezone":"Etc/UTC","replenishRate":0,"recurrenceRule":"string","initialTokenCount":0,"referenceTimestamp":"string"},"conditionId":"string","description":"string","triggerType":"RELOAD","scheduleOptions":{"timezone":"Canada/Pacific","recurrence":["RRULE:FREQ=HOURLY;INTERVAL=2"],"endDateTime":"2026-01-02T16:04:05","chronosJobID":"string","startDateTime":"2006-01-02T16:04:05","lastExecutionTime":"2020-11-20T12:00:55.000Z","nextExecutionTime":"2020-11-20T12:00:55.000Z"}}'

Request POST /v1/data-alerts/actions/validate

{
  "name": "string",
  "appId": "string",
  "enabled": true,
  "sheetId": "string",
  "bookmarkId": "string",
  "recipients": {
    "userIds": [
      {
        "value": "1b263bs8m0mm_s21s3f",
        "groups": [
          "addedIndividually",
          "group1",
          "group2"
        ],
        "enabled": true,
        "subscribed": true,
        "taskRecipientErrors": [
          {
            "value": "USER_IS_DELETED",
            "timestamp": "2019-10-15T16:07:01.492Z"
          }
        ],
        "alertingTaskRecipientErrors": [
          {
            "added": "2019-10-15T16:07:01.492Z",
            "value": "USER_IS_DELETED"
          }
        ]
      }
    ],
    "groupIds": [
      {
        "value": "group1",
        "enabled": true,
        "taskGroupRecipientErrors": [
          {
            "value": "GROUP_IS_DISABLED",
            "timestamp": "2019-10-15T16:07:01.492Z"
          }
        ],
        "alertingTaskGroupRecipientErrors": [
          {
            "added": "2019-10-15T16:07:01.492Z",
            "value": "GROUP_IS_DISABLED"
          }
        ]
      }
    ]
  },
  "throttling": {
    "capacity": 0,
    "timezone": "Etc/UTC",
    "replenishRate": 0,
    "recurrenceRule": "string",
    "initialTokenCount": 0,
    "referenceTimestamp": "string"
  },
  "conditionId": "string",
  "description": "string",
  "triggerType": "RELOAD",
  "scheduleOptions": {
    "timezone": "Canada/Pacific",
    "recurrence": [
      "RRULE:FREQ=HOURLY;INTERVAL=2"
    ],
    "endDateTime": "2026-01-02T16:04:05",
    "chronosJobID": "string",
    "startDateTime": "2006-01-02T16:04:05",
    "lastExecutionTime": "2020-11-20T12:00:55.000Z",
    "nextExecutionTime": "2020-11-20T12:00:55.000Z"
  }
}

Response POST /v1/data-alerts/actions/validate

{
  "status": "FAILURE",
  "validations": [
    {
      "id": "string",
      "type": "RECIPIENT",
      "error": "NO_ACCESS",
      "description": "string",
      "validationErrors": []
    }
  ]
}

Lists alerting settings.

manage

Facts GET /v1/data-alerts/settings

Rate limit
Tier 1 (1000 requests per minute)

Responses GET /v1/data-alerts/settings

200
optional, application/json

The alerting settings have been successfully returned

500
optional, application/json

Internal server error.

default
optional, application/json

Error response.

GET/v1/data-alerts/settings

curl "https://your-tenant.us.qlikcloud.com/api/v1/data-alerts/settings" \
 -H "Authorization: Bearer <API-key>"

Response GET /v1/data-alerts/settings

{
  "tenantId": "cgdsAumGmQ6l0Bi7CUKt9V8P_Y9GL0sC",
  "dataAlertsLimits": 50,
  "dataAlertsConsumed": 40,
  "enable-data-alerting": true,
  "data-alerting-license-status": "enabled",
  "max-recipients-in-target-access": 100,
  "data-alerting-feature-operation-status": "disabling",
  "data-alerting-feature-operation-status-change": "2020-09-02T13:44:33Z"
}

Updates Alerting configuration. Accessible only by tenant admins.

manage

Facts PUT /v1/data-alerts/settings

Rate limit
Tier 2 (100 requests per minute)

Request Body PUT /v1/data-alerts/settings

application/json

Request for updating the alerting settings

Responses PUT /v1/data-alerts/settings

204
optional
object

Alerting settings have been successfully updated.

400
optional, application/json

Bad request body

409
optional, application/json

Request was denied at this time. This could happen when requesting to disable/enable the feature while there is an ongoing operation to enable/disable the feature

500
optional, application/json

Internal server error.

default
optional, application/json

Error response.

PUT/v1/data-alerts/settings

curl "https://your-tenant.us.qlikcloud.com/api/v1/data-alerts/settings" \
 -X PUT \
 -H "Authorization: Bearer <API-key>" \
 -H "Content-type: application/json" \
 -d '{"enable-data-alerting":true}'

Request PUT /v1/data-alerts/settings

{
  "enable-data-alerting": true
}

AlertingActionsTriggerCreateRequest

object

Properties

alertingTaskID
string

No description

AlertingActionsTriggerCreateResponse

object

Properties

workflowID
optional
string

the workflow id created for the manual triggering of alert

AlertingConditionResponse

object

Properties

hideSelections
optional
boolean

No description

conditionResponse
optional
object

Should reference ConditionResponse type in condition-manager api docs

AlertingExecutionError

object

Properties

code
optional
string

Error code specific to sharing service.

title
optional
string

Error title.

detail
optional
string

Error cause.

AlertingExecutionErrors

Array<AlertingExecutionError>

Properties

code
optional
string

Error code specific to sharing service.

title
optional
string

Error title.

detail
optional
string

Error cause.

AlertingExecutionListResponse

Properties

totalCount
optional
integer

total count of entries in the collection as a whole

currentPageCount
optional
integer

count of entries on the currently shown page

links
optional

No description

executions

Gets a list of alerting-executions.

AlertingExecutionPersist

object

Properties

id
optional
string

Gets the execution identifier.

errors
optional

No description

result

No description

alertId
optional
string

ID for the alerting task that this execution references

ownerId
optional
string

The owner that this execution belongs to

measures
optional
Array<string>

Measures applied in the condition

tenantId
optional
string

The tenant that this execution belongs to

accessMode
optional
string

No description

Enum:

SOURCE_ACCESS

TARGET_ACCESS

bookmarkId
optional
string

Id of the bookmark associated with an alert

dimensions
optional
Array<string>

Dimensions applied in the condition

workflowId
optional
string

ID for the workflow, coming from eventing service

conditionId
optional
string

Id of the condition the alert is associated with

triggerTime
optional
string

Timestamp of execution start

evaluationId
optional
string

Id of the evaluation for the condition

executionType
optional
string

No description

Enum:

INDIVIDUAL

SHARED

conditionStatus
optional
string

No description

Enum:

FINISHED

FAILED

executionEvaluationStatus
optional
string

No description

Enum:

CONDITION_MET

CONDITION_NOT_MET

FAILED

AlertingExecutionResponse

Properties

id
optional
string

Gets the execution identifier.

errors
optional

No description

result

No description

alertId
optional
string

ID for the alerting task that this execution references

ownerId
optional
string

The owner that this execution belongs to

measures
optional
Array<string>

Measures applied in the condition

tenantId
optional
string

The tenant that this execution belongs to

accessMode
optional
string

No description

Enum:

SOURCE_ACCESS

TARGET_ACCESS

bookmarkId
optional
string

Id of the bookmark associated with an alert

dimensions
optional
Array<string>

Dimensions applied in the condition

workflowId
optional
string

ID for the workflow, coming from eventing service

conditionId
optional
string

Id of the condition the alert is associated with

triggerTime
optional
string

Timestamp of execution start

evaluationId
optional
string

Id of the evaluation for the condition

executionType
optional
string

No description

Enum:

INDIVIDUAL

SHARED

conditionStatus
optional
string

No description

Enum:

FINISHED

FAILED

executionEvaluationStatus
optional
string

No description

Enum:

CONDITION_MET

CONDITION_NOT_MET

FAILED

links
optional

No description

evaluation
optional

No description

AlertingExecutionResult

object

Properties

alertTriggerStatus
optional
string

No description

throttlerTokensLeft
optional
integer

No description

AlertingRecipientStats

object

Properties

type
optional
string

No description

Enum:

userid

value
optional
string

No description

errors

No description

groups
optional
Array<string>

A list of associated groups. If a user is added individually the "addedIndividually" pseudo group is included

enabled
boolean

Whether the recipient is enabled.

lastScan
optional
string

last time a trigger was detected, but not sure if executed

subscribed
optional
boolean

Whether the recipient is subscribed.

lastTrigger
optional
string

last time an execution had been created

conditionStatus
optional
string

No description

Enum:

OK

FAILED

AlertingRecipientStatsError

object

Properties

code
optional
string

Error code specific to sharing service.

title
optional
string

Error title.

detail
optional
string

Error cause.

AlertingRecipientStatsErrors

Array<AlertingRecipientStatsError>

Properties

code
optional
string

Error code specific to sharing service.

title
optional
string

Error title.

detail
optional
string

Error cause.

AlertingRecipientStatsResponse

object

Properties

recipientStats
optional

No description

AlertingSettings

object

Properties

tenantId
optional
string

These persisted alerting settings are only available for this tenant. Extracted from request JWT.

dataAlertsLimits
optional
number

Represents the number of data alerts limit to be consumed by the user either as an owner or recipient

dataAlertsConsumed
optional
number

Represents the number of data alerts consumed by the user either as an owner or recipient

enable-data-alerting
boolean

true if data-alerting feature is enabled for this tenant. Enabling this feature also requires that the license has this feature enabled.

data-alerting-license-status
optional
string

Whether the license for the tenant has the data alerting feature enabled.

Enum:

enabled

disabled

max-recipients-in-target-access
optional
integer

The maximum number of recipients that can be present in an alerting task in TARGET_ACCESS mode. New recipients cannot be added when this limit is exceeded

data-alerting-feature-operation-status
optional
string

This indicates that there is an ongoing operation to either disable or enable the data alerting feature. none means that no such operation is ongoing. enabling/disabling means that system is currently enabling/disabling the feature

Enum:

none

enabling

disabling

data-alerting-feature-operation-status-change
optional
string

UTC timestamp of the most recent change of data-alerting-feature-operation-status. If there has not been any such change, this is the timestamp of the initial creation of the record.

AlertingSettingsUpload

object

Properties

enable-data-alerting
boolean

true if data-alerting feature is enabled. A status change could potentially result in a considerable amount of API operations to enable/disable triggers. Enabling this feature also requires that the license has this feature enabled.

AlertingTaskCreateRequest

object

a alerting task (a definition on an alert)

Properties

name
string

name associated to alerting task

appId
string

appId associated to this alert definition

enabled
optional, default=true
boolean

if the alerting task is enabled

sheetId
optional
string

sheetId associated to this alert definition

bookmarkId
optional
string

bookmarkId associated to this alert definition

recipients
optional

List of recipients. An internal recipient is represented by either their user id or group id.

throttling

The rules and setup for throttling

conditionId
string

the id of the condition that determines if this data alert should be triggered

description
optional
string

description associated to alerting task

triggerType
string

Type of job that triggered the task

Enum:

RELOAD

SCHEDULED

scheduleOptions

No description

AlertingTaskError

object

Properties

added
optional
string

Timestamp for the creation of the error

value
optional
string

Identifier for type of error occurring on alerting task

Enum:

OWNER_DISABLED

OWNER_ACCESS

OWNER_LICENSE

APP_DELETED

NO_RECIPIENTS

PARTIAL_ACCESS

EVAL_ERROR

ORPHAN

CONVERSION_DENIED

EXPIRED

PARTIAL_SENT

AlertingTaskExecutionStats

deprecated

Properties

totalCount
optional
integer

total count of entries in the collection as a whole

currentPageCount
optional
integer

count of entries on the currently shown page

links
optional

No description

executionsStats
optional

No description

AlertingTaskGroupRecipientError

object

Properties

added
optional
string

Timestamp for the creation of the error

value
optional
string

Identifier for type of error occurring on alerting task

Enum:

GROUP_IS_DISABLED

MAX_ALERTS_LIMIT_REACHED

GROUP_WITH_NO_APP_ACCESS

GROUP_IS_DELETED

AlertingTaskListResponse

Properties

totalCount
optional
integer

total count of entries in the collection as a whole

currentPageCount
optional
integer

count of entries on the currently shown page

links
optional

No description

tasks
optional

Gets a list of alerting tasks.

AlertingTaskPatchRequestCompliant

object

Properties

op
string

The operation to be performed

Enum:

replace

path
string

A JSON Patch document as defined in https://datatracker.ietf.org/doc/html/rfc6902

Enum:

/ownerName

/ownerId

/conditionId

/enabledAction

/bookmarkId

/name

/description

/throttling

/triggerType

/scheduleOptions

value
optional
object

The value to be used for this operation.

AlertingTaskPatchRequestCompliantList

Array<AlertingTaskPatchRequestCompliant>

Properties

op
string

The operation to be performed

Enum:

replace

path
string

A JSON Patch document as defined in https://datatracker.ietf.org/doc/html/rfc6902

Enum:

/ownerName

/ownerId

/conditionId

/enabledAction

/bookmarkId

/name

/description

/throttling

/triggerType

/scheduleOptions

value
optional
object

The value to be used for this operation.

AlertingTaskRecipientError

object

Properties

added
optional
string

Timestamp for the creation of the error

value
optional
string

Identifier for type of error occurring on alerting task

Enum:

USER_IS_DELETED

USER_DISABLED_IN_QCS

NO_ACCESS_TO_APP

UNSUBSCRIBED_FROM_ALERT

CONDITION_EVAL_ERROR

USER_DISABLED_IN_ALERT_BY_OWNER

MAX_ALERTS_LIMIT_REACHED

AlertingTaskRecipientPatch

Array<AlertingTaskRecipientPatch_inner>

A custom custom JSON Patch document, as an array of objects with operation, recipient type and value. Original defined in https://datatracker.ietf.org/doc/html/rfc6902.

Properties

op
string

The operation to be performed.

Enum:

remove

add

replace

enable

disable

subscribe

unsubscribe

value
object

The value to be used for this operation.

recipientType
string

Defines the path for the given resource field to patch.

Enum:

userid

groupid

AlertingTaskRecipientPatch_inner

object

Properties

op
string

The operation to be performed.

Enum:

remove

add

replace

enable

disable

subscribe

unsubscribe

value
optional
object

The value to be used for this operation.

recipientType
string

Defines the path for the given resource field to patch.

Enum:

userid

groupid

AlertingTaskResponse

object

Properties

id
optional
string

data alerting identifier (this is the alertID)

name
optional
string

name associated to alerting task

appId
optional
string

appId associated to this alert definition

links
optional

No description

status
optional
string

particular status of the alerting task

Enum:

creating

deleting

enabled
optional
boolean

true if the alerting task is enabled

ownerId
optional
string

the owner of this alert

sheetId
optional
string

sheetId associated to this alert definition

lastScan
optional
string

last time a trigger was detected, but not sure if executed for requesting user

tenantId
optional
string

the tenant of this alert

ownerName
optional
string

the owner name of this alert

accessMode
optional
string

No description

Enum:

SOURCE_ACCESS

TARGET_ACCESS

bookmarkId
optional
string

bookmarkId associated to this alert definition

recipients
optional

List of recipients. An internal recipient is represented by either their user id or group id.

throttling

The rules and setup for throttling

conditionId
optional
string

the id of the condition that determines if this data alert should be triggered

dateCreated
optional
string

Timestamp for the creation of the task (rfc3339 format)

description
optional
string

description associated to alerting task

errorStatus
optional
string

error labels from the latest workflow that happened within the task

Enum:

OK

FATAL-ERROR

PARTIAL-TRIGGER

lastTrigger
optional
string

last time an execution had been created for requesting user

lastUpdated
optional
string

Timestamp of the most recent update.

triggerType
optional
string

Type of job that triggered the task

Enum:

RELOAD

SCHEDULED

MANUAL

triggerStats

No description

hideSelections
optional
boolean

Whether the selection needs to be hidden.

evaluationCount
optional
integer

the number of actual evaluations with engine this task has consumed in the current month

scheduleOptions

No description

subscriptionIds
optional
Array<string>

list of subscriptions related to this alerting task

absoluteLastScan
optional
string

last time a trigger was detected, but not sure if executed

conditionResponse
optional
object

Should reference ConditionResponse type in condition-manager api docs

alertingTaskErrors
optional

No description

absoluteLastTrigger
optional
string

last time an execution had been created

hasHistoryCondition
optional
boolean

true if the alert has history condition enabled

lastExecutionStatus
optional
string

No description

Enum:

OK

FAILED

recipientsChangeHistory
optional

No description

lastEvaluationCountUpdate
optional
string

the date when the evaluation count was updated

AlertingTaskTriggerStats

object

Properties

totalScans
maximum=100
integer

The number of scans for the current condition.

last10Scans
maximum=10
integer

The number of triggers out of the last 10 scans for the current condition.

last100Scans
maximum=100
integer

The number of triggers out of the last 100 scans for the current condition.

AlertingTaskValidation

object

Properties

id
optional
string

Identifies for user id or condition id

type
optional
string

Identifier for type of a validation error occurring on alerting task

Enum:

RECIPIENT

CONDITION

RECIPIENT_GROUP

error
deprecated
optional
string

Identifier for a validation error occurring on alerting task

Enum:

NO_ACCESS

USER_IS_DISABLED

INVALID_CONDITION

GROUP_IS_DISABLED

GROUP_SIZE_EXCEEDED

description
optional
string

Description of the error

validationErrors
optional
Array<string>

No description

AlertingTaskValidationResponse

object

Properties

status
optional
string

No description

Enum:

FAILURE

SUCCESS

validations
optional

No description

Error

object

Properties

code
optional
string

Error code specific to sharing service.

meta
optional

No description

title
optional
string

Error title.

detail
optional
string

Error cause.

Error_meta

object

Properties

httpCode
optional
integer

HTTP error code.

Errors

object

Properties

errors
optional

No description

traceId
optional
string

No description

Evaluation

Properties

id
optional
string<uid>

The unique id for the resource

result
optional
string

The final result of the evalution

Enum:

success

failure

error

status
optional
string

The status of the evaluation execution

Enum:

RUNNING

FAILED

FINISHED

endTime
optional
string<string>

The time the evaluation ended

ownerId
optional
string<uid>

userId of user being impersonated to evaluate the condition

tenantId
optional
string<uid>

The tenant id

contextId
optional
string

Extra context information to carry through to the result if one was included on when the evaluation was triggered

startTime
optional
string<string>

The time the evaluation started

resultData
optional
object

Condition type specific result, one of dataResult or compoundResult

causalEvent
optional
object

Representation of the event that caused the condition to be evaluated if one was included on when the evaluation was triggered

conditionId
optional
string<uid>

The unique id of the associated condition

dataConditionEvaluatorId
optional
string<uid>

The unique id for the resource given from Data Condition Evaluator

EvaluationGetResponse

object

Properties

condition
optional
object

No description

evaluation
optional

No description

hideSelections
optional
boolean

No description

ExecutionStats

object

Properties

endTime
optional
string

No description

periodKey
optional
string

No description

startTime
optional
string

No description

totalExecutions
optional
string

No description

triggeredExecutions
optional
string

No description

GroupIDRecipient

object

an internal recipient based on its group id.

Properties

value
optional
string

Group ID of recipient.

enabled
optional
boolean

Whether this recipient can receive alerts.

taskGroupRecipientErrors

No description

alertingTaskGroupRecipientErrors

No description

Page

object

Properties

href
optional
string

URL to particular set of elements

type
optional
string

Page type, can be next or prev

Enum:

prev

next

token
optional
string

Page unique token

Recipients

object

List of recipients. An internal recipient is represented by either their user id or group id.

Properties

userIds

No description

groupIds
optional

No description

RecipientsChange

object

Change in a recipient for an alerting task

Properties

dateTime
optional
string

time of recipient state change

patchAction

A custom custom JSON Patch document, as an array of objects with operation, recipient type and value. Original defined in https://datatracker.ietf.org/doc/html/rfc6902.

ScheduleOptions

object

Properties

timezone
optional
string

The timezone for time calculations in SCHEDULED triggers, optional.

recurrence
optional
Array<string>

List of RRULEs for SCHEDULED triggers, as specified in RFC5545. Note that DTSTART and DTEND, UNTIL lines are not allowed in this field; start and end times are specified in the start and end fields. RDATE and EXDATE lines are not currently supported. EXRULE is not supported since it is deprecated by RFC5545. It is mandatory if the trigger type is SCHEDULED. At least 1 rule must be set and maximum 5 rules are allowed.

endDateTime
optional, default=''
string

EndDateTime is a local date time with respect to the above timezone parameter. If the timezone parameter is missing, then the timezone used is the one retrieved from user infos. Therefore ISO8601 time offsets are not allowed (e.g. "2026-01-02T16:04:05Z" or "2026-01-02T16:04:05+01"), if passed an error will be returned. EndDateTime is an optional parameter, when not set or when it's an empty string, the recurrence is intended to be never ending.

chronosJobID
optional
string

The chronos job identifier. It is set once the related chronos job is created.

startDateTime
optional
string

StartDateTime is a local date time with respect to the above timezone parameter. If the timezone parameter is missing, then the timezone used is the one retrieved from user infos. Therefore ISO8601 time offsets are not allowed (e.g. "2026-01-02T16:04:05Z" or "2026-01-02T16:04:05+01"), if passed an error will be returned. StartDateTime should not be older than 1 year from current date. StartDateTime is an optional parameter, when not set or when it's an empty string, its value is set to the current local date time.

lastExecutionTime
optional
string

lastExecutionTime is the time of the chronos job last execution in RFC3339 format (a time with a fixed UTC offset). Could be empty if job has not run yet.

nextExecutionTime
optional
string

nextExecutionTime is the time of the chronos job next execution in RFC3339 format (a time with a fixed UTC offset). Could be empty if the job is completed.

Self

object

Object with Href to a particular element or set of elements

Properties

href
optional
string

No description

StandardListResponseProps

object

properties that should be added to every list response

Properties

totalCount
integer

total count of entries in the collection as a whole

currentPageCount
integer

count of entries on the currently shown page

TaskGroupRecipientError

object

Properties

value
optional
string

Identifier for type of error occurring on sharing task specific for group recipient

Enum:

GROUP_IS_DISABLED

MAX_ALERTS_LIMIT_REACHED

GROUP_WITH_NO_APP_ACCESS

GROUP_IS_DELETED

timestamp
optional
string

Timestamp for the creation of the error

TaskRecipientError

object

Properties

value
optional
string

Identifier for type of error occurring on sharing task specific for recipient

Enum:

USER_IS_DELETED

USER_DISABLED_IN_QCS

NO_ACCESS_TO_APP

UNSUBSCRIBED_FROM_SHARING

USER_DISABLED_IN_SHARING_BY_OWNER

CHART_NOT_FOUND

APP_NOT_FOUND

SHEET_NOT_FOUND

ENGINE_POD_NOT_AVAILABLE

CHART_TYPE_NOT_ALLOWED

GENERIC_EXECUTION_FAILURE

timestamp
optional
string

Timestamp for the creation of the error

ThrottlingResource

object

The rules and setup for throttling

Properties

capacity
optional
integer

the maximum number of tokens that the bucket can contain

timezone
optional, default='Etc/UTC'
string

the timezone for time calculations in this throttlingresource, for current time and time reference.

replenishRate
optional
integer

the amount of tokens to insert into the bucket on the specified interval. (tokens exceeding capacity are discarded)

recurrenceRule
optional
string

A string that supports a subset of RFC5545 recurrence rule directives.

initialTokenCount
optional
integer

the initial amount of tokens in the bucket upon creation. cannot exceed capacity.

referenceTimestamp
optional
string

a date and time reference specified in RFC3339 format

UserIDRecipient

object

an internal recipient based on its user id.

Properties

value
optional
string

User ID of recipient (internal user).

groups
optional
Array<string>

A list of associated groups. If a user is added individually the "addedIndividually" pseudo group is included

enabled
optional
boolean

Whether this recipient can receive alerts.

subscribed
optional
boolean

Whether this recipient is subscribed to alerts of a task

taskRecipientErrors
optional

No description

alertingTaskRecipientErrors

No description

v0.574.0
Was this page helpful?