Data alerts

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

Download OpenAPI spec

Endpoints

GET

/api/v1/data-alerts
POST

/api/v1/data-alerts
GET

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

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

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

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

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

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

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

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

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

/api/v1/data-alerts/{taskId}/executions/stats
POST

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

/api/v1/data-alerts/actions/validate
GET

/api/v1/data-alerts/settings
PUT

/api/v1/data-alerts/settings

Retrieves all data alert tasks accessible to the user. Users assigned the TenantAdmin or AnalyticsAdmin role can view all tasks.

Facts

Rate limit

Tier 1 (1000 requests per minute)

Query Parameters

appID string

The app ID you would like to filter by
conditionId string

The conditionId you would like to filter by
limit integer

Limit the returned result set

minimum = 1, maximum = 100, default = 20, default = 20
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

minimum = 0, default = 0, default = 0
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 of strings

The role you would like to filter by

Values may be any of: "owner""recipient""notowner"
sort array of strings

Sort the returned result set by the specified field

Values may be any of: "-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 of strings

The status you would like to filter by

Values may be any of: "INVALID_RECIPIENT""INVALID_OWNER""DISABLED""VALID"

Responses

200

The alerting tasks list has been successfully returned.

application/json object

properties that should be added to every list response
Show application/json properties
- totalCount integer
  
  Required
  
  total count of entries in the collection as a whole
- currentPageCount integer
  
  Required
  
  count of entries on the currently shown page
- links object
  
  Show links properties
  
  next object
  
  Show next properties
  
  href string
  
  URL to particular set of elements
  
  type string
  
  Page type, can be next or prev
  
  Can be one of: "prev""next"
  
  token string
  
  Page unique token
  
  prev object
  
  Show prev properties
  
  href string
  
  URL to particular set of elements
  
  type string
  
  Page type, can be next or prev
  
  Can be one of: "prev""next"
  
  token string
  
  Page unique token
  
  self object
  
  Object with Href to a particular element or set of elements
  
  Show self properties
  
  href string
- tasks array of objects
  
  Gets a list of alerting tasks.
  
  Show tasks 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 object
  
  Show links properties
  
  self object
  
  Object with Href to a particular element or set of elements
  
  Show self properties
  
  href string
  
  status string
  
  particular status of the alerting task
  
  Can be one of: "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
  
  Can be one of: "SOURCE_ACCESS""TARGET_ACCESS"
  
  bookmarkId string
  
  bookmarkId associated to this alert definition
  
  recipients object
  
  List of recipients. An internal recipient is represented by either their user id or group id.
  
  Show recipients properties
  
  DLUsers array
  
  userIds array of objects
  
  Required
  
  an internal recipient based on its user id.
  
  Show userIds properties
  
  value string
  
  User ID of recipient (internal user).
  
  groups array of strings
  
  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 of objects
  
  Show taskRecipientErrors properties
  
  value string
  
  Identifier for type of error occurring on sharing task specific for recipient
  
  Can be one of: "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"
  
  timestamp string
  
  Timestamp for the creation of the error
  
  alertingTaskRecipientErrors array of objects
  
  Show alertingTaskRecipientErrors properties
  
  added string
  
  Timestamp for the creation of the error
  
  value string
  
  Identifier for type of error occurring on alerting task
  
  Can be one of: "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"
  
  DLGroups array
  
  DLListId string
  
  Identifier of the distribution list the recipients belong to.
  
  groupIds array of objects
  
  an internal recipient based on its group id.
  
  Show groupIds properties
  
  value string
  
  Group ID of recipient.
  
  enabled boolean
  
  Whether this recipient can receive alerts.
  
  taskGroupRecipientErrors array of objects
  
  Show taskGroupRecipientErrors properties
  
  value string
  
  Identifier for type of error occurring on sharing task specific for group recipient
  
  Can be one of: "GROUP_IS_DISABLED""MAX_ALERTS_LIMIT_REACHED""GROUP_WITH_NO_APP_ACCESS""GROUP_IS_DELETED""GROUP_NOT_FOUND_DL""GROUP_DISABLED_IN_DL"
  
  timestamp string
  
  Timestamp for the creation of the error
  
  alertingTaskGroupRecipientErrors array of objects
  
  Show alertingTaskGroupRecipientErrors properties
  
  added string
  
  Timestamp for the creation of the error
  
  value string
  
  Identifier for type of error occurring on alerting task
  
  Can be one of: "GROUP_IS_DISABLED""MAX_ALERTS_LIMIT_REACHED""GROUP_WITH_NO_APP_ACCESS""GROUP_IS_DELETED"
  
  throttling object
  
  The rules and setup for throttling
  
  Show throttling properties
  
  capacity integer
  
  the maximum number of tokens that the bucket can contain
  
  timezone string
  
  the timezone for time calculations in this throttlingresource, for current time and time reference.
  
  default = "Etc/UTC"
  
  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
  
  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
  
  Can be one of: "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
  
  Can be one of: "RELOAD""SCHEDULED""MANUAL"
  
  triggerStats object
  
  Required
  
  Show triggerStats properties
  
  totalScans integer
  
  Required
  
  The number of scans for the current condition.
  
  maximum = 100
  
  last10Scans integer
  
  Required
  
  The number of triggers out of the last 10 scans for the current condition.
  
  maximum = 10
  
  last100Scans integer
  
  Required
  
  The number of triggers out of the last 100 scans for the current condition.
  
  maximum = 100
  
  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 object
  
  Show scheduleOptions properties
  
  timezone string
  
  The timezone for time calculations in SCHEDULED triggers, optional.
  
  recurrence array of strings
  
  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 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.
  
  default = ""
  
  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.
  
  subscriptionIds array of strings
  
  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 of objects
  
  Show alertingTaskErrors properties
  
  added string
  
  Timestamp for the creation of the error
  
  value string
  
  Identifier for type of error occurring on alerting task
  
  Can be one of: "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"
  
  absoluteLastTrigger string
  
  last time an execution had been created
  
  hasHistoryCondition boolean
  
  true if the alert has history condition enabled
  
  lastExecutionStatus string
  
  Can be one of: "OK""FAILED"
  
  recipientsChangeHistory array of objects
  
  Change in a recipient for an alerting task
  
  Show recipientsChangeHistory properties
  
  dateTime string
  
  time of recipient state change
  
  patchAction array of objects
  
  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.
  
  Show patchAction properties
  
  op string
  
  Required
  
  The operation to be performed.
  
  Can be one of: "remove""add""replace""enable""disable""subscribe""unsubscribe"
  
  value object
  
  Required
  
  The value to be used for this operation.
  
  recipientType string
  
  Required
  
  Defines the path for the given resource field to patch.
  
  Can be one of: "userid""groupid"
  
  lastEvaluationCountUpdate string
  
  the date when the evaluation count was updated

400

Bad request, malformed syntax or errors in parameters.

application/json object
Show application/json properties
- errors array of objects
  
  Show errors properties
  
  code string
  
  Error code specific to sharing service.
  
  meta object
  
  Show meta properties
  
  httpCode integer
  
  HTTP error code.
  
  title string
  
  Error title.
  
  detail string
  
  Error cause.
- traceId string

500

Internal server error.

application/json object
Show application/json properties
- errors array of objects
  
  Show errors properties
  
  code string
  
  Error code specific to sharing service.
  
  meta object
  
  Show meta properties
  
  httpCode integer
  
  HTTP error code.
  
  title string
  
  Error title.
  
  detail string
  
  Error cause.
- traceId string

default

Error response.

application/json object
Show application/json properties
- errors array of objects
  
  Show errors properties
  
  code string
  
  Error code specific to sharing service.
  
  meta object
  
  Show meta properties
  
  httpCode integer
  
  HTTP error code.
  
  title string
  
  Error title.
  
  detail string
  
  Error cause.
- traceId string

GET /api/v1/data-alerts

import { createQlikApi } from '@qlik/api'

const qlik = createQlikApi({
  hostConfig: {
    host: 'https://{tenant}.{region}.qlikcloud.com',
    apiKey: '<access-token>',
  },
})

await qlik.dataAlerts.getDataAlerts({})

qlik data-alert ls

curl "https://{tenant}.{region}.qlikcloud.com/api/v1/data-alerts" \
-H "Authorization: Bearer <access_token>"

Example Response

{
  "totalCount": 42,
  "currentPageCount": 42,
  "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": {
        "DLUsers": [],
        "userIds": [
          {
            "value": "1b263bs8m0mm_s21s3f",
            "groups": [
              "addedIndividually",
              "group1",
              "group2"
            ],
            "enabled": true,
            "subscribed": true,
            "taskRecipientErrors": [
              {
                "value": "NO_ACCESS_TO_APP",
                "timestamp": "2019-10-15T16:07:01.492Z"
              }
            ],
            "alertingTaskRecipientErrors": [
              {
                "added": "2019-10-15T16:07:01.492Z",
                "value": "NO_ACCESS_TO_APP"
              }
            ]
          }
        ],
        "DLGroups": [],
        "DLListId": "dl-12345",
        "groupIds": [
          {
            "value": "group1",
            "enabled": true,
            "taskGroupRecipientErrors": [
              {
                "value": "GROUP_WITH_NO_APP_ACCESS",
                "timestamp": "2019-10-15T16:07:01.492Z"
              }
            ],
            "alertingTaskGroupRecipientErrors": [
              {
                "added": "2019-10-15T16:07:01.492Z",
                "value": "GROUP_WITH_NO_APP_ACCESS"
              }
            ]
          }
        ]
      },
      "throttling": {
        "capacity": 10,
        "timezone": "Etc/UTC",
        "replenishRate": 1,
        "recurrenceRule": "RRULE:FREQ=DAILY",
        "initialTokenCount": 10,
        "referenceTimestamp": "2021-07-14T10:00:00Z"
      },
      "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": 100,
        "last10Scans": 10,
        "last100Scans": 100
      },
      "hideSelections": true,
      "evaluationCount": 42,
      "scheduleOptions": {
        "timezone": "Canada/Pacific",
        "recurrence": [
          "RRULE:FREQ=HOURLY;INTERVAL=2"
        ],
        "endDateTime": "",
        "chronosJobID": "chronos-job-123",
        "startDateTime": "2006-01-02T16:04:05",
        "lastExecutionTime": "2020-11-20T12:00:55.000Z",
        "nextExecutionTime": "2020-11-20T12:00:55.000Z"
      },
      "subscriptionIds": [
        "string"
      ],
      "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 data alerting task.

