Data alerts

Download specification

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

required

Tier 1 (1000 requests per minute)

Query Parameters GET /v1/data-alerts

appID string	The app ID you would like to filter by
conditionId string	The conditionId you would like to filter by
limit default=20, minimum=1, maximum=100 integer	Limit the returned result set
next string	The cursor to the next page of data. Only one of next or previous may be specified.
offset integer	Offset for finding a list of entities - used for pagination
ownerId string	The id of the owner you would like to filter by
ownerName string	The name of the owner you would like to filter by
prev string	The cursor to the previous page of data. Only one of next or previous may be specified.
role Array<string>	No description Enum: owner recipient notowner
sort 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 Array<string>	No description Enum: INVALID_RECIPIENT INVALID_OWNER DISABLED VALID

Responses GET /v1/data-alerts

200 application/json AlertingTaskListResponse	The alerting tasks list has been successfully returned.
400 application/json Errors	Bad request, malformed syntax or errors in parameters.
500 application/json Errors	Internal server error.
default application/json Errors	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

required

Tier 2 (100 requests per minute)

Request Body POST /v1/data-alerts

application/json

AlertingTaskCreateRequest

The alerting task create request definition.

Responses POST /v1/data-alerts

202 application/json AlertingTaskResponse	Alert creation has been accepted. The alerting task will have status creating, until status is set to either valid or invalid.
400 application/json Errors	Bad request, malformed syntax or errors in parameters.
500 application/json Errors	Internal server error.
default application/json Errors	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

required

Tier 1 (1000 requests per minute)

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

alertId

required

string

The alerting task identifier.

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

200 application/json AlertingTaskResponse	Alert has been successfully returned.
400 application/json Errors	Bad request, malformed syntax or errors in parameters.
404 application/json Errors	Task or execution not found.
500 application/json Errors	Internal server error.
default application/json Errors	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

required

Tier 2 (100 requests per minute)

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

alertId

required

string

The alerting task identifier.

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

application/json

Array<AlertingTaskPatchRequestCompliant>

Patch request definition for an alerting task.

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

204 object	The alerting task has been successfully updated.
400 application/json Errors	The specified alerting task ID or body is invalid (e.g. not a number).
404 application/json Errors	An alerting task with the specified ID was not found.
500 application/json Errors	Internal server error.
default application/json Errors	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

required

Tier 2 (100 requests per minute)

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

alertId

required

string

The alerting task identifier.

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

204 object	The alerting task has been successfully deleted.
400 application/json Errors	The specified alerting task ID is invalid (e.g. not a number).
404 application/json Errors	An alerting task with the specified ID was not found.
500 application/json Errors	Internal server error.
default application/json Errors	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

required

Tier 1 (1000 requests per minute)

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

alertId

required

string

The alerting task identifier.

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

200 application/json AlertingConditionResponse	Condition associated with the alerting task has been successfully returned. See ConditionResponse in condition-manager api docs
400 application/json Errors	Bad request, malformed syntax or errors in parameters.
404 application/json Errors	Task or condition not found.
500 application/json Errors	Internal server error.
default application/json Errors	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

required

Tier 1 (1000 requests per minute)

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

alertId required string	The alerting task identifier.
executionId required string	The execution identifier. If value is "latest", the latest execution will be returned

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

200 application/json AlertingExecutionResponse	The execution has been successfully returned.
400 application/json Errors	The specified task or execution ID is invalid (e.g. not a number).
404 application/json Errors	Task or execution not found.
500 application/json Errors	Internal server error.
default application/json Errors	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

required

Tier 2 (100 requests per minute)

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

alertId required string	The alerting task identifier.
executionId required string	The execution identifier.

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

204 object	The execution has been successfully deleted.
400 application/json Errors	The specified task or execution ID is invalid (e.g. not a number).
404 application/json Errors	Task or execution not found.
500 application/json Errors	Internal server error.
default application/json Errors	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

required

Tier 1 (1000 requests per minute)

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

alertId

required

string

The alerting task identifier.

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

groups Array<string>	The name of the groups you would like to filter by
sort Array<string>	No description Enum: +userID -userID subscribed +subscribed
subscribed boolean	Subscribed property you would like to filter by
userID string	The recipients ID you would like to filter by

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

