openapi: 3.2.0 info: title: data-alerts alerting tasks API version: '' servers: - url: https://{tenant}.{region}.qlikcloud.com variables: region: default: us description: The region the tenant is hosted in tenant: default: your-tenant description: Name of the tenant that will be called tags: - name: alerting tasks paths: /api/v1/data-alerts: get: tags: - alerting tasks summary: List data alert tasks responses: '200': content: application/json: schema: $ref: '#/components/schemas/AlertingTaskListResponse' description: The alerting tasks list has been successfully returned. '400': content: application/json: schema: $ref: '#/components/schemas/Errors' description: Bad request, malformed syntax or errors in parameters. '500': content: application/json: schema: $ref: '#/components/schemas/Errors' description: Internal server error. default: content: application/json: schema: $ref: '#/components/schemas/Errors' description: Error response. parameters: - in: query name: appID schema: type: string required: false description: The app ID you would like to filter by - in: query name: conditionId schema: type: string required: false description: The conditionId you would like to filter by - in: query name: limit schema: type: integer default: 20 maximum: 100 minimum: 1 required: false description: Limit the returned result set - in: query name: next schema: type: string required: false description: The cursor to the next page of data. Only one of next or previous may be specified. - in: query name: offset schema: type: integer default: 0 minimum: 0 required: false description: Offset for finding a list of entities - used for pagination - in: query name: ownerId schema: type: string required: false description: The id of the owner you would like to filter by - in: query name: ownerName schema: type: string required: false description: The name of the owner you would like to filter by - in: query name: prev schema: type: string required: false description: The cursor to the previous page of data. Only one of next or previous may be specified. - in: query name: role schema: type: array items: enum: - owner - recipient - notowner type: string required: false description: The role you would like to filter by - in: query name: sort schema: type: array items: 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 type: string required: false description: Sort the returned result set by the specified field - in: query name: status schema: type: array items: enum: - INVALID_RECIPIENT - INVALID_OWNER - DISABLED - VALID type: string required: false description: The status you would like to filter by description: Retrieves all data alert tasks accessible to the user. Users assigned the `TenantAdmin` or `AnalyticsAdmin` role can view all tasks. operationId: alertingTasksList x-qlik-visibility: public x-qlik-stability: stable x-qlik-deprecated: false x-qlik-tier: tier: '1' limit: 1000 post: tags: - alerting tasks summary: Create data alert task responses: '202': content: application/json: schema: $ref: '#/components/schemas/AlertingTaskResponse' description: Alert creation has been accepted. The alerting task will have status creating, until status is set to either valid or invalid. '400': content: application/json: schema: $ref: '#/components/schemas/Errors' description: Bad request, malformed syntax or errors in parameters. '500': content: application/json: schema: $ref: '#/components/schemas/Errors' description: Internal server error. default: content: application/json: schema: $ref: '#/components/schemas/Errors' description: Error response. description: Creates a new data alerting task. operationId: alertingTasksCreate requestBody: content: application/json: schema: $ref: '#/components/schemas/AlertingTaskCreateRequest' required: true description: The alerting task create request definition. x-qlik-visibility: public x-qlik-stability: stable x-qlik-deprecated: false x-qlik-tier: tier: '2' limit: 100 /api/v1/data-alerts/{alertId}: get: tags: - alerting tasks summary: Get data alert task responses: '200': content: application/json: schema: $ref: '#/components/schemas/AlertingTaskResponse' description: Alert has been successfully returned. '400': content: application/json: schema: $ref: '#/components/schemas/Errors' description: Bad request, malformed syntax or errors in parameters. '404': content: application/json: schema: $ref: '#/components/schemas/Errors' description: Task or execution not found. '500': content: application/json: schema: $ref: '#/components/schemas/Errors' description: Internal server error. default: content: application/json: schema: $ref: '#/components/schemas/Errors' description: Error response. parameters: - in: path name: alertId schema: type: string required: true description: The alerting task identifier. description: Returns the details of a specific data alert task. operationId: alertingTasksIDGet x-qlik-visibility: public x-qlik-stability: stable x-qlik-deprecated: false x-qlik-tier: tier: '1' limit: 1000 patch: tags: - alerting tasks summary: Update data alert task responses: '204': description: The alerting task has been successfully updated. '400': content: application/json: schema: $ref: '#/components/schemas/Errors' description: The specified alerting task ID or body is invalid (e.g. not a number). '404': content: application/json: schema: $ref: '#/components/schemas/Errors' description: An alerting task with the specified ID was not found. '500': content: application/json: schema: $ref: '#/components/schemas/Errors' description: Internal server error. default: content: application/json: schema: $ref: '#/components/schemas/Errors' description: Error response. parameters: - in: path name: alertId schema: type: string required: true description: The alerting task identifier. description: Updates one or more properties of a specific data alerting task. operationId: alertingTasksUpdate requestBody: content: application/json: schema: $ref: '#/components/schemas/AlertingTaskPatchRequestCompliantList' required: true description: Patch request definition for an alerting task. x-qlik-visibility: public x-qlik-stability: stable x-qlik-deprecated: false x-qlik-tier: tier: '2' limit: 100 delete: tags: - alerting tasks summary: Delete data alert task responses: '204': description: The alerting task has been successfully deleted. '400': content: application/json: schema: $ref: '#/components/schemas/Errors' description: The specified alerting task ID is invalid (e.g. not a number). '404': content: application/json: schema: $ref: '#/components/schemas/Errors' description: An alerting task with the specified ID was not found. '500': content: application/json: schema: $ref: '#/components/schemas/Errors' description: Internal server error. default: content: application/json: schema: $ref: '#/components/schemas/Errors' description: Error response. parameters: - in: path name: alertId schema: type: string required: true description: The alerting task identifier. description: Deletes a specific data alerting task. operationId: alertingTasksDelete x-qlik-visibility: public x-qlik-stability: stable x-qlik-deprecated: false x-qlik-tier: tier: '2' limit: 100 /api/v1/data-alerts/{alertId}/condition: get: tags: - alerting tasks summary: Get data alert task condition responses: '200': content: application/json: schema: $ref: '#/components/schemas/AlertingConditionResponse' description: Condition associated with the alerting task has been successfully returned. See ConditionResponse in condition-manager api docs '400': content: application/json: schema: $ref: '#/components/schemas/Errors' description: Bad request, malformed syntax or errors in parameters. '404': content: application/json: schema: $ref: '#/components/schemas/Errors' description: Task or condition not found. '500': content: application/json: schema: $ref: '#/components/schemas/Errors' description: Internal server error. default: content: application/json: schema: $ref: '#/components/schemas/Errors' description: Error response. parameters: - in: path name: alertId schema: type: string required: true description: The alerting task identifier. description: Retrieves the condition associated with a data alerting task. operationId: alertingConditionGet x-qlik-visibility: public x-qlik-stability: stable x-qlik-deprecated: false x-qlik-tier: tier: '1' limit: 1000 /api/v1/data-alerts/{alertId}/recipient-stats: get: tags: - alerting tasks summary: Get data alert task recipient stats responses: '200': content: application/json: schema: $ref: '#/components/schemas/AlertingRecipientStatsResponse' description: Alert recipient stats have been successfully returned. '400': content: application/json: schema: $ref: '#/components/schemas/Errors' description: Bad request, malformed syntax or errors in parameters. '404': content: application/json: schema: $ref: '#/components/schemas/Errors' description: Task or execution not found. '500': content: application/json: schema: $ref: '#/components/schemas/Errors' description: Internal server error. default: content: application/json: schema: $ref: '#/components/schemas/Errors' description: Error response. parameters: - in: path name: alertId schema: type: string required: true description: The alerting task identifier. - in: query name: groups schema: type: array items: type: string required: false description: The name of the groups you would like to filter by - in: query name: sort schema: type: array items: enum: - +userID - -userID - subscribed - +subscribed type: string required: false description: Sort the returned result set by the specified field - in: query name: subscribed schema: type: boolean required: false description: Subscribed property you would like to filter by - in: query name: userID schema: type: string required: false description: The recipients ID you would like to filter by description: Retrieve the recipient stats for a data alerting task. operationId: alertingRecipientStatsGet x-qlik-visibility: public x-qlik-stability: stable x-qlik-deprecated: false x-qlik-tier: tier: '1' limit: 1000 components: schemas: AlertingRecipientStats: type: object required: - enabled properties: type: enum: - userid type: string value: type: string errors: $ref: '#/components/schemas/AlertingRecipientStatsErrors' groups: type: array items: type: string example: - addedIndividually - group1 - group2 description: A list of associated groups. If a user is added individually the "addedIndividually" pseudo group is included enabled: type: boolean description: Whether the recipient is enabled. lastScan: type: string description: last time a trigger was detected, but not sure if executed subscribed: type: boolean description: Whether the recipient is subscribed. lastTrigger: type: string description: last time an execution had been created conditionStatus: enum: - OK - FAILED type: string TaskRecipientError: type: object properties: value: 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 - USER_NOT_FOUND_DL - USER_DISABLED_IN_DL - FILTER_NOT_FOUND - BOOKMARK_NOT_FOUND type: string example: NO_ACCESS_TO_APP description: Identifier for type of error occurring on sharing task specific for recipient timestamp: type: string example: '2019-10-15T16:07:01.492Z' description: Timestamp for the creation of the error Error: type: object properties: code: type: string readOnly: true description: Error code specific to sharing service. meta: $ref: '#/components/schemas/Error_meta' title: type: string readOnly: true description: Error title. detail: type: string readOnly: true description: Error cause. UserIDRecipient: type: object properties: value: type: string example: 1b263bs8m0mm_s21s3f description: User ID of recipient (internal user). groups: type: array items: type: string example: sales description: Name of a group that the user is a member of. example: - addedIndividually - group1 - group2 description: A list of associated groups. If a user is added individually the "addedIndividually" pseudo group is included enabled: type: boolean example: true description: Whether this recipient can receive alerts. subscribed: type: boolean example: true description: Whether this recipient is subscribed to alerts of a task taskRecipientErrors: type: - array - 'null' items: $ref: '#/components/schemas/TaskRecipientError' alertingTaskRecipientErrors: type: array items: $ref: '#/components/schemas/AlertingTaskRecipientError' description: an internal recipient based on its user id. AlertingTaskRecipientError: type: object properties: added: type: string example: '2019-10-15T16:07:01.492Z' description: Timestamp for the creation of the error value: 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 type: string example: NO_ACCESS_TO_APP description: Identifier for type of error occurring on alerting task AlertingTaskPatchRequestCompliantList: type: array items: $ref: '#/components/schemas/AlertingTaskPatchRequestCompliant' AlertingConditionResponse: type: object properties: hideSelections: type: boolean conditionResponse: type: object properties: {} description: Should reference ConditionResponse type in condition-manager api docs TaskGroupRecipientError: type: object properties: value: enum: - GROUP_IS_DISABLED - MAX_ALERTS_LIMIT_REACHED - GROUP_WITH_NO_APP_ACCESS - GROUP_IS_DELETED - GROUP_NOT_FOUND_DL - GROUP_DISABLED_IN_DL type: string example: GROUP_WITH_NO_APP_ACCESS description: Identifier for type of error occurring on sharing task specific for group recipient timestamp: type: string example: '2019-10-15T16:07:01.492Z' description: Timestamp for the creation of the error StandardListResponseProps: type: object required: - currentPageCount - totalCount properties: totalCount: type: integer description: total count of entries in the collection as a whole currentPageCount: type: integer description: count of entries on the currently shown page description: properties that should be added to every list response Error_meta: type: object properties: httpCode: type: integer readOnly: true description: HTTP error code. AlertingTaskResponse: type: object required: - triggerStats properties: id: type: string example: 5da5825325dc9a0dd0260af9 description: data alerting identifier (this is the alertID) x-go-custom-tag: bson:"_id" name: type: string description: name associated to alerting task appId: type: string description: appId associated to this alert definition links: $ref: '#/components/schemas/Links' status: enum: - creating - deleting type: string description: particular status of the alerting task enabled: type: boolean description: true if the alerting task is enabled ownerId: type: string description: the owner of this alert sheetId: type: string description: sheetId associated to this alert definition lastScan: type: string description: last time a trigger was detected, but not sure if executed for requesting user tenantId: type: string description: the tenant of this alert ownerName: type: string description: the owner name of this alert accessMode: enum: - SOURCE_ACCESS - TARGET_ACCESS type: string bookmarkId: type: string description: bookmarkId associated to this alert definition recipients: $ref: '#/components/schemas/Recipients' throttling: $ref: '#/components/schemas/ThrottlingResource' conditionId: type: string description: the id of the condition that determines if this data alert should be triggered dateCreated: type: string example: '2019-10-15T16:07:01.492Z' description: Timestamp for the creation of the task (rfc3339 format) description: type: string description: description associated to alerting task errorStatus: enum: - OK - FATAL-ERROR - PARTIAL-TRIGGER type: string description: error labels from the latest workflow that happened within the task lastTrigger: type: string description: last time an execution had been created for requesting user lastUpdated: type: string example: '2019-10-15T16:07:01.492Z' description: Timestamp of the most recent update. triggerType: enum: - RELOAD - SCHEDULED - MANUAL type: string description: Type of job that triggered the task triggerStats: $ref: '#/components/schemas/AlertingTaskTriggerStats' hideSelections: type: boolean description: Whether the selection needs to be hidden. evaluationCount: type: integer description: the number of actual evaluations with engine this task has consumed in the current month scheduleOptions: $ref: '#/components/schemas/ScheduleOptions' subscriptionIds: type: array items: type: string description: list of subscriptions related to this alerting task absoluteLastScan: type: string description: last time a trigger was detected, but not sure if executed conditionResponse: type: object properties: {} description: Should reference ConditionResponse type in condition-manager api docs alertingTaskErrors: type: array items: $ref: '#/components/schemas/AlertingTaskError' x-omitempty: true absoluteLastTrigger: type: string description: last time an execution had been created hasHistoryCondition: type: boolean description: true if the alert has history condition enabled lastExecutionStatus: enum: - OK - FAILED type: string recipientsChangeHistory: type: array items: $ref: '#/components/schemas/RecipientsChange' lastEvaluationCountUpdate: type: string description: the date when the evaluation count was updated RecipientsChange: type: object properties: dateTime: type: string description: time of recipient state change patchAction: $ref: '#/components/schemas/AlertingTaskRecipientPatch' description: Change in a recipient for an alerting task AlertingRecipientStatsResponse: type: object properties: recipientStats: type: array items: $ref: '#/components/schemas/AlertingRecipientStats' AlertingTaskCreateRequest: type: object required: - appId - conditionId - name - recipients - triggerType properties: name: type: string example: Sales threshold alert maxLength: 78 description: name associated to alerting task appId: type: string example: e0e3187e-4f8c-4c1f-9d2a-1234567890ab description: appId associated to this alert definition enabled: type: boolean default: true description: if the alerting task is enabled sheetId: type: string example: abcABC1 description: sheetId associated to this alert definition bookmarkId: type: string example: def-456 description: bookmarkId associated to this alert definition recipients: $ref: '#/components/schemas/Recipients' throttling: $ref: '#/components/schemas/ThrottlingResource' conditionId: type: string example: cond-789 description: the id of the condition that determines if this data alert should be triggered description: type: string example: Notifies when sales drop below target. maxLength: 255 description: description associated to alerting task triggerType: enum: - RELOAD - SCHEDULED type: string example: SCHEDULED description: Type of job that triggered the task scheduleOptions: $ref: '#/components/schemas/ScheduleOptions' description: a alerting task (a definition on an alert) AlertingTaskError: type: object properties: added: type: string example: '2019-10-15T16:07:01.492Z' description: Timestamp for the creation of the error value: enum: - OWNER_DISABLED - OWNER_ACCESS - OWNER_LICENSE - APP_DELETED - NO_RECIPIENTS - PARTIAL_ACCESS - EVAL_ERROR - ORPHAN - CONVERSION_DENIED - EXPIRED - PARTIAL_SENT - QUOTA_REACHED - OWNER_HAS_NO_VALID_USER_ENTITLEMENT type: string description: Identifier for type of error occurring on alerting task AlertingTaskGroupRecipientError: type: object properties: added: type: string example: '2019-10-15T16:07:01.492Z' description: Timestamp for the creation of the error value: enum: - GROUP_IS_DISABLED - MAX_ALERTS_LIMIT_REACHED - GROUP_WITH_NO_APP_ACCESS - GROUP_IS_DELETED type: string example: GROUP_WITH_NO_APP_ACCESS description: Identifier for type of error occurring on alerting task Links: type: object properties: self: $ref: '#/components/schemas/Self' AlertingTaskRecipientPatch_inner: type: object required: - op - recipientType - value properties: op: enum: - remove - add - replace - enable - disable - subscribe - unsubscribe type: string description: The operation to be performed. value: type: object properties: {} description: The value to be used for this operation. recipientType: enum: - userid - groupid type: string description: Defines the path for the given resource field to patch. AlertingRecipientStatsErrors: type: array items: $ref: '#/components/schemas/AlertingRecipientStatsError' ScheduleOptions: type: object properties: timezone: type: - string - 'null' example: Canada/Pacific description: The timezone for time calculations in SCHEDULED triggers, optional. recurrence: type: array items: type: string example: RRULE:FREQ=WEEKLY;INTERVAL=1 description: A recurrence rule (RRULE) describing the schedule. example: - RRULE:FREQ=HOURLY;INTERVAL=2 description: 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: type: - string - 'null' default: '' example: '2026-01-02T16:04:05' description: 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: type: string example: chronos-job-123 readOnly: true description: The chronos job identifier. It is set once the related chronos job is created. startDateTime: type: - string - 'null' example: '2006-01-02T16:04:05' description: 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: type: - string - 'null' example: '2020-11-20T12:00:55.000Z' readOnly: true description: 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: type: - string - 'null' example: '2020-11-20T12:00:55.000Z' readOnly: true description: 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. ThrottlingResource: type: object properties: capacity: type: integer example: 10 description: the maximum number of tokens that the bucket can contain timezone: type: string default: Etc/UTC description: the timezone for time calculations in this throttlingresource, for current time and time reference. replenishRate: type: integer example: 1 description: the amount of tokens to insert into the bucket on the specified interval. (tokens exceeding capacity are discarded) recurrenceRule: type: string example: RRULE:FREQ=DAILY description: A string that supports a subset of RFC5545 recurrence rule directives. initialTokenCount: type: integer example: 10 description: the initial amount of tokens in the bucket upon creation. cannot exceed capacity. referenceTimestamp: type: string example: '2021-07-14T10:00:00Z' description: a date and time reference specified in RFC3339 format description: The rules and setup for throttling Errors: type: object example: errors: - code: HTTP-123 title: short error message details: detailed error message traceId: 7975401f3954aa47 properties: errors: type: array items: $ref: '#/components/schemas/Error' traceId: type: string AlertingTaskListResponse: allOf: - $ref: '#/components/schemas/StandardListResponseProps' - type: object properties: links: $ref: '#/components/schemas/ListLinks' tasks: type: array items: $ref: '#/components/schemas/AlertingTaskResponse' description: Gets a list of alerting tasks. Page: type: object properties: href: type: string example: http://localhost:8787/v1/items?limit=12 description: URL to particular set of elements type: enum: - prev - next type: string example: next description: Page type, can be next or prev token: type: string example: JwAAAAJfaWQAGQAAADVjZjUwM2NjMjVkYzlhMTM1MzYwZTVjZAAA description: Page unique token AlertingTaskRecipientPatch: type: array items: $ref: '#/components/schemas/AlertingTaskRecipientPatch_inner' example: - 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 description: 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. AlertingRecipientStatsError: type: object properties: code: type: string readOnly: true description: Error code specific to sharing service. title: type: string readOnly: true description: Error title. detail: type: string readOnly: true description: Error cause. AlertingTaskPatchRequestCompliant: type: object required: - op - path properties: op: enum: - replace type: string description: The operation to be performed path: enum: - /ownerName - /ownerId - /conditionId - /enabledAction - /bookmarkId - /name - /description - /throttling - /triggerType - /scheduleOptions type: string description: A JSON Patch document as defined in https://datatracker.ietf.org/doc/html/rfc6902 value: type: object properties: {} description: The value to be used for this operation. Self: type: object properties: href: type: string example: http://localhost:8787/v1/items/5da5825325dc9a0dd0260af9 description: Object with Href to a particular element or set of elements ListLinks: type: object properties: next: $ref: '#/components/schemas/Page' prev: $ref: '#/components/schemas/Page' self: $ref: '#/components/schemas/Self' AlertingTaskTriggerStats: type: object required: - last100Scans - last10Scans - totalScans properties: totalScans: type: integer maximum: 100 description: The number of scans for the current condition. last10Scans: type: integer maximum: 10 description: The number of triggers out of the last 10 scans for the current condition. last100Scans: type: integer maximum: 100 description: The number of triggers out of the last 100 scans for the current condition. Recipients: type: object required: - userIds properties: DLUsers: type: array userIds: type: array items: $ref: '#/components/schemas/UserIDRecipient' DLGroups: type: array DLListId: type: string example: dl-12345 description: Identifier of the distribution list the recipients belong to. groupIds: type: array items: $ref: '#/components/schemas/GroupIDRecipient' description: List of recipients. An internal recipient is represented by either their user id or group id. GroupIDRecipient: type: object properties: value: type: string example: group1 description: Group ID of recipient. enabled: type: boolean example: true description: Whether this recipient can receive alerts. taskGroupRecipientErrors: type: - array - 'null' items: $ref: '#/components/schemas/TaskGroupRecipientError' alertingTaskGroupRecipientErrors: type: array items: $ref: '#/components/schemas/AlertingTaskGroupRecipientError' description: an internal recipient based on its group id.