Facts

Rate limit

Tier 2 (100 requests per minute)

Request Body

Required

The alerting task create request definition.

application/json object

a alerting task (a definition on an alert)
Show application/json properties
- name string
  
  Required
  
  name associated to alerting task
  
  maxLength = 78
- appId string
  
  Required
  
  appId associated to this alert definition
- enabled boolean
  
  if the alerting task is enabled
  
  default = true
- sheetId string
  
  sheetId associated to this alert definition
- bookmarkId string
  
  bookmarkId associated to this alert definition
- recipients object
  
  Required
  
  List of recipients. An internal recipient is represented by either their user id or group id.
  
  Show recipients properties
  
  DLUsers array
  
  userIds array of objects
  
  Required
  
  an internal recipient based on its user id.
  
  Show userIds properties
  
  value string
  
  User ID of recipient (internal user).
  
  groups array of strings
  
  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 of objects
  
  Show taskRecipientErrors properties
  
  value string
  
  Identifier for type of error occurring on sharing task specific for recipient
  
  Can be one of: "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"
  
  timestamp string
  
  Timestamp for the creation of the error
  
  alertingTaskRecipientErrors array of objects
  
  Show alertingTaskRecipientErrors properties
  
  added string
  
  Timestamp for the creation of the error
  
  value string
  
  Identifier for type of error occurring on alerting task
  
  Can be one of: "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"
  
  DLGroups array
  
  DLListId string
  
  Identifier of the distribution list the recipients belong to.
  
  groupIds array of objects
  
  an internal recipient based on its group id.
  
  Show groupIds properties
  
  value string
  
  Group ID of recipient.
  
  enabled boolean
  
  Whether this recipient can receive alerts.
  
  taskGroupRecipientErrors array of objects
  
  Show taskGroupRecipientErrors properties
  
  value string
  
  Identifier for type of error occurring on sharing task specific for group recipient
  
  Can be one of: "GROUP_IS_DISABLED""MAX_ALERTS_LIMIT_REACHED""GROUP_WITH_NO_APP_ACCESS""GROUP_IS_DELETED""GROUP_NOT_FOUND_DL""GROUP_DISABLED_IN_DL"
  
  timestamp string
  
  Timestamp for the creation of the error
  
  alertingTaskGroupRecipientErrors array of objects
  
  Show alertingTaskGroupRecipientErrors properties
  
  added string
  
  Timestamp for the creation of the error
  
  value string
  
  Identifier for type of error occurring on alerting task
  
  Can be one of: "GROUP_IS_DISABLED""MAX_ALERTS_LIMIT_REACHED""GROUP_WITH_NO_APP_ACCESS""GROUP_IS_DELETED"
- throttling object
  
  The rules and setup for throttling
  
  Show throttling properties
  
  capacity integer
  
  the maximum number of tokens that the bucket can contain
  
  timezone string
  
  the timezone for time calculations in this throttlingresource, for current time and time reference.
  
  default = "Etc/UTC"
  
  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
- conditionId string
  
  Required
  
  the id of the condition that determines if this data alert should be triggered
- description string
  
  description associated to alerting task
  
  maxLength = 255
- triggerType string
  
  Required
  
  Type of job that triggered the task
  
  Can be one of: "RELOAD""SCHEDULED"
- scheduleOptions object
  
  Show scheduleOptions properties
  
  timezone string
  
  The timezone for time calculations in SCHEDULED triggers, optional.
  
  recurrence array of strings
  
  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 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.
  
  default = ""
  
  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.

Responses

202

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

application/json object
Show application/json 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 object
  
  Show links properties
  
  self object
  
  Object with Href to a particular element or set of elements
  
  Show self properties
  
  href string
- status string
  
  particular status of the alerting task
  
  Can be one of: "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
  
  Can be one of: "SOURCE_ACCESS""TARGET_ACCESS"
- bookmarkId string
  
  bookmarkId associated to this alert definition
- recipients object
  
  List of recipients. An internal recipient is represented by either their user id or group id.
  
  Show recipients properties
  
  DLUsers array
  
  userIds array of objects
  
  Required
  
  an internal recipient based on its user id.
  
  Show userIds properties
  
  value string
  
  User ID of recipient (internal user).
  
  groups array of strings
  
  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 of objects
  
  Show taskRecipientErrors properties
  
  value string
  
  Identifier for type of error occurring on sharing task specific for recipient
  
  Can be one of: "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"
  
  timestamp string
  
  Timestamp for the creation of the error
  
  alertingTaskRecipientErrors array of objects
  
  Show alertingTaskRecipientErrors properties
  
  added string
  
  Timestamp for the creation of the error
  
  value string
  
  Identifier for type of error occurring on alerting task
  
  Can be one of: "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"
  
  DLGroups array
  
  DLListId string
  
  Identifier of the distribution list the recipients belong to.
  
  groupIds array of objects
  
  an internal recipient based on its group id.
  
  Show groupIds properties
  
  value string
  
  Group ID of recipient.
  
  enabled boolean
  
  Whether this recipient can receive alerts.
  
  taskGroupRecipientErrors array of objects
  
  Show taskGroupRecipientErrors properties
  
  value string
  
  Identifier for type of error occurring on sharing task specific for group recipient
  
  Can be one of: "GROUP_IS_DISABLED""MAX_ALERTS_LIMIT_REACHED""GROUP_WITH_NO_APP_ACCESS""GROUP_IS_DELETED""GROUP_NOT_FOUND_DL""GROUP_DISABLED_IN_DL"
  
  timestamp string
  
  Timestamp for the creation of the error
  
  alertingTaskGroupRecipientErrors array of objects
  
  Show alertingTaskGroupRecipientErrors properties
  
  added string
  
  Timestamp for the creation of the error
  
  value string
  
  Identifier for type of error occurring on alerting task
  
  Can be one of: "GROUP_IS_DISABLED""MAX_ALERTS_LIMIT_REACHED""GROUP_WITH_NO_APP_ACCESS""GROUP_IS_DELETED"
- throttling object
  
  The rules and setup for throttling
  
  Show throttling properties
  
  capacity integer
  
  the maximum number of tokens that the bucket can contain
  
  timezone string
  
  the timezone for time calculations in this throttlingresource, for current time and time reference.
  
  default = "Etc/UTC"
  
  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
- 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
  
  Can be one of: "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
  
  Can be one of: "RELOAD""SCHEDULED""MANUAL"
- triggerStats object
  
  Required
  
  Show triggerStats properties
  
  totalScans integer
  
  Required
  
  The number of scans for the current condition.
  
  maximum = 100
  
  last10Scans integer
  
  Required
  
  The number of triggers out of the last 10 scans for the current condition.
  
  maximum = 10
  
  last100Scans integer
  
  Required
  
  The number of triggers out of the last 100 scans for the current condition.
  
  maximum = 100
- 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 object
  
  Show scheduleOptions properties
  
  timezone string
  
  The timezone for time calculations in SCHEDULED triggers, optional.
  
  recurrence array of strings
  
  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 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.
  
  default = ""
  
  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.
- subscriptionIds array of strings
  
  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 of objects
  
  Show alertingTaskErrors properties
  
  added string
  
  Timestamp for the creation of the error
  
  value string
  
  Identifier for type of error occurring on alerting task
  
  Can be one of: "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"
- absoluteLastTrigger string
  
  last time an execution had been created
- hasHistoryCondition boolean
  
  true if the alert has history condition enabled
- lastExecutionStatus string
  
  Can be one of: "OK""FAILED"
- recipientsChangeHistory array of objects
  
  Change in a recipient for an alerting task
  
  Show recipientsChangeHistory properties
  
  dateTime string
  
  time of recipient state change
  
  patchAction array of objects
  
  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.
  
  Show patchAction properties
  
  op string
  
  Required
  
  The operation to be performed.
  
  Can be one of: "remove""add""replace""enable""disable""subscribe""unsubscribe"
  
  value object
  
  Required
  
  The value to be used for this operation.
  
  recipientType string
  
  Required
  
  Defines the path for the given resource field to patch.
  
  Can be one of: "userid""groupid"
- lastEvaluationCountUpdate string
  
  the date when the evaluation count was updated

400

Bad request, malformed syntax or errors in parameters.

application/json object
Show application/json properties
- errors array of objects
  
  Show errors properties
  
  code string
  
  Error code specific to sharing service.
  
  meta object
  
  Show meta properties
  
  httpCode integer
  
  HTTP error code.
  
  title string
  
  Error title.
  
  detail string
  
  Error cause.
- traceId string

500

Internal server error.

application/json object
Show application/json properties
- errors array of objects
  
  Show errors properties
  
  code string
  
  Error code specific to sharing service.
  
  meta object
  
  Show meta properties
  
  httpCode integer
  
  HTTP error code.
  
  title string
  
  Error title.
  
  detail string
  
  Error cause.
- traceId string

default

Error response.

application/json object
Show application/json properties
- errors array of objects
  
  Show errors properties
  
  code string
  
  Error code specific to sharing service.
  
  meta object
  
  Show meta properties
  
  httpCode integer
  
  HTTP error code.
  
  title string
  
  Error title.
  
  detail string
  
  Error cause.
- traceId string

POST /api/v1/data-alerts

import { createQlikApi } from '@qlik/api'

const qlik = createQlikApi({
  hostConfig: {
    host: 'https://{tenant}.{region}.qlikcloud.com',
    apiKey: '<access-token>',
  },
})