200 application/json AlertingRecipientStatsResponse	Alert recipient stats have been successfully returned.
400 application/json Errors	Bad request, malformed syntax or errors in parameters.
404 application/json Errors	Task or execution not found.
500 application/json Errors	Internal server error.
default application/json Errors	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

required

Tier 1 (1000 requests per minute)

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

taskId

required

string

The alerting task identifier.

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

conditionId string	Filter by condition id related to the executions.
conditionStatus string	Filter by whether the alerting task execution status is FINISHED or FAILED. Enum: FINISHED FAILED ALL
daysOfMonth Array<integer>	Specifies required days of the month that the execution was created in
daysOfWeek 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 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 boolean	Specifies whether to include evaluation details
lastEachDay boolean	Specifies whether to only show the last execution in each day
limit default=20, minimum=1, maximum=100 integer	Limit the returned result set
minimumGapDays integer	Specifies the number of days required between each entry. This should require a sort by triggertime
next string	The cursor to the next page of data. Only one of next or previous may be specified.
offset integer	Offset for pagination - how many elements to skip
prev string	The cursor to the previous page of data. Only one of next or previous may be specified.
searchResultsLimit integer	Specifies a limit number for the search query, affects total count and is not related to pagination
since string	Specifies a date that executions should have been created after. Date in RFC3339Nano format, such as 2020-01-01T00:00:00.000Z
sort Array<string>	No description Enum: triggertime -triggertime +triggertime
timezone string	Specifies a timezone the other time-based filters in this query should consider. Expecting a momentjs format, such as America/Los_Angeles
triggered boolean	Filter by whether the alerting task is triggered.
until 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 application/json AlertingExecutionListResponse	The alerting-executions list has been successfully returned.
400 application/json Errors	Bad request, malformed syntax or errors in parameters.
404 application/json Errors	Task or execution not found.
500 application/json Errors	Internal server error.
default application/json Errors	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

required

Tier 1 (1000 requests per minute)

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

executionId required string	The execution identifier.
taskId required string	The alerting task identifier.

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

200 application/json EvaluationGetResponse	Evaluation successfully returned.
404 application/json Errors	A task or execution with the specified ID was not found.
500 application/json Errors	Internal server error.
default application/json Errors	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

required

Tier 1 (1000 requests per minute)

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

taskId

required

string

The alerting task identifier.

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

period

required

string

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

Enum:

month

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

200 application/json AlertingTaskExecutionStats	Evaluation successfully returned.
404 application/json Errors	A task or execution with the specified ID was not found.
500 application/json Errors	Internal server error.
default application/json Errors	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

required

Tier 2 (100 requests per minute)

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

application/json

AlertingActionsTriggerCreateRequest

The alerting trigger action create request definition.

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

202 application/json AlertingActionsTriggerCreateResponse	Action has been successfully done. Request to eventing was successfully triggered.
400 application/json Errors	Bad request, malformed syntax or errors in parameters.
500 application/json Errors	Internal server error.
default application/json Errors	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

required

Tier 2 (100 requests per minute)

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

application/json

AlertingTaskCreateRequest

The alerting validate action validates a new alerting task.

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

200 application/json AlertingTaskValidationResponse	Alerting task has been validated successfully.
400 application/json Errors	Bad request, malformed syntax or errors in parameters.
500 application/json Errors	Internal server error.
default application/json Errors	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

required

Tier 1 (1000 requests per minute)

Responses GET /v1/data-alerts/settings

200 application/json AlertingSettings	The alerting settings have been successfully returned
500 application/json Errors	Internal server error.
default application/json Errors	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

required

Tier 2 (100 requests per minute)

Request Body PUT /v1/data-alerts/settings

application/json

AlertingSettingsUpload

Request for updating the alerting settings

Responses PUT /v1/data-alerts/settings

204 object	Alerting settings have been successfully updated.
400 application/json Errors	Bad request body
409 application/json Errors	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 application/json Errors	Internal server error.
default application/json Errors	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

required

string

No description

AlertingActionsTriggerCreateResponse

object

Properties

workflowID

string

the workflow id created for the manual triggering of alert

AlertingConditionResponse

object

Properties

hideSelections boolean	No description
conditionResponse object	Should reference ConditionResponse type in condition-manager api docs

AlertingExecutionError

object

Properties

code string	Error code specific to sharing service.
title string	Error title.
detail string	Error cause.