await qlik.dataAlerts.createDataAlert({
  appId: 'e0e3187e-4f8c-4c1f-9d2a-1234567890ab',
  bookmarkId: 'def-456',
  conditionId: 'cond-789',
  description:
    'Notifies when sales drop below target.',
  enabled: true,
  name: 'Sales threshold alert',
  recipients: {
    DLListId: 'dl-12345',
    groupIds: [
      {
        alertingTaskGroupRecipientErrors: [
          {
            added: '2019-10-15T16:07:01.492Z',
            value: 'GROUP_WITH_NO_APP_ACCESS',
          },
        ],
        enabled: true,
        taskGroupRecipientErrors: [
          {
            value: 'GROUP_WITH_NO_APP_ACCESS',
            timestamp: '2019-10-15T16:07:01.492Z',
          },
        ],
        value: 'group1',
      },
    ],
    userIds: [
      {
        alertingTaskRecipientErrors: [
          {
            added: '2019-10-15T16:07:01.492Z',
            value: 'NO_ACCESS_TO_APP',
          },
        ],
        enabled: true,
        groups: [
          'addedIndividually',

          'group1',

          'group2',
        ],
        subscribed: true,
        taskRecipientErrors: [
          {
            value: 'NO_ACCESS_TO_APP',
            timestamp: '2019-10-15T16:07:01.492Z',
          },
        ],
        value: '1b263bs8m0mm_s21s3f',
      },
    ],
  },
  scheduleOptions: {
    recurrence: ['RRULE:FREQ=HOURLY;INTERVAL=2'],
    startDateTime: '2006-01-02T16:04:05',
    timezone: 'Canada/Pacific',
  },
  sheetId: 'abcABC1',
  throttling: {
    capacity: 10,
    initialTokenCount: 10,
    recurrenceRule: 'RRULE:FREQ=DAILY',
    referenceTimestamp: '2021-07-14T10:00:00Z',
    replenishRate: 1,
    timezone: 'Etc/UTC',
  },
  triggerType: 'SCHEDULED',
})

qlik data-alert create \
  --appId 'e0e3187e-4f8c-4c1f-9d2a-1234567890ab' \
  --conditionId 'cond-789' \
  --name 'Sales threshold alert' \
  --recipients-DLListId 'dl-12345' \
  --recipients-groupIds-alertingTaskGroupRecipientErrors-added '' \
  --recipients-groupIds-alertingTaskGroupRecipientErrors-value '' \
  --recipients-groupIds-enabled  \
  --recipients-groupIds-taskGroupRecipientErrors-timestamp '' \
  --recipients-groupIds-taskGroupRecipientErrors-value '' \
  --recipients-groupIds-value '' \
  --recipients-userIds-alertingTaskRecipientErrors-added '' \
  --recipients-userIds-alertingTaskRecipientErrors-value '' \
  --recipients-userIds-enabled  \
  --recipients-userIds-groups '' \
  --recipients-userIds-subscribed  \
  --recipients-userIds-taskRecipientErrors-timestamp '' \
  --recipients-userIds-taskRecipientErrors-value '' \
  --recipients-userIds-value '' \
  --triggerType 'SCHEDULED'

curl "https://{tenant}.{region}.qlikcloud.com/api/v1/data-alerts" \
-X POST \
-H "Content-type: application/json" \
-H "Authorization: Bearer <access_token>" \
-d '{"name":"Sales threshold alert","appId":"e0e3187e-4f8c-4c1f-9d2a-1234567890ab","enabled":true,"sheetId":"abcABC1","bookmarkId":"def-456","recipients":{"DLUsers":[],"userIds":[{"value":"1b263bs8m0mm_s21s3f","groups":["addedIndividually","group1","group2"],"enabled":true,"subscribed":true,"taskRecipientErrors":[{"value":"NO_ACCESS_TO_APP","timestamp":"2019-10-15T16:07:01.492Z"}],"alertingTaskRecipientErrors":[{"added":"2019-10-15T16:07:01.492Z","value":"NO_ACCESS_TO_APP"}]}],"DLGroups":[],"DLListId":"dl-12345","groupIds":[{"value":"group1","enabled":true,"taskGroupRecipientErrors":[{"value":"GROUP_WITH_NO_APP_ACCESS","timestamp":"2019-10-15T16:07:01.492Z"}],"alertingTaskGroupRecipientErrors":[{"added":"2019-10-15T16:07:01.492Z","value":"GROUP_WITH_NO_APP_ACCESS"}]}]},"throttling":{"capacity":10,"timezone":"Etc/UTC","replenishRate":1,"recurrenceRule":"RRULE:FREQ=DAILY","initialTokenCount":10,"referenceTimestamp":"2021-07-14T10:00:00Z"},"conditionId":"cond-789","description":"Notifies when sales drop below target.","triggerType":"SCHEDULED","scheduleOptions":{"timezone":"Canada/Pacific","recurrence":["RRULE:FREQ=HOURLY;INTERVAL=2"],"endDateTime":"","startDateTime":"2006-01-02T16:04:05"}}'

Example Response

{
  "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": {
    "DLUsers": [],
    "userIds": [
      {
        "value": "1b263bs8m0mm_s21s3f",
        "groups": [
          "addedIndividually",
          "group1",
          "group2"
        ],
        "enabled": true,
        "subscribed": true,
        "taskRecipientErrors": [
          {
            "value": "NO_ACCESS_TO_APP",
            "timestamp": "2019-10-15T16:07:01.492Z"
          }
        ],
        "alertingTaskRecipientErrors": [
          {
            "added": "2019-10-15T16:07:01.492Z",
            "value": "NO_ACCESS_TO_APP"
          }
        ]
      }
    ],
    "DLGroups": [],
    "DLListId": "dl-12345",
    "groupIds": [
      {
        "value": "group1",
        "enabled": true,
        "taskGroupRecipientErrors": [
          {
            "value": "GROUP_WITH_NO_APP_ACCESS",
            "timestamp": "2019-10-15T16:07:01.492Z"
          }
        ],
        "alertingTaskGroupRecipientErrors": [
          {
            "added": "2019-10-15T16:07:01.492Z",
            "value": "GROUP_WITH_NO_APP_ACCESS"
          }
        ]
      }
    ]
  },
  "throttling": {
    "capacity": 10,
    "timezone": "Etc/UTC",
    "replenishRate": 1,
    "recurrenceRule": "RRULE:FREQ=DAILY",
    "initialTokenCount": 10,
    "referenceTimestamp": "2021-07-14T10:00:00Z"
  },
  "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": 100,
    "last10Scans": 10,
    "last100Scans": 100
  },
  "hideSelections": true,
  "evaluationCount": 42,
  "scheduleOptions": {
    "timezone": "Canada/Pacific",
    "recurrence": [
      "RRULE:FREQ=HOURLY;INTERVAL=2"
    ],
    "endDateTime": "",
    "chronosJobID": "chronos-job-123",
    "startDateTime": "2006-01-02T16:04:05",
    "lastExecutionTime": "2020-11-20T12:00:55.000Z",
    "nextExecutionTime": "2020-11-20T12:00:55.000Z"
  },
  "subscriptionIds": [
    "string"
  ],
  "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"
}

Returns the details of a specific data alert task.

Facts

Rate limit

Tier 1 (1000 requests per minute)

Path Parameters

alertId string

Required

The alerting task identifier.

Responses

200

Alert has been successfully returned.

application/json object
Show application/json 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 object
  
  Show links properties
  
  self object
  
  Object with Href to a particular element or set of elements
  
  Show self properties
  
  href string
- status string
  
  particular status of the alerting task
  
  Can be one of: "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
  
  Can be one of: "SOURCE_ACCESS""TARGET_ACCESS"
- bookmarkId string
  
  bookmarkId associated to this alert definition
- recipients object
  
  List of recipients. An internal recipient is represented by either their user id or group id.
  
  Show recipients properties
  
  DLUsers array
  
  userIds array of objects
  
  Required
  
  an internal recipient based on its user id.
  
  Show userIds properties
  
  value string
  
  User ID of recipient (internal user).
  
  groups array of strings
  
  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 of objects
  
  Show taskRecipientErrors properties
  
  value string
  
  Identifier for type of error occurring on sharing task specific for recipient
  
  Can be one of: "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"
  
  timestamp string
  
  Timestamp for the creation of the error
  
  alertingTaskRecipientErrors array of objects
  
  Show alertingTaskRecipientErrors properties
  
  added string
  
  Timestamp for the creation of the error
  
  value string
  
  Identifier for type of error occurring on alerting task
  
  Can be one of: "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"
  
  DLGroups array
  
  DLListId string
  
  Identifier of the distribution list the recipients belong to.
  
  groupIds array of objects
  
  an internal recipient based on its group id.
  
  Show groupIds properties
  
  value string
  
  Group ID of recipient.
  
  enabled boolean
  
  Whether this recipient can receive alerts.
  
  taskGroupRecipientErrors array of objects
  
  Show taskGroupRecipientErrors properties
  
  value string
  
  Identifier for type of error occurring on sharing task specific for group recipient
  
  Can be one of: "GROUP_IS_DISABLED""MAX_ALERTS_LIMIT_REACHED""GROUP_WITH_NO_APP_ACCESS""GROUP_IS_DELETED""GROUP_NOT_FOUND_DL""GROUP_DISABLED_IN_DL"
  
  timestamp string
  
  Timestamp for the creation of the error
  
  alertingTaskGroupRecipientErrors array of objects
  
  Show alertingTaskGroupRecipientErrors properties
  
  added string
  
  Timestamp for the creation of the error
  
  value string
  
  Identifier for type of error occurring on alerting task
  
  Can be one of: "GROUP_IS_DISABLED""MAX_ALERTS_LIMIT_REACHED""GROUP_WITH_NO_APP_ACCESS""GROUP_IS_DELETED"
- throttling object
  
  The rules and setup for throttling
  
  Show throttling properties
  
  capacity integer
  
  the maximum number of tokens that the bucket can contain
  
  timezone string
  
  the timezone for time calculations in this throttlingresource, for current time and time reference.
  
  default = "Etc/UTC"
  
  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
- 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
  
  Can be one of: "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
  
  Can be one of: "RELOAD""SCHEDULED""MANUAL"
- triggerStats object
  
  Required
  
  Show triggerStats properties
  
  totalScans integer
  
  Required
  
  The number of scans for the current condition.
  
  maximum = 100
  
  last10Scans integer
  
  Required
  
  The number of triggers out of the last 10 scans for the current condition.
  
  maximum = 10
  
  last100Scans integer
  
  Required
  
  The number of triggers out of the last 100 scans for the current condition.
  
  maximum = 100