AlertingExecutionErrors

Array<AlertingExecutionError>

Properties

code string	Error code specific to sharing service.
title string	Error title.
detail string	Error cause.

AlertingExecutionListResponse

Properties

totalCount integer	total count of entries in the collection as a whole
currentPageCount integer	count of entries on the currently shown page
links ListLinks	No description
executions Array<AlertingExecutionResponse>	Gets a list of alerting-executions.

AlertingExecutionPersist

object

Properties

id string	Gets the execution identifier.
errors Array<AlertingExecutionError>	No description
result AlertingExecutionResult	No description
alertId string	ID for the alerting task that this execution references
ownerId string	The owner that this execution belongs to
measures Array<string>	Measures applied in the condition
tenantId string	The tenant that this execution belongs to
accessMode string	No description Enum: SOURCE_ACCESS TARGET_ACCESS
bookmarkId string	Id of the bookmark associated with an alert
dimensions Array<string>	Dimensions applied in the condition
workflowId string	ID for the workflow, coming from eventing service
conditionId string	Id of the condition the alert is associated with
triggerTime string	Timestamp of execution start
evaluationId string	Id of the evaluation for the condition
executionType string	No description Enum: INDIVIDUAL SHARED
conditionStatus string	No description Enum: FINISHED FAILED
executionEvaluationStatus string	No description Enum: CONDITION_MET CONDITION_NOT_MET FAILED

AlertingExecutionResponse

Properties

id string	Gets the execution identifier.
errors Array<AlertingExecutionError>	No description
result AlertingExecutionResult	No description
alertId string	ID for the alerting task that this execution references
ownerId string	The owner that this execution belongs to
measures Array<string>	Measures applied in the condition
tenantId string	The tenant that this execution belongs to
accessMode string	No description Enum: SOURCE_ACCESS TARGET_ACCESS
bookmarkId string	Id of the bookmark associated with an alert
dimensions Array<string>	Dimensions applied in the condition
workflowId string	ID for the workflow, coming from eventing service
conditionId string	Id of the condition the alert is associated with
triggerTime string	Timestamp of execution start
evaluationId string	Id of the evaluation for the condition
executionType string	No description Enum: INDIVIDUAL SHARED
conditionStatus string	No description Enum: FINISHED FAILED
executionEvaluationStatus string	No description Enum: CONDITION_MET CONDITION_NOT_MET FAILED
links Links	No description
evaluation Evaluation	No description

AlertingExecutionResult

object

Properties

alertTriggerStatus string	No description
throttlerTokensLeft integer	No description

AlertingRecipientStats

object

Properties

type string	No description Enum: userid
value string	No description
errors Array<AlertingRecipientStatsError>	No description
groups Array<string>	A list of associated groups. If a user is added individually the "addedIndividually" pseudo group is included
enabled required boolean	Whether the recipient is enabled.
lastScan string	last time a trigger was detected, but not sure if executed
subscribed boolean	Whether the recipient is subscribed.
lastTrigger string	last time an execution had been created
conditionStatus string	No description Enum: OK FAILED

AlertingRecipientStatsError

object

Properties

code string	Error code specific to sharing service.
title string	Error title.
detail string	Error cause.

AlertingRecipientStatsErrors

Array<AlertingRecipientStatsError>

Properties

code string	Error code specific to sharing service.
title string	Error title.
detail string	Error cause.

AlertingRecipientStatsResponse

object

Properties

recipientStats

Array<AlertingRecipientStats>

No description

AlertingSettings

object

Properties

tenantId string	These persisted alerting settings are only available for this tenant. Extracted from request JWT.
dataAlertsLimits number	Represents the number of data alerts limit to be consumed by the user either as an owner or recipient
dataAlertsConsumed number	Represents the number of data alerts consumed by the user either as an owner or recipient
enable-data-alerting required 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 string	Whether the license for the tenant has the data alerting feature enabled. Enum: enabled disabled
max-recipients-in-target-access 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 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 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

required

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 required string	name associated to alerting task
appId required string	appId associated to this alert definition
enabled default=true boolean	if the alerting task is enabled
sheetId string	sheetId associated to this alert definition
bookmarkId string	bookmarkId associated to this alert definition
recipients required Recipients	List of recipients. An internal recipient is represented by either their user id or group id.
throttling ThrottlingResource	The rules and setup for throttling
conditionId required string	the id of the condition that determines if this data alert should be triggered
description string	description associated to alerting task
triggerType required string	Type of job that triggered the task Enum: RELOAD SCHEDULED
scheduleOptions ScheduleOptions	No description