- 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 object
  
  Show scheduleOptions properties
  
  timezone string
  
  The timezone for time calculations in SCHEDULED triggers, optional.
  
  recurrence array of strings
  
  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 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.
  
  default = ""
  
  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.
- subscriptionIds array of strings
  
  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 of objects
  
  Show alertingTaskErrors properties
  
  added string
  
  Timestamp for the creation of the error
  
  value string
  
  Identifier for type of error occurring on alerting task
  
  Can be one of: "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"
- absoluteLastTrigger string
  
  last time an execution had been created
- hasHistoryCondition boolean
  
  true if the alert has history condition enabled
- lastExecutionStatus string
  
  Can be one of: "OK""FAILED"
- recipientsChangeHistory array of objects
  
  Change in a recipient for an alerting task
  
  Show recipientsChangeHistory properties
  
  dateTime string
  
  time of recipient state change
  
  patchAction array of objects
  
  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.
  
  Show patchAction properties
  
  op string
  
  Required
  
  The operation to be performed.
  
  Can be one of: "remove""add""replace""enable""disable""subscribe""unsubscribe"
  
  value object
  
  Required
  
  The value to be used for this operation.
  
  recipientType string
  
  Required
  
  Defines the path for the given resource field to patch.
  
  Can be one of: "userid""groupid"
- lastEvaluationCountUpdate string
  
  the date when the evaluation count was updated

400

Bad request, malformed syntax or errors in parameters.

application/json object
Show application/json properties
- errors array of objects
  
  Show errors properties
  
  code string
  
  Error code specific to sharing service.
  
  meta object
  
  Show meta properties
  
  httpCode integer
  
  HTTP error code.
  
  title string
  
  Error title.
  
  detail string
  
  Error cause.
- traceId string

404

Task or execution not found.

application/json object
Show application/json properties
- errors array of objects
  
  Show errors properties
  
  code string
  
  Error code specific to sharing service.
  
  meta object
  
  Show meta properties
  
  httpCode integer
  
  HTTP error code.
  
  title string
  
  Error title.
  
  detail string
  
  Error cause.
- traceId string

500

Internal server error.

application/json object
Show application/json properties
- errors array of objects
  
  Show errors properties
  
  code string
  
  Error code specific to sharing service.
  
  meta object
  
  Show meta properties
  
  httpCode integer
  
  HTTP error code.
  
  title string
  
  Error title.
  
  detail string
  
  Error cause.
- traceId string

default

Error response.

application/json object
Show application/json properties
- errors array of objects
  
  Show errors properties
  
  code string
  
  Error code specific to sharing service.
  
  meta object
  
  Show meta properties
  
  httpCode integer
  
  HTTP error code.
  
  title string
  
  Error title.
  
  detail string
  
  Error cause.
- traceId string

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

import { createQlikApi } from '@qlik/api'

const qlik = createQlikApi({
  hostConfig: {
    host: 'https://{tenant}.{region}.qlikcloud.com',
    apiKey: '<access-token>',
  },
})

await qlik.dataAlerts.getDataAlert('string')

qlik data-alert get 'string'

curl "https://{tenant}.{region}.qlikcloud.com/api/v1/data-alerts/{alertId}" \
-H "Authorization: Bearer <access_token>"

Example Response

{
  "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": {
    "DLUsers": [],
    "userIds": [
      {
        "value": "1b263bs8m0mm_s21s3f",
        "groups": [
          "addedIndividually",
          "group1",
          "group2"
        ],
        "enabled": true,
        "subscribed": true,
        "taskRecipientErrors": [
          {
            "value": "NO_ACCESS_TO_APP",
            "timestamp": "2019-10-15T16:07:01.492Z"
          }
        ],
        "alertingTaskRecipientErrors": [
          {
            "added": "2019-10-15T16:07:01.492Z",
            "value": "NO_ACCESS_TO_APP"
          }
        ]
      }
    ],
    "DLGroups": [],
    "DLListId": "dl-12345",
    "groupIds": [
      {
        "value": "group1",
        "enabled": true,
        "taskGroupRecipientErrors": [
          {
            "value": "GROUP_WITH_NO_APP_ACCESS",
            "timestamp": "2019-10-15T16:07:01.492Z"
          }
        ],
        "alertingTaskGroupRecipientErrors": [
          {
            "added": "2019-10-15T16:07:01.492Z",
            "value": "GROUP_WITH_NO_APP_ACCESS"
          }
        ]
      }
    ]
  },
  "throttling": {
    "capacity": 10,
    "timezone": "Etc/UTC",
    "replenishRate": 1,
    "recurrenceRule": "RRULE:FREQ=DAILY",
    "initialTokenCount": 10,
    "referenceTimestamp": "2021-07-14T10:00:00Z"
  },
  "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": 100,
    "last10Scans": 10,
    "last100Scans": 100
  },
  "hideSelections": true,
  "evaluationCount": 42,
  "scheduleOptions": {
    "timezone": "Canada/Pacific",
    "recurrence": [
      "RRULE:FREQ=HOURLY;INTERVAL=2"
    ],
    "endDateTime": "",
    "chronosJobID": "chronos-job-123",
    "startDateTime": "2006-01-02T16:04:05",
    "lastExecutionTime": "2020-11-20T12:00:55.000Z",
    "nextExecutionTime": "2020-11-20T12:00:55.000Z"
  },
  "subscriptionIds": [
    "string"
  ],
  "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 one or more properties of a specific data alerting task.

Facts

Rate limit

Tier 2 (100 requests per minute)

Path Parameters

alertId string

Required

The alerting task identifier.

Request Body

Required

Patch request definition for an alerting task.

application/json array of objects
Show application/json properties
- op string
  
  Required
  
  The operation to be performed
  
  Can be one of: "replace"
- path string
  
  Required
  
  A JSON Patch document as defined in https://datatracker.ietf.org/doc/html/rfc6902
  
  Can be one of: "/ownerName""/ownerId""/conditionId""/enabledAction""/bookmarkId""/name""/description""/throttling""/triggerType""/scheduleOptions"
- value object
  
  The value to be used for this operation.

Responses

204

The alerting task has been successfully updated.

400

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

application/json object
Show application/json properties
- errors array of objects
  
  Show errors properties
  
  code string
  
  Error code specific to sharing service.
  
  meta object
  
  Show meta properties
  
  httpCode integer
  
  HTTP error code.
  
  title string
  
  Error title.
  
  detail string
  
  Error cause.
- traceId string

404

An alerting task with the specified ID was not found.

application/json object
Show application/json properties
- errors array of objects
  
  Show errors properties
  
  code string
  
  Error code specific to sharing service.
  
  meta object
  
  Show meta properties
  
  httpCode integer
  
  HTTP error code.
  
  title string
  
  Error title.
  
  detail string
  
  Error cause.
- traceId string

500

Internal server error.

application/json object
Show application/json properties
- errors array of objects
  
  Show errors properties
  
  code string
  
  Error code specific to sharing service.
  
  meta object
  
  Show meta properties
  
  httpCode integer
  
  HTTP error code.
  
  title string
  
  Error title.
  
  detail string
  
  Error cause.
- traceId string

default

Error response.

application/json object
Show application/json properties
- errors array of objects
  
  Show errors properties
  
  code string
  
  Error code specific to sharing service.
  
  meta object
  
  Show meta properties
  
  httpCode integer
  
  HTTP error code.
  
  title string
  
  Error title.
  
  detail string
  
  Error cause.
- traceId string

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

import { createQlikApi } from '@qlik/api'

const qlik = createQlikApi({
  hostConfig: {
    host: 'https://{tenant}.{region}.qlikcloud.com',
    apiKey: '<access-token>',
  },
})

await qlik.dataAlerts.patchDataAlert('string', [
  {
    op: 'replace',
    path: '/ownerName',
    value: {},
  },
])

qlik data-alert patch 'string' \
  --op 'replace' \
  --path '/ownerName'

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

Deletes a specific data alerting task.

Facts

Rate limit

Tier 2 (100 requests per minute)

Path Parameters

alertId string

Required

The alerting task identifier.

Responses

204

The alerting task has been successfully deleted.

400

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

application/json object
Show application/json properties
- errors array of objects
  
  Show errors properties
  
  code string
  
  Error code specific to sharing service.
  
  meta object
  
  Show meta properties
  
  httpCode integer
  
  HTTP error code.
  
  title string
  
  Error title.
  
  detail string
  
  Error cause.
- traceId string

404

An alerting task with the specified ID was not found.

application/json object
Show application/json properties
- errors array of objects
  
  Show errors properties
  
  code string
  
  Error code specific to sharing service.
  
  meta object
  
  Show meta properties
  
  httpCode integer
  
  HTTP error code.
  
  title string
  
  Error title.
  
  detail string
  
  Error cause.
- traceId string

500

Internal server error.

application/json object
Show application/json properties
- errors array of objects
  
  Show errors properties
  
  code string
  
  Error code specific to sharing service.
  
  meta object
  
  Show meta properties
  
  httpCode integer
  
  HTTP error code.
  
  title string
  
  Error title.
  
  detail string
  
  Error cause.
- traceId string

default

Error response.

application/json object
Show application/json properties
- errors array of objects
  
  Show errors properties
  
  code string
  
  Error code specific to sharing service.
  
  meta object
  
  Show meta properties
  
  httpCode integer
  
  HTTP error code.
  
  title string
  
  Error title.
  
  detail string
  
  Error cause.
- traceId string

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

import { createQlikApi } from '@qlik/api'

const qlik = createQlikApi({
  hostConfig: {
    host: 'https://{tenant}.{region}.qlikcloud.com',
    apiKey: '<access-token>',
  },
})

await qlik.dataAlerts.deleteDataAlert('string')

qlik data-alert rm 'string'

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

Retrieves the condition associated with a data alerting task.

Facts

Rate limit

Tier 1 (1000 requests per minute)

Path Parameters

alertId string

Required

The alerting task identifier.

Responses

200

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

application/json object
Show application/json properties
- hideSelections boolean
- conditionResponse object
  
  Should reference ConditionResponse type in condition-manager api docs

400

Bad request, malformed syntax or errors in parameters.

application/json object
Show application/json properties
- errors array of objects
  
  Show errors properties
  
  code string
  
  Error code specific to sharing service.
  
  meta object
  
  Show meta properties
  
  httpCode integer
  
  HTTP error code.
  
  title string
  
  Error title.
  
  detail string
  
  Error cause.
- traceId string

404

Task or condition not found.

application/json object
Show application/json properties
- errors array of objects
  
  Show errors properties
  
  code string
  
  Error code specific to sharing service.
  
  meta object
  
  Show meta properties
  
  httpCode integer
  
  HTTP error code.
  
  title string
  
  Error title.
  
  detail string
  
  Error cause.
- traceId string

500

Internal server error.

application/json object
Show application/json properties
- errors array of objects
  
  Show errors properties
  
  code string
  
  Error code specific to sharing service.
  
  meta object
  
  Show meta properties
  
  httpCode integer
  
  HTTP error code.
  
  title string
  
  Error title.
  
  detail string
  
  Error cause.
- traceId string

default

Error response.

application/json object
Show application/json properties
- errors array of objects
  
  Show errors properties
  
  code string
  
  Error code specific to sharing service.
  
  meta object
  
  Show meta properties
  
  httpCode integer
  
  HTTP error code.
  
  title string
  
  Error title.
  
  detail string
  
  Error cause.
- traceId string

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

import { createQlikApi } from '@qlik/api'

const qlik = createQlikApi({
  hostConfig: {
    host: 'https://{tenant}.{region}.qlikcloud.com',
    apiKey: '<access-token>',
  },
})

await qlik.dataAlerts.getDataAlertCondition(
  'string',
)

qlik data-alert condition 'string'

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

Example Response

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

Retrieves a specific execution for the specified data alerting task.

Facts

Rate limit

Tier 1 (1000 requests per minute)

Path Parameters

alertId string

Required

The alerting task identifier.
executionId string

Required

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

Responses

200

The execution has been successfully returned.

application/json object
Show application/json properties
- id string
  
  Gets the execution identifier.
- errors array of objects
  
  Show errors properties
  
  code string
  
  Error code specific to sharing service.
  
  title string
  
  Error title.
  
  detail string
  
  Error cause.
- result object
  
  Show result properties
  
  alertTriggerStatus string
  
  throttlerTokensLeft integer
- alertId string
  
  ID for the alerting task that this execution references
- ownerId string
  
  The owner that this execution belongs to
- measures array of strings
  
  Measures applied in the condition
- tenantId string
  
  The tenant that this execution belongs to
- accessMode string
  
  Can be one of: "SOURCE_ACCESS""TARGET_ACCESS"
- bookmarkId string
  
  Id of the bookmark associated with an alert
- dimensions array of strings
  
  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
  
  Can be one of: "INDIVIDUAL""SHARED"
- conditionStatus string
  
  Can be one of: "FINISHED""FAILED"
- executionEvaluationStatus string
  
  Can be one of: "CONDITION_MET""CONDITION_NOT_MET""FAILED"
- links object
  
  Show links properties
  
  self object
  
  Object with Href to a particular element or set of elements
  
  Show self properties
  
  href string
- evaluation object
  
  Show evaluation properties
  
  id string
  
  The unique id for the resource
  
  format = "uid"
  
  result string
  
  The final result of the evalution
  
  Can be one of: "success""failure""error"
  
  status string
  
  The status of the evaluation execution
  
  Can be one of: "RUNNING""FAILED""FINISHED"
  
  endTime string
  
  The time the evaluation ended
  
  format = "string"
  
  ownerId string
  
  userId of user being impersonated to evaluate the condition
  
  format = "uid"
  
  tenantId string
  
  The tenant id
  
  format = "uid"
  
  contextId string
  
  Extra context information to carry through to the result if one was included on when the evaluation was triggered
  
  startTime string
  
  The time the evaluation started
  
  format = "string"
  
  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
  
  The unique id of the associated condition
  
  format = "uid"
  
  dataConditionEvaluatorId string
  
  The unique id for the resource given from Data Condition Evaluator
  
  format = "uid"

400

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

application/json object
Show application/json properties
- errors array of objects
  
  Show errors properties
  
  code string
  
  Error code specific to sharing service.
  
  meta object
  
  Show meta properties
  
  httpCode integer
  
  HTTP error code.
  
  title string
  
  Error title.
  
  detail string
  
  Error cause.
- traceId string

404

Task or execution not found.

application/json object
Show application/json properties
- errors array of objects
  
  Show errors properties
  
  code string
  
  Error code specific to sharing service.
  
  meta object
  
  Show meta properties
  
  httpCode integer
  
  HTTP error code.
  
  title string
  
  Error title.
  
  detail string
  
  Error cause.
- traceId string

500

Internal server error.

application/json object
Show application/json properties
- errors array of objects
  
  Show errors properties
  
  code string
  
  Error code specific to sharing service.
  
  meta object
  
  Show meta properties
  
  httpCode integer
  
  HTTP error code.
  
  title string
  
  Error title.
  
  detail string
  
  Error cause.
- traceId string

default

Error response.

application/json object
Show application/json properties
- errors array of objects
  
  Show errors properties
  
  code string
  
  Error code specific to sharing service.
  
  meta object
  
  Show meta properties
  
  httpCode integer
  
  HTTP error code.
  
  title string
  
  Error title.
  
  detail string
  
  Error cause.
- traceId string

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

import { createQlikApi } from '@qlik/api'

const qlik = createQlikApi({
  hostConfig: {
    host: 'https://{tenant}.{region}.qlikcloud.com',
    apiKey: '<access-token>',
  },
})

await qlik.dataAlerts.getDataAlertExecution(
  'string',
  'string',
)

qlik data-alert execution get 'string' \
  --data-alertId 'string'

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

Example Response

{
  "id": "string",
  "errors": [
    {
      "code": "string",
      "title": "string",
      "detail": "string"
    }
  ],
  "result": {
    "alertTriggerStatus": "alertSent",
    "throttlerTokensLeft": 5
  },
  "alertId": "string",
  "ownerId": "string",
  "measures": [
    "string"
  ],
  "tenantId": "string",
  "accessMode": "SOURCE_ACCESS",
  "bookmarkId": "string",
  "dimensions": [
    "string"
  ],
  "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": "TiQ8GPVr8qI714Lp5ChAAFFaU24MJy69",
    "result": "success",
    "status": "RUNNING",
    "endTime": "string",
    "ownerId": "TiQ8GPVr8qI714Lp5ChAAFFaU24MJy69",
    "tenantId": "TiQ8GPVr8qI714Lp5ChAAFFaU24MJy69",
    "contextId": "string",
    "startTime": "string",
    "resultData": {},
    "causalEvent": {},
    "conditionId": "TiQ8GPVr8qI714Lp5ChAAFFaU24MJy69",
    "dataConditionEvaluatorId": "TiQ8GPVr8qI714Lp5ChAAFFaU24MJy69"
  }
}

Deletes a specific data alerting task execution.

Facts

Rate limit

Tier 2 (100 requests per minute)

Path Parameters

alertId string

Required

The alerting task identifier.
executionId string

Required

The execution identifier.

Responses

204

The execution has been successfully deleted.

400

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

application/json object
Show application/json properties
- errors array of objects
  
  Show errors properties
  
  code string
  
  Error code specific to sharing service.
  
  meta object
  
  Show meta properties
  
  httpCode integer
  
  HTTP error code.
  
  title string
  
  Error title.
  
  detail string
  
  Error cause.
- traceId string

404

Task or execution not found.

application/json object
Show application/json properties
- errors array of objects
  
  Show errors properties
  
  code string
  
  Error code specific to sharing service.
  
  meta object
  
  Show meta properties
  
  httpCode integer
  
  HTTP error code.
  
  title string
  
  Error title.
  
  detail string
  
  Error cause.
- traceId string

500

Internal server error.

application/json object
Show application/json properties
- errors array of objects
  
  Show errors properties
  
  code string
  
  Error code specific to sharing service.
  
  meta object
  
  Show meta properties
  
  httpCode integer
  
  HTTP error code.
  
  title string
  
  Error title.
  
  detail string
  
  Error cause.
- traceId string

default

Error response.

application/json object
Show application/json properties
- errors array of objects
  
  Show errors properties
  
  code string
  
  Error code specific to sharing service.
  
  meta object
  
  Show meta properties
  
  httpCode integer
  
  HTTP error code.
  
  title string
  
  Error title.
  
  detail string
  
  Error cause.
- traceId string

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

import { createQlikApi } from '@qlik/api'

const qlik = createQlikApi({
  hostConfig: {
    host: 'https://{tenant}.{region}.qlikcloud.com',
    apiKey: '<access-token>',
  },
})

await qlik.dataAlerts.deleteDataAlertExecution(
  'string',
  'string',
)

qlik data-alert execution rm 'string' \
  --data-alertId 'string'

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

Retrieve the recipient stats for a data alerting task.

Facts

Rate limit

Tier 1 (1000 requests per minute)

Query Parameters

groups array of strings

The name of the groups you would like to filter by
sort array of strings

Sort the returned result set by the specified field

Values may be any of: "+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

Path Parameters

alertId string

Required

The alerting task identifier.

Responses

200

Alert recipient stats have been successfully returned.

application/json object
Show application/json properties
- recipientStats array of objects
  
  Show recipientStats properties
  
  type string
  
  Can be one of: "userid"
  
  value string
  
  errors array of objects
  
  Show errors properties
  
  code string
  
  Error code specific to sharing service.
  
  title string
  
  Error title.
  
  detail string
  
  Error cause.
  
  groups array of strings
  
  A list of associated groups. If a user is added individually the "addedIndividually" pseudo group is included
  
  enabled boolean
  
  Required
  
  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
  
  Can be one of: "OK""FAILED"

400

Bad request, malformed syntax or errors in parameters.

application/json object
Show application/json properties
- errors array of objects
  
  Show errors properties
  
  code string
  
  Error code specific to sharing service.
  
  meta object
  
  Show meta properties
  
  httpCode integer
  
  HTTP error code.
  
  title string
  
  Error title.
  
  detail string
  
  Error cause.
- traceId string

404

Task or execution not found.