AlertingTaskError

object

Properties

added string	Timestamp for the creation of the error
value 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 QUOTA_REACHED

AlertingTaskExecutionStats

deprecated

Properties

totalCount integer	total count of entries in the collection as a whole
currentPageCount integer	count of entries on the currently shown page
links ListLinks	No description
executionsStats Array<ExecutionStats>	No description

AlertingTaskGroupRecipientError

object

Properties

added string	Timestamp for the creation of the error
value 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 integer	total count of entries in the collection as a whole
currentPageCount integer	count of entries on the currently shown page
links ListLinks	No description
tasks Array<AlertingTaskResponse>	Gets a list of alerting tasks.

AlertingTaskPatchRequestCompliant

object

Properties

op required string	The operation to be performed Enum: replace
path required 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 object	The value to be used for this operation.

AlertingTaskPatchRequestCompliantList

Array<AlertingTaskPatchRequestCompliant>

Properties

op required string	The operation to be performed Enum: replace
path required 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 object	The value to be used for this operation.

AlertingTaskRecipientError

object

Properties

added string	Timestamp for the creation of the error
value 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 required string	The operation to be performed. Enum: remove add replace enable disable subscribe unsubscribe
value required object	The value to be used for this operation.
recipientType required string	Defines the path for the given resource field to patch. Enum: userid groupid

AlertingTaskRecipientPatch_inner

object

Properties

op required string	The operation to be performed. Enum: remove add replace enable disable subscribe unsubscribe
value required object	The value to be used for this operation.
recipientType required string	Defines the path for the given resource field to patch. Enum: userid groupid

AlertingTaskResponse

object

Properties

id string	data alerting identifier (this is the alertID)
name string	name associated to alerting task
appId string	appId associated to this alert definition
links Links	No description
status string	particular status of the alerting task Enum: creating deleting
enabled boolean	true if the alerting task is enabled
ownerId string	the owner of this alert
sheetId string	sheetId associated to this alert definition
lastScan string	last time a trigger was detected, but not sure if executed for requesting user
tenantId string	the tenant of this alert
ownerName string	the owner name of this alert
accessMode string	No description Enum: SOURCE_ACCESS TARGET_ACCESS
bookmarkId string	bookmarkId associated to this alert definition
recipients Recipients	List of recipients. An internal recipient is represented by either their user id or group id.
throttling ThrottlingResource	The rules and setup for throttling
conditionId string	the id of the condition that determines if this data alert should be triggered
dateCreated string	Timestamp for the creation of the task (rfc3339 format)
description string	description associated to alerting task
errorStatus string	error labels from the latest workflow that happened within the task Enum: OK FATAL-ERROR PARTIAL-TRIGGER
lastTrigger string	last time an execution had been created for requesting user
lastUpdated string	Timestamp of the most recent update.
triggerType string	Type of job that triggered the task Enum: RELOAD SCHEDULED MANUAL
triggerStats required AlertingTaskTriggerStats	No description
hideSelections boolean	Whether the selection needs to be hidden.
evaluationCount integer	the number of actual evaluations with engine this task has consumed in the current month
scheduleOptions ScheduleOptions	No description
subscriptionIds Array<string>	list of subscriptions related to this alerting task
absoluteLastScan string	last time a trigger was detected, but not sure if executed
conditionResponse object	Should reference ConditionResponse type in condition-manager api docs
alertingTaskErrors Array<AlertingTaskError>	No description
absoluteLastTrigger string	last time an execution had been created
hasHistoryCondition boolean	true if the alert has history condition enabled
lastExecutionStatus string	No description Enum: OK FAILED
recipientsChangeHistory Array<RecipientsChange>	No description
lastEvaluationCountUpdate string	the date when the evaluation count was updated

AlertingTaskTriggerStats

object

Properties

totalScans required, maximum=100 integer	The number of scans for the current condition.
last10Scans required, maximum=10 integer	The number of triggers out of the last 10 scans for the current condition.
last100Scans required, maximum=100 integer	The number of triggers out of the last 100 scans for the current condition.

AlertingTaskValidation

object

Properties