application/json object
Show application/json properties
- errors array of objects
  
  Show errors properties
  
  code string
  
  Error code specific to sharing service.
  
  meta object
  
  Show meta properties
  
  httpCode integer
  
  HTTP error code.
  
  title string
  
  Error title.
  
  detail string
  
  Error cause.
- traceId string

500

Internal server error.

application/json object
Show application/json properties
- errors array of objects
  
  Show errors properties
  
  code string
  
  Error code specific to sharing service.
  
  meta object
  
  Show meta properties
  
  httpCode integer
  
  HTTP error code.
  
  title string
  
  Error title.
  
  detail string
  
  Error cause.
- traceId string

default

Error response.

application/json object
Show application/json properties
- errors array of objects
  
  Show errors properties
  
  code string
  
  Error code specific to sharing service.
  
  meta object
  
  Show meta properties
  
  httpCode integer
  
  HTTP error code.
  
  title string
  
  Error title.
  
  detail string
  
  Error cause.
- traceId string

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

import { createQlikApi } from '@qlik/api'

const qlik = createQlikApi({
  hostConfig: {
    host: 'https://{tenant}.{region}.qlikcloud.com',
    apiKey: '<access-token>',
  },
})

await qlik.dataAlerts.getDataAlertRecipientStats(
  'string',
  {},
)

qlik data-alert recipient-stat 'string'

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

Example Response

{
  "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 executions for the specified data alerting task.

Facts

Rate limit

Tier 1 (1000 requests per minute)

Query Parameters

conditionId string

Filter by condition id related to the executions.
conditionStatus string

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

Can be one of: "FINISHED""FAILED""ALL"
daysOfMonth array of integers

Specifies required days of the month that the execution was created in
daysOfWeek array of strings

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

Values may be any of: "MONDAY""TUESDAY""WEDNESDAY""THURSDAY""FRIDAY""SATURDAY""SUNDAY"
fields array of strings

Specifies specific properties to be populated

Values may be any of: "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 integer

Limit the returned result set

minimum = 1, maximum = 100, default = 20, default = 20
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

minimum = 0, default = 0, default = 0
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 of strings

Sort the returned result set by the specified field

Values may be any of: "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

Path Parameters

taskId string

Required

The alerting task identifier.

Responses

200

The alerting-executions list has been successfully returned.

application/json object

properties that should be added to every list response
Show application/json properties
- totalCount integer
  
  Required
  
  total count of entries in the collection as a whole
- currentPageCount integer
  
  Required
  
  count of entries on the currently shown page
- links object
  
  Show links properties
  
  next object
  
  Show next properties
  
  href string
  
  URL to particular set of elements
  
  type string
  
  Page type, can be next or prev
  
  Can be one of: "prev""next"
  
  token string
  
  Page unique token
  
  prev object
  
  Show prev properties
  
  href string
  
  URL to particular set of elements
  
  type string
  
  Page type, can be next or prev
  
  Can be one of: "prev""next"
  
  token string
  
  Page unique token
  
  self object
  
  Object with Href to a particular element or set of elements
  
  Show self properties
  
  href string
- executions array of objects
  
  Gets a list of alerting-executions.
  
  Show executions properties
  
  id string
  
  Gets the execution identifier.
  
  errors array of objects
  
  Show errors properties
  
  code string
  
  Error code specific to sharing service.
  
  title string
  
  Error title.
  
  detail string
  
  Error cause.
  
  result object
  
  Show result properties
  
  alertTriggerStatus string
  
  throttlerTokensLeft integer
  
  alertId string
  
  ID for the alerting task that this execution references
  
  ownerId string
  
  The owner that this execution belongs to
  
  measures array of strings
  
  Measures applied in the condition
  
  tenantId string
  
  The tenant that this execution belongs to
  
  accessMode string
  
  Can be one of: "SOURCE_ACCESS""TARGET_ACCESS"
  
  bookmarkId string
  
  Id of the bookmark associated with an alert
  
  dimensions array of strings
  
  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
  
  Can be one of: "INDIVIDUAL""SHARED"
  
  conditionStatus string
  
  Can be one of: "FINISHED""FAILED"
  
  executionEvaluationStatus string
  
  Can be one of: "CONDITION_MET""CONDITION_NOT_MET""FAILED"
  
  links object
  
  Show links properties
  
  self object
  
  Object with Href to a particular element or set of elements
  
  Show self properties
  
  href string
  
  evaluation object
  
  Show evaluation properties
  
  id string
  
  The unique id for the resource
  
  format = "uid"
  
  result string
  
  The final result of the evalution
  
  Can be one of: "success""failure""error"
  
  status string
  
  The status of the evaluation execution
  
  Can be one of: "RUNNING""FAILED""FINISHED"
  
  endTime string
  
  The time the evaluation ended
  
  format = "string"
  
  ownerId string
  
  userId of user being impersonated to evaluate the condition
  
  format = "uid"
  
  tenantId string
  
  The tenant id
  
  format = "uid"
  
  contextId string
  
  Extra context information to carry through to the result if one was included on when the evaluation was triggered
  
  startTime string
  
  The time the evaluation started
  
  format = "string"
  
  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
  
  The unique id of the associated condition
  
  format = "uid"
  
  dataConditionEvaluatorId string
  
  The unique id for the resource given from Data Condition Evaluator
  
  format = "uid"

400

Bad request, malformed syntax or errors in parameters.

application/json object
Show application/json properties
- errors array of objects
  
  Show errors properties
  
  code string
  
  Error code specific to sharing service.
  
  meta object
  
  Show meta properties
  
  httpCode integer
  
  HTTP error code.
  
  title string
  
  Error title.
  
  detail string
  
  Error cause.
- traceId string

404

Task or execution not found.

application/json object
Show application/json properties
- errors array of objects
  
  Show errors properties
  
  code string
  
  Error code specific to sharing service.
  
  meta object
  
  Show meta properties
  
  httpCode integer
  
  HTTP error code.
  
  title string
  
  Error title.
  
  detail string
  
  Error cause.
- traceId string

500

Internal server error.

application/json object
Show application/json properties
- errors array of objects
  
  Show errors properties
  
  code string
  
  Error code specific to sharing service.
  
  meta object
  
  Show meta properties
  
  httpCode integer
  
  HTTP error code.
  
  title string
  
  Error title.
  
  detail string
  
  Error cause.
- traceId string

default

Error response.

application/json object
Show application/json properties
- errors array of objects
  
  Show errors properties
  
  code string
  
  Error code specific to sharing service.
  
  meta object
  
  Show meta properties
  
  httpCode integer
  
  HTTP error code.
  
  title string
  
  Error title.
  
  detail string
  
  Error cause.
- traceId string

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

import { createQlikApi } from '@qlik/api'

const qlik = createQlikApi({
  hostConfig: {
    host: 'https://{tenant}.{region}.qlikcloud.com',
    apiKey: '<access-token>',
  },
})

await qlik.dataAlerts.getDataAlertExecutions(
  'string',
  {},
)

qlik data-alert execution ls \
  --data-alertId 'string'

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

Example Response

{
  "totalCount": 42,
  "currentPageCount": 42,
  "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": [
        "string"
      ],
      "tenantId": "string",
      "accessMode": "SOURCE_ACCESS",
      "bookmarkId": "string",
      "dimensions": [
        "string"
      ],
      "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": "TiQ8GPVr8qI714Lp5ChAAFFaU24MJy69",
        "result": "success",
        "status": "RUNNING",
        "endTime": "string",
        "ownerId": "TiQ8GPVr8qI714Lp5ChAAFFaU24MJy69",
        "tenantId": "TiQ8GPVr8qI714Lp5ChAAFFaU24MJy69",
        "contextId": "string",
        "startTime": "string",
        "resultData": {},
        "causalEvent": {},
        "conditionId": "TiQ8GPVr8qI714Lp5ChAAFFaU24MJy69",
        "dataConditionEvaluatorId": "TiQ8GPVr8qI714Lp5ChAAFFaU24MJy69"
      }
    }
  ]
}

Retrieves the content of an evaluation for a specified data alerting task execution.

Facts

Rate limit

Tier 1 (1000 requests per minute)

Path Parameters

executionId string

Required

The execution identifier.
taskId string

Required

The alerting task identifier.

Responses

200

Evaluation successfully returned.

application/json object
Show application/json properties
- condition object
- evaluation object
  
  Show evaluation properties
  
  id string
  
  The unique id for the resource
  
  format = "uid"
  
  result string
  
  The final result of the evalution
  
  Can be one of: "success""failure""error"
  
  status string
  
  The status of the evaluation execution
  
  Can be one of: "RUNNING""FAILED""FINISHED"
  
  endTime string
  
  The time the evaluation ended
  
  format = "string"
  
  ownerId string
  
  userId of user being impersonated to evaluate the condition
  
  format = "uid"
  
  tenantId string
  
  The tenant id
  
  format = "uid"
  
  contextId string
  
  Extra context information to carry through to the result if one was included on when the evaluation was triggered
  
  startTime string
  
  The time the evaluation started
  
  format = "string"
  
  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
  
  The unique id of the associated condition
  
  format = "uid"
  
  dataConditionEvaluatorId string
  
  The unique id for the resource given from Data Condition Evaluator
  
  format = "uid"
- hideSelections boolean

404

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

application/json object
Show application/json properties
- errors array of objects
  
  Show errors properties
  
  code string
  
  Error code specific to sharing service.
  
  meta object
  
  Show meta properties
  
  httpCode integer
  
  HTTP error code.
  
  title string
  
  Error title.
  
  detail string
  
  Error cause.
- traceId string

500

Internal server error.

application/json object
Show application/json properties
- errors array of objects
  
  Show errors properties
  
  code string
  
  Error code specific to sharing service.
  
  meta object
  
  Show meta properties
  
  httpCode integer
  
  HTTP error code.
  
  title string
  
  Error title.
  
  detail string
  
  Error cause.
- traceId string

default

Error response.

application/json object
Show application/json properties
- errors array of objects
  
  Show errors properties
  
  code string
  
  Error code specific to sharing service.
  
  meta object
  
  Show meta properties
  
  httpCode integer
  
  HTTP error code.
  
  title string
  
  Error title.
  
  detail string
  
  Error cause.
- traceId string

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

import { createQlikApi } from '@qlik/api'

const qlik = createQlikApi({
  hostConfig: {
    host: 'https://{tenant}.{region}.qlikcloud.com',
    apiKey: '<access-token>',
  },
})

await qlik.dataAlerts.getDataAlertExecutionEvaluations(
  'string',
  'string',
)

qlik data-alert execution evaluations \
  --data-alertId 'string' \
  --executionId 'string'

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

Example Response

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

Retrieves stats for overall data alerting task executions.

Facts

	Rate limit	Tier 1 (1000 requests per minute)
	Deprecated	This endpoint is deprecated and will eventually be removed. Read our API policy here.

Query Parameters

period string

Required

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

Can be one of: "month"

Path Parameters

taskId string

Required

The alerting task identifier.

Responses

200

Evaluation successfully returned.

application/json object Deprecated

properties that should be added to every list response
Show application/json properties
- totalCount integer
  
  Required
  
  total count of entries in the collection as a whole
- currentPageCount integer
  
  Required
  
  count of entries on the currently shown page
- links object
  
  Show links properties
  
  next object
  
  Show next properties
  
  href string
  
  URL to particular set of elements
  
  type string
  
  Page type, can be next or prev
  
  Can be one of: "prev""next"
  
  token string
  
  Page unique token
  
  prev object
  
  Show prev properties
  
  href string
  
  URL to particular set of elements
  
  type string
  
  Page type, can be next or prev
  
  Can be one of: "prev""next"
  
  token string
  
  Page unique token
  
  self object
  
  Object with Href to a particular element or set of elements
  
  Show self properties
  
  href string
- executionsStats array of objects
  
  Show executionsStats properties
  
  endTime string
  
  periodKey string
  
  startTime string
  
  totalExecutions string
  
  triggeredExecutions string

404

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

application/json object
Show application/json properties
- errors array of objects
  
  Show errors properties
  
  code string
  
  Error code specific to sharing service.
  
  meta object
  
  Show meta properties
  
  httpCode integer
  
  HTTP error code.
  
  title string
  
  Error title.
  
  detail string
  
  Error cause.
- traceId string

500

Internal server error.

application/json object
Show application/json properties
- errors array of objects
  
  Show errors properties
  
  code string
  
  Error code specific to sharing service.
  
  meta object
  
  Show meta properties
  
  httpCode integer
  
  HTTP error code.
  
  title string
  
  Error title.
  
  detail string
  
  Error cause.
- traceId string

default

Error response.

application/json object
Show application/json properties
- errors array of objects
  
  Show errors properties
  
  code string
  
  Error code specific to sharing service.
  
  meta object
  
  Show meta properties
  
  httpCode integer
  
  HTTP error code.
  
  title string
  
  Error title.
  
  detail string
  
  Error cause.
- traceId string

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

import { createQlikApi } from '@qlik/api'

const qlik = createQlikApi({
  hostConfig: {
    host: 'https://{tenant}.{region}.qlikcloud.com',
    apiKey: '<access-token>',
  },
})

await qlik.dataAlerts.getDataAlertExecutionsStats(
  'string',
  { period: 'month' },
)

# qlik-cli has not implemented support for GET /api/v1/data-alerts/{taskId}/executions/stats yet.

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

Example Response