id string	Identifies for user id or condition id
type string	Identifier for type of a validation error occurring on alerting task Enum: RECIPIENT CONDITION RECIPIENT_GROUP
error deprecated 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 string	Description of the error
validationErrors Array<string>	No description

AlertingTaskValidationResponse

object

Properties

status

string

No description

Enum:

FAILURE

SUCCESS

validations

Array<AlertingTaskValidation>

No description

Error

object

Properties

code string	Error code specific to sharing service.
meta Error_meta	No description
title string	Error title.
detail string	Error cause.

Error_meta

object

Properties

httpCode

integer

HTTP error code.

Errors

object

Properties

errors Array<Error>	No description
traceId string	No description

Evaluation

Properties

id string<uid>	The unique id for the resource
result string	The final result of the evalution Enum: success failure error
status string	The status of the evaluation execution Enum: RUNNING FAILED FINISHED
endTime string<string>	The time the evaluation ended
ownerId string<uid>	userId of user being impersonated to evaluate the condition
tenantId string<uid>	The tenant id
contextId string	Extra context information to carry through to the result if one was included on when the evaluation was triggered
startTime string<string>	The time the evaluation started
resultData object	Condition type specific result, one of dataResult or compoundResult
causalEvent object	Representation of the event that caused the condition to be evaluated if one was included on when the evaluation was triggered
conditionId string<uid>	The unique id of the associated condition
dataConditionEvaluatorId string<uid>	The unique id for the resource given from Data Condition Evaluator

EvaluationGetResponse

object

Properties

condition object	No description
evaluation Evaluation	No description
hideSelections boolean	No description

ExecutionStats

object

Properties

endTime string	No description
periodKey string	No description
startTime string	No description
totalExecutions string	No description
triggeredExecutions string	No description

GroupIDRecipient

object

an internal recipient based on its group id.

Properties

value string	Group ID of recipient.
enabled boolean	Whether this recipient can receive alerts.
taskGroupRecipientErrors Array<TaskGroupRecipientError>	No description
alertingTaskGroupRecipientErrors Array<AlertingTaskGroupRecipientError>	No description

ListLinks

object

Properties

next Page	No description
prev Page	No description
self Self	Object with Href to a particular element or set of elements

Page

object

Properties

href string	URL to particular set of elements
type string	Page type, can be next or prev Enum: prev next
token string	Page unique token

Recipients

object

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

Properties

userIds required Array<UserIDRecipient>	No description
groupIds Array<GroupIDRecipient>	No description

RecipientsChange

object

Change in a recipient for an alerting task

Properties

dateTime string	time of recipient state change
patchAction 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.

ScheduleOptions

object

Properties

timezone string	The timezone for time calculations in SCHEDULED triggers, optional.
recurrence 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 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 string	The chronos job identifier. It is set once the related chronos job is created.
startDateTime 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 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 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

string

No description

StandardListResponseProps

object

properties that should be added to every list response

Properties

totalCount required integer	total count of entries in the collection as a whole
currentPageCount required integer	count of entries on the currently shown page

TaskGroupRecipientError

object

Properties

value 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 string	Timestamp for the creation of the error

TaskRecipientError

object

Properties

value 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 string	Timestamp for the creation of the error

ThrottlingResource

object

The rules and setup for throttling

Properties

capacity integer	the maximum number of tokens that the bucket can contain
timezone default='Etc/UTC' string	the timezone for time calculations in this throttlingresource, for current time and time reference.
replenishRate integer	the amount of tokens to insert into the bucket on the specified interval. (tokens exceeding capacity are discarded)
recurrenceRule string	A string that supports a subset of RFC5545 recurrence rule directives.
initialTokenCount integer	the initial amount of tokens in the bucket upon creation. cannot exceed capacity.
referenceTimestamp string	a date and time reference specified in RFC3339 format

UserIDRecipient

object

an internal recipient based on its user id.

Properties

value string	User ID of recipient (internal user).
groups Array<string>	A list of associated groups. If a user is added individually the "addedIndividually" pseudo group is included
enabled boolean	Whether this recipient can receive alerts.
subscribed boolean	Whether this recipient is subscribed to alerts of a task
taskRecipientErrors Array<TaskRecipientError>	No description
alertingTaskRecipientErrors Array<AlertingTaskRecipientError>	No description

v0.809.0