{
  "totalCount": 42,
  "currentPageCount": 42,
  "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 data alerting task trigger action.

Facts

Rate limit

Tier 2 (100 requests per minute)

Request Body

Required

The alerting trigger action create request definition.

application/json object
Show application/json properties
- alertingTaskID string
  
  Required
  
  Identifier of the alerting task to trigger.

Responses

202

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

application/json object
Show application/json properties
- workflowID string
  
  the workflow id created for the manual triggering of alert

400

Bad request, malformed syntax or errors in parameters.

application/json object
Show application/json properties
- errors array of objects
  
  Show errors properties
  
  code string
  
  Error code specific to sharing service.
  
  meta object
  
  Show meta properties
  
  httpCode integer
  
  HTTP error code.
  
  title string
  
  Error title.
  
  detail string
  
  Error cause.
- traceId string

500

Internal server error.

application/json object
Show application/json properties
- errors array of objects
  
  Show errors properties
  
  code string
  
  Error code specific to sharing service.
  
  meta object
  
  Show meta properties
  
  httpCode integer
  
  HTTP error code.
  
  title string
  
  Error title.
  
  detail string
  
  Error cause.
- traceId string

default

Error response.

application/json object
Show application/json properties
- errors array of objects
  
  Show errors properties
  
  code string
  
  Error code specific to sharing service.
  
  meta object
  
  Show meta properties
  
  httpCode integer
  
  HTTP error code.
  
  title string
  
  Error title.
  
  detail string
  
  Error cause.
- traceId string

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

import { createQlikApi } from '@qlik/api'

const qlik = createQlikApi({
  hostConfig: {
    host: 'https://{tenant}.{region}.qlikcloud.com',
    apiKey: '<access-token>',
  },
})

await qlik.dataAlerts.triggerDataAlerts({
  alertingTaskID: 'a1b2c3d4f5',
})

qlik data-alert trigger \
  --alertingTaskID 'a1b2c3d4f5'

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

Example Response

{
  "workflowID": "a1b2c3d4f5"
}

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

Facts

Rate limit

Tier 2 (100 requests per minute)

Request Body

Required

The alerting validate action validates a new alerting task.

application/json object

a alerting task (a definition on an alert)
Show application/json properties
- name string
  
  Required
  
  name associated to alerting task
  
  maxLength = 78
- appId string
  
  Required
  
  appId associated to this alert definition
- enabled boolean
  
  if the alerting task is enabled
  
  default = true
- sheetId string
  
  sheetId associated to this alert definition
- bookmarkId string
  
  bookmarkId associated to this alert definition
- recipients object
  
  Required
  
  List of recipients. An internal recipient is represented by either their user id or group id.
  
  Show recipients properties
  
  DLUsers array
  
  userIds array of objects
  
  Required
  
  an internal recipient based on its user id.
  
  Show userIds properties
  
  value string
  
  User ID of recipient (internal user).
  
  groups array of strings
  
  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 of objects
  
  Show taskRecipientErrors properties
  
  value string
  
  Identifier for type of error occurring on sharing task specific for recipient
  
  Can be one of: "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"
  
  timestamp string
  
  Timestamp for the creation of the error
  
  alertingTaskRecipientErrors array of objects
  
  Show alertingTaskRecipientErrors properties
  
  added string
  
  Timestamp for the creation of the error
  
  value string
  
  Identifier for type of error occurring on alerting task
  
  Can be one of: "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"
  
  DLGroups array
  
  DLListId string
  
  Identifier of the distribution list the recipients belong to.
  
  groupIds array of objects
  
  an internal recipient based on its group id.
  
  Show groupIds properties
  
  value string
  
  Group ID of recipient.
  
  enabled boolean
  
  Whether this recipient can receive alerts.
  
  taskGroupRecipientErrors array of objects
  
  Show taskGroupRecipientErrors properties
  
  value string
  
  Identifier for type of error occurring on sharing task specific for group recipient
  
  Can be one of: "GROUP_IS_DISABLED""MAX_ALERTS_LIMIT_REACHED""GROUP_WITH_NO_APP_ACCESS""GROUP_IS_DELETED""GROUP_NOT_FOUND_DL""GROUP_DISABLED_IN_DL"
  
  timestamp string
  
  Timestamp for the creation of the error
  
  alertingTaskGroupRecipientErrors array of objects
  
  Show alertingTaskGroupRecipientErrors properties
  
  added string
  
  Timestamp for the creation of the error
  
  value string
  
  Identifier for type of error occurring on alerting task
  
  Can be one of: "GROUP_IS_DISABLED""MAX_ALERTS_LIMIT_REACHED""GROUP_WITH_NO_APP_ACCESS""GROUP_IS_DELETED"
- throttling object
  
  The rules and setup for throttling
  
  Show throttling properties
  
  capacity integer
  
  the maximum number of tokens that the bucket can contain
  
  timezone string
  
  the timezone for time calculations in this throttlingresource, for current time and time reference.
  
  default = "Etc/UTC"
  
  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
- conditionId string
  
  Required
  
  the id of the condition that determines if this data alert should be triggered
- description string
  
  description associated to alerting task
  
  maxLength = 255
- triggerType string
  
  Required
  
  Type of job that triggered the task
  
  Can be one of: "RELOAD""SCHEDULED"
- scheduleOptions object
  
  Show scheduleOptions properties
  
  timezone string
  
  The timezone for time calculations in SCHEDULED triggers, optional.
  
  recurrence array of strings
  
  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 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.
  
  default = ""
  
  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.

Responses

200

Alerting task has been validated successfully.

application/json object
Show application/json properties
- status string
  
  Can be one of: "FAILURE""SUCCESS"
- validations array of objects
  
  Show validations properties
  
  id string
  
  Identifies for user id or condition id
  
  type string
  
  Identifier for type of a validation error occurring on alerting task
  
  Can be one of: "RECIPIENT""CONDITION""RECIPIENT_GROUP"
  
  error string Deprecated
  
  Identifier for a validation error occurring on alerting task
  
  Can be one of: "NO_ACCESS""USER_IS_DISABLED""INVALID_CONDITION""GROUP_IS_DISABLED""GROUP_SIZE_EXCEEDED"
  
  description string
  
  Description of the error
  
  validationErrors array of strings
  
  Values may be any of: "NO_ACCESS""USER_IS_DISABLED""INVALID_CONDITION""MAX_ALERTS_LIMIT_REACHED""MAX_ALERT_RECIPIENTS_LIMIT_REACHED""GROUP_IS_DISABLED""GROUP_SIZE_EXCEEDED"

400

Bad request, malformed syntax or errors in parameters.

application/json object
Show application/json properties
- errors array of objects
  
  Show errors properties
  
  code string
  
  Error code specific to sharing service.
  
  meta object
  
  Show meta properties
  
  httpCode integer
  
  HTTP error code.
  
  title string
  
  Error title.
  
  detail string
  
  Error cause.
- traceId string

500

Internal server error.

application/json object
Show application/json properties
- errors array of objects
  
  Show errors properties
  
  code string
  
  Error code specific to sharing service.
  
  meta object
  
  Show meta properties
  
  httpCode integer
  
  HTTP error code.
  
  title string
  
  Error title.
  
  detail string
  
  Error cause.
- traceId string

default

Error response.

application/json object
Show application/json properties
- errors array of objects
  
  Show errors properties
  
  code string
  
  Error code specific to sharing service.
  
  meta object
  
  Show meta properties
  
  httpCode integer
  
  HTTP error code.
  
  title string
  
  Error title.
  
  detail string
  
  Error cause.
- traceId string

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

import { createQlikApi } from '@qlik/api'

const qlik = createQlikApi({
  hostConfig: {
    host: 'https://{tenant}.{region}.qlikcloud.com',
    apiKey: '<access-token>',
  },
})

await qlik.dataAlerts.validateDataAlerts({
  appId: 'e0e3187e-4f8c-4c1f-9d2a-1234567890ab',
  bookmarkId: 'def-456',
  conditionId: 'cond-789',
  description:
    'Notifies when sales drop below target.',
  enabled: true,
  name: 'Sales threshold alert',
  recipients: {
    DLListId: 'dl-12345',
    groupIds: [
      {
        alertingTaskGroupRecipientErrors: [
          {
            added: '2019-10-15T16:07:01.492Z',
            value: 'GROUP_WITH_NO_APP_ACCESS',
          },
        ],
        enabled: true,
        taskGroupRecipientErrors: [
          {
            value: 'GROUP_WITH_NO_APP_ACCESS',
            timestamp: '2019-10-15T16:07:01.492Z',
          },
        ],
        value: 'group1',
      },
    ],
    userIds: [
      {
        alertingTaskRecipientErrors: [
          {
            added: '2019-10-15T16:07:01.492Z',
            value: 'NO_ACCESS_TO_APP',
          },
        ],
        enabled: true,
        groups: [
          'addedIndividually',

          'group1',

          'group2',
        ],
        subscribed: true,
        taskRecipientErrors: [
          {
            value: 'NO_ACCESS_TO_APP',
            timestamp: '2019-10-15T16:07:01.492Z',
          },
        ],
        value: '1b263bs8m0mm_s21s3f',
      },
    ],
  },
  scheduleOptions: {
    recurrence: ['RRULE:FREQ=HOURLY;INTERVAL=2'],
    startDateTime: '2006-01-02T16:04:05',
    timezone: 'Canada/Pacific',
  },
  sheetId: 'abcABC1',
  throttling: {
    capacity: 10,
    initialTokenCount: 10,
    recurrenceRule: 'RRULE:FREQ=DAILY',
    referenceTimestamp: '2021-07-14T10:00:00Z',
    replenishRate: 1,
    timezone: 'Etc/UTC',
  },
  triggerType: 'SCHEDULED',
})

qlik data-alert validate \
  --appId 'e0e3187e-4f8c-4c1f-9d2a-1234567890ab' \
  --conditionId 'cond-789' \
  --name 'Sales threshold alert' \
  --recipients-DLListId 'dl-12345' \
  --recipients-groupIds-alertingTaskGroupRecipientErrors-added '' \
  --recipients-groupIds-alertingTaskGroupRecipientErrors-value '' \
  --recipients-groupIds-enabled  \
  --recipients-groupIds-taskGroupRecipientErrors-timestamp '' \
  --recipients-groupIds-taskGroupRecipientErrors-value '' \
  --recipients-groupIds-value '' \
  --recipients-userIds-alertingTaskRecipientErrors-added '' \
  --recipients-userIds-alertingTaskRecipientErrors-value '' \
  --recipients-userIds-enabled  \
  --recipients-userIds-groups '' \
  --recipients-userIds-subscribed  \
  --recipients-userIds-taskRecipientErrors-timestamp '' \
  --recipients-userIds-taskRecipientErrors-value '' \
  --recipients-userIds-value '' \
  --triggerType 'SCHEDULED'

curl "https://{tenant}.{region}.qlikcloud.com/api/v1/data-alerts/actions/validate" \
-X POST \
-H "Content-type: application/json" \
-H "Authorization: Bearer <access_token>" \
-d '{"name":"Sales threshold alert","appId":"e0e3187e-4f8c-4c1f-9d2a-1234567890ab","enabled":true,"sheetId":"abcABC1","bookmarkId":"def-456","recipients":{"DLUsers":[],"userIds":[{"value":"1b263bs8m0mm_s21s3f","groups":["addedIndividually","group1","group2"],"enabled":true,"subscribed":true,"taskRecipientErrors":[{"value":"NO_ACCESS_TO_APP","timestamp":"2019-10-15T16:07:01.492Z"}],"alertingTaskRecipientErrors":[{"added":"2019-10-15T16:07:01.492Z","value":"NO_ACCESS_TO_APP"}]}],"DLGroups":[],"DLListId":"dl-12345","groupIds":[{"value":"group1","enabled":true,"taskGroupRecipientErrors":[{"value":"GROUP_WITH_NO_APP_ACCESS","timestamp":"2019-10-15T16:07:01.492Z"}],"alertingTaskGroupRecipientErrors":[{"added":"2019-10-15T16:07:01.492Z","value":"GROUP_WITH_NO_APP_ACCESS"}]}]},"throttling":{"capacity":10,"timezone":"Etc/UTC","replenishRate":1,"recurrenceRule":"RRULE:FREQ=DAILY","initialTokenCount":10,"referenceTimestamp":"2021-07-14T10:00:00Z"},"conditionId":"cond-789","description":"Notifies when sales drop below target.","triggerType":"SCHEDULED","scheduleOptions":{"timezone":"Canada/Pacific","recurrence":["RRULE:FREQ=HOURLY;INTERVAL=2"],"endDateTime":"","startDateTime":"2006-01-02T16:04:05"}}'

Example Response

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

Retrieves the current settings for data alerts.

Facts

Rate limit

Tier 1 (1000 requests per minute)

Responses

200

The alerting settings have been successfully returned

application/json object
Show application/json 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 boolean
  
  Required
  
  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.
  
  Can be one of: "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
  
  Can be one of: "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.

500

Internal server error.

application/json object
Show application/json properties
- errors array of objects
  
  Show errors properties
  
  code string
  
  Error code specific to sharing service.
  
  meta object
  
  Show meta properties
  
  httpCode integer
  
  HTTP error code.
  
  title string
  
  Error title.
  
  detail string
  
  Error cause.
- traceId string

default

Error response.

application/json object
Show application/json properties
- errors array of objects
  
  Show errors properties
  
  code string
  
  Error code specific to sharing service.
  
  meta object
  
  Show meta properties
  
  httpCode integer
  
  HTTP error code.
  
  title string
  
  Error title.
  
  detail string
  
  Error cause.
- traceId string

GET /api/v1/data-alerts/settings

import { createQlikApi } from '@qlik/api'

const qlik = createQlikApi({
  hostConfig: {
    host: 'https://{tenant}.{region}.qlikcloud.com',
    apiKey: '<access-token>',
  },
})

await qlik.dataAlerts.getDataAlertsSettings()

qlik data-alert settings get

curl "https://{tenant}.{region}.qlikcloud.com/api/v1/data-alerts/settings" \
-H "Authorization: Bearer <access_token>"

Example Response

{
  "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 the settings for data alerts. User must be assigned the TenantAdmin role.

Facts

Rate limit

Tier 2 (100 requests per minute)

Request Body

Required

Request for updating the alerting settings

application/json object
Show application/json properties
- enable-data-alerting boolean
  
  Required
  
  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.

Responses

204

Alerting settings have been successfully updated.

400

Bad request body

application/json object
Show application/json properties
- errors array of objects
  
  Show errors properties
  
  code string
  
  Error code specific to sharing service.
  
  meta object
  
  Show meta properties
  
  httpCode integer
  
  HTTP error code.
  
  title string
  
  Error title.
  
  detail string
  
  Error cause.
- traceId string

409

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

application/json object
Show application/json properties
- errors array of objects
  
  Show errors properties
  
  code string
  
  Error code specific to sharing service.
  
  meta object
  
  Show meta properties
  
  httpCode integer
  
  HTTP error code.
  
  title string
  
  Error title.
  
  detail string
  
  Error cause.
- traceId string

500

Internal server error.

application/json object
Show application/json properties
- errors array of objects
  
  Show errors properties
  
  code string
  
  Error code specific to sharing service.
  
  meta object
  
  Show meta properties
  
  httpCode integer
  
  HTTP error code.
  
  title string
  
  Error title.
  
  detail string
  
  Error cause.
- traceId string

default

Error response.

application/json object
Show application/json properties
- errors array of objects
  
  Show errors properties
  
  code string
  
  Error code specific to sharing service.
  
  meta object
  
  Show meta properties
  
  httpCode integer
  
  HTTP error code.
  
  title string
  
  Error title.
  
  detail string
  
  Error cause.
- traceId string

PUT /api/v1/data-alerts/settings

import { createQlikApi } from '@qlik/api'

const qlik = createQlikApi({
  hostConfig: {
    host: 'https://{tenant}.{region}.qlikcloud.com',
    apiKey: '<access-token>',
  },
})

await qlik.dataAlerts.setDataAlertsSettings({
  'enable-data-alerting': true,
})

qlik data-alert settings set \
  --enable-data-alerting true

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

Data alerts

Endpoints

List data alert tasks

Facts

Query Parameters

Responses

200

400

500

default

Example Response

Create data alert task

Facts

Request Body

Responses

202

400

500

default

Example Response

Get data alert task

Facts

Path Parameters

Responses

200

400

404

500

default

Example Response

Update data alert task

Facts

Path Parameters

Request Body

Responses

204

400

404

500

default

Delete data alert task

Facts

Path Parameters

Responses

204

400

404

500

default

Get data alert task condition

Facts

Path Parameters

Responses

200

400

404

500

default

Example Response

Get data alert task execution

Facts

Path Parameters

Responses

200

400

404

500

default

Example Response

Delete data alert task execution

Facts

Path Parameters

Responses

204

400

404

500

default

Get data alert task recipient stats

Facts