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 specification

Get a list of alerting tasks.

Facts

Rate limit Tier 1 (1000 requests per minute)
Categories manage

Query Parameters

  • appIDstring

    The app ID you would like to filter by

  • conditionIdstring

    The conditionId you would like to filter by

  • limitinteger

    Limit the returned result set

  • nextstring

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

  • offsetinteger

    Offset for finding a list of entities - used for pagination

  • ownerIdstring

    The id of the owner you would like to filter by

  • ownerNamestring

    The name of the owner you would like to filter by

  • prevstring

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

  • rolearray of strings

    Values may be any of: "owner""recipient""notowner"

  • sortarray of strings

    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"

  • statusarray of strings

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

Responses

200

application/json

The alerting tasks list has been successfully returned.

  • application/jsonobject
    Show application/json properties
    • totalCountinteger
      Required

      total count of entries in the collection as a whole

    • currentPageCountinteger
      Required

      count of entries on the currently shown page

    • linksobject
      Show links properties
      • nextobject
        Show next properties
        • hrefstring

          URL to particular set of elements

        • typestring

          Page type, can be next or prev

          Can be one of: "prev""next"

        • tokenstring

          Page unique token

      • prevobject
        Show prev properties
        • hrefstring

          URL to particular set of elements

        • typestring

          Page type, can be next or prev

          Can be one of: "prev""next"

        • tokenstring

          Page unique token

      • selfobject

        Object with Href to a particular element or set of elements

        Show self properties
        • hrefstring
    • tasksarray of objects

      Gets a list of alerting tasks.

      Show tasks properties
      • idstring

        data alerting identifier (this is the alertID)

      • namestring

        name associated to alerting task

      • appIdstring

        appId associated to this alert definition

      • linksobject
        Show links properties
        • selfobject

          Object with Href to a particular element or set of elements

          Show self properties
          • hrefstring
      • statusstring

        particular status of the alerting task

        Can be one of: "creating""deleting"

      • enabledboolean

        true if the alerting task is enabled

      • ownerIdstring

        the owner of this alert

      • sheetIdstring

        sheetId associated to this alert definition

      • lastScanstring

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

      • tenantIdstring

        the tenant of this alert

      • ownerNamestring

        the owner name of this alert

      • accessModestring

        Can be one of: "SOURCE_ACCESS""TARGET_ACCESS"

      • bookmarkIdstring

        bookmarkId associated to this alert definition

      • recipientsobject

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

        Show recipients properties
        • DLUsersarray
        • userIdsarray of objects
          Required

          an internal recipient based on its user id.

          Show userIds properties
          • valuestring

            User ID of recipient (internal user).

          • groupsarray of strings

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

          • enabledboolean

            Whether this recipient can receive alerts.

          • subscribedboolean

            Whether this recipient is subscribed to alerts of a task

          • taskRecipientErrorsarray of objects
            Show taskRecipientErrors properties
            • valuestring

              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"

            • timestampstring

              Timestamp for the creation of the error

          • alertingTaskRecipientErrorsarray of objects
            Show alertingTaskRecipientErrors properties
            • addedstring

              Timestamp for the creation of the error

            • valuestring

              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"

        • DLGroupsarray
        • DLListIdstring
        • groupIdsarray of objects

          an internal recipient based on its group id.

          Show groupIds properties
          • valuestring

            Group ID of recipient.

          • enabledboolean

            Whether this recipient can receive alerts.

          • taskGroupRecipientErrorsarray of objects
            Show taskGroupRecipientErrors properties
            • valuestring

              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"

            • timestampstring

              Timestamp for the creation of the error

          • alertingTaskGroupRecipientErrorsarray of objects
            Show alertingTaskGroupRecipientErrors properties
            • addedstring

              Timestamp for the creation of the error

            • valuestring

              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"

      • throttlingobject

        The rules and setup for throttling

        Show throttling properties
        • capacityinteger

          the maximum number of tokens that the bucket can contain

        • timezonestring

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

        • replenishRateinteger

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

        • recurrenceRulestring

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

        • initialTokenCountinteger

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

        • referenceTimestampstring

          a date and time reference specified in RFC3339 format

      • conditionIdstring

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

      • dateCreatedstring

        Timestamp for the creation of the task (rfc3339 format)

      • descriptionstring

        description associated to alerting task

      • errorStatusstring

        error labels from the latest workflow that happened within the task

        Can be one of: "OK""FATAL-ERROR""PARTIAL-TRIGGER"

      • lastTriggerstring

        last time an execution had been created for requesting user

      • lastUpdatedstring

        Timestamp of the most recent update.

      • triggerTypestring

        Type of job that triggered the task

        Can be one of: "RELOAD""SCHEDULED""MANUAL"

      • triggerStatsobject
        Required
        Show triggerStats properties
        • totalScansinteger
          Required

          The number of scans for the current condition.

        • last10Scansinteger
          Required

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

        • last100Scansinteger
          Required

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

      • hideSelectionsboolean

        Whether the selection needs to be hidden.

      • evaluationCountinteger

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

      • scheduleOptionsobject
        Show scheduleOptions properties
        • timezonestring

          The timezone for time calculations in SCHEDULED triggers, optional.

        • recurrencearray 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.

        • endDateTimestring

          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.

        • chronosJobIDstring

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

        • startDateTimestring

          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.

        • lastExecutionTimestring

          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.

        • nextExecutionTimestring

          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.

      • subscriptionIdsarray of strings

        list of subscriptions related to this alerting task

      • absoluteLastScanstring

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

      • conditionResponseobject

        Should reference ConditionResponse type in condition-manager api docs

      • alertingTaskErrorsarray of objects
        Show alertingTaskErrors properties
        • addedstring

          Timestamp for the creation of the error

        • valuestring

          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"

      • absoluteLastTriggerstring

        last time an execution had been created

      • hasHistoryConditionboolean

        true if the alert has history condition enabled

      • lastExecutionStatusstring

        Can be one of: "OK""FAILED"

      • recipientsChangeHistoryarray of objects

        Change in a recipient for an alerting task

        Show recipientsChangeHistory properties
        • dateTimestring

          time of recipient state change

        • patchActionarray 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
          • opstring
            Required

            The operation to be performed.

            Can be one of: "remove""add""replace""enable""disable""subscribe""unsubscribe"

          • valueobject
            Required

            The value to be used for this operation.

          • recipientTypestring
            Required

            Defines the path for the given resource field to patch.

            Can be one of: "userid""groupid"

      • lastEvaluationCountUpdatestring

        the date when the evaluation count was updated

400

application/json

Bad request, malformed syntax or errors in parameters.

  • application/jsonobject
    Show application/json properties
    • errorsarray of objects
    • traceIdstring

500

application/json

Internal server error.

  • application/jsonobject
    Show application/json properties
    • errorsarray of objects
    • traceIdstring

default

application/json

Error response.

  • application/jsonobject
    Show application/json properties
    • errorsarray of objects
    • traceIdstring
GET /v1/data-alerts
curl "https://your-tenant.us.qlikcloud.com/api/v1/data-alerts" \
-H "Authorization: Bearer <API-key>"
const https = require('https')
  const data = JSON.stringify("")
  const options =   {
    'hostname': 'https://your-tenant.us.qlikcloud.com',
    'port': 443,
    'path': '/api/v1/data-alerts',
    'method': 'GET',
    'headers': {
      'Authorization': 'Bearer <API-key>'
    }
  }
  const req = https.request(options)
  
This API is not included yet in qlik-cli

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": "USER_IS_DELETED",
                "timestamp": "2019-10-15T16:07:01.492Z"
              }
            ],
            "alertingTaskRecipientErrors": [
              {
                "added": "2019-10-15T16:07:01.492Z",
                "value": "USER_IS_DELETED"
              }
            ]
          }
        ],
        "DLGroups": [],
        "DLListId": "string",
        "groupIds": [
          {
            "value": "group1",
            "enabled": true,
            "taskGroupRecipientErrors": [
              {
                "value": "GROUP_IS_DISABLED",
                "timestamp": "2019-10-15T16:07:01.492Z"
              }
            ],
            "alertingTaskGroupRecipientErrors": [
              {
                "added": "2019-10-15T16:07:01.492Z",
                "value": "GROUP_IS_DISABLED"
              }
            ]
          }
        ]
      },
      "throttling": {
        "capacity": 42,
        "timezone": "Etc/UTC",
        "replenishRate": 42,
        "recurrenceRule": "string",
        "initialTokenCount": 42,
        "referenceTimestamp": "string"
      },
      "conditionId": "string",
      "dateCreated": "2019-10-15T16:07:01.492Z",
      "description": "string",
      "errorStatus": "OK",
      "lastTrigger": "string",
      "lastUpdated": "2019-10-15T16:07:01.492Z",
      "triggerType": "RELOAD",
      "triggerStats": {
        "totalScans": 42,
        "last10Scans": 42,
        "last100Scans": 42
      },
      "hideSelections": true,
      "evaluationCount": 42,
      "scheduleOptions": {
        "timezone": "Canada/Pacific",
        "recurrence": [
          "RRULE:FREQ=HOURLY;INTERVAL=2"
        ],
        "endDateTime": "",
        "chronosJobID": "string",
        "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 alerting task.

Facts

Rate limit Tier 2 (100 requests per minute)
Categories manage

Request Body

Required

application/json

The alerting task create request definition.

a alerting task (a definition on an alert)

  • application/jsonobject

    a alerting task (a definition on an alert)

    Show application/json properties
    • namestring
      Required

      name associated to alerting task

    • appIdstring
      Required

      appId associated to this alert definition

    • enabledboolean

      if the alerting task is enabled

    • sheetIdstring

      sheetId associated to this alert definition

    • bookmarkIdstring

      bookmarkId associated to this alert definition

    • recipientsobject
      Required

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

      Show recipients properties
      • DLUsersarray
      • userIdsarray of objects
        Required
      • DLGroupsarray
      • DLListIdstring
      • groupIdsarray of objects
    • throttlingobject

      The rules and setup for throttling

      Show throttling properties
      • capacityinteger

        the maximum number of tokens that the bucket can contain

      • timezonestring

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

      • replenishRateinteger

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

      • recurrenceRulestring

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

      • initialTokenCountinteger

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

      • referenceTimestampstring

        a date and time reference specified in RFC3339 format

    • conditionIdstring
      Required

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

    • descriptionstring

      description associated to alerting task

    • triggerTypestring
      Required

      Type of job that triggered the task

      Can be one of: "RELOAD""SCHEDULED"

    • scheduleOptionsobject
      Show scheduleOptions properties
      • timezonestring

        The timezone for time calculations in SCHEDULED triggers, optional.

      • recurrencearray 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.

      • endDateTimestring

        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.

      • startDateTimestring

        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

application/json

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

  • application/jsonobject
    Show application/json properties
    • idstring

      data alerting identifier (this is the alertID)

    • namestring

      name associated to alerting task

    • appIdstring

      appId associated to this alert definition

    • linksobject
      Show links properties
      • selfobject

        Object with Href to a particular element or set of elements

        Show self properties
        • hrefstring
    • statusstring

      particular status of the alerting task

      Can be one of: "creating""deleting"

    • enabledboolean

      true if the alerting task is enabled

    • ownerIdstring

      the owner of this alert

    • sheetIdstring

      sheetId associated to this alert definition

    • lastScanstring

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

    • tenantIdstring

      the tenant of this alert

    • ownerNamestring

      the owner name of this alert

    • accessModestring

      Can be one of: "SOURCE_ACCESS""TARGET_ACCESS"

    • bookmarkIdstring

      bookmarkId associated to this alert definition

    • recipientsobject

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

      Show recipients properties
      • DLUsersarray
      • userIdsarray of objects
        Required
      • DLGroupsarray
      • DLListIdstring
      • groupIdsarray of objects
    • throttlingobject

      The rules and setup for throttling

      Show throttling properties
      • capacityinteger

        the maximum number of tokens that the bucket can contain

      • timezonestring

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

      • replenishRateinteger

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

      • recurrenceRulestring

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

      • initialTokenCountinteger

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

      • referenceTimestampstring

        a date and time reference specified in RFC3339 format

    • conditionIdstring

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

    • dateCreatedstring

      Timestamp for the creation of the task (rfc3339 format)

    • descriptionstring

      description associated to alerting task

    • errorStatusstring

      error labels from the latest workflow that happened within the task

      Can be one of: "OK""FATAL-ERROR""PARTIAL-TRIGGER"

    • lastTriggerstring

      last time an execution had been created for requesting user

    • lastUpdatedstring

      Timestamp of the most recent update.

    • triggerTypestring

      Type of job that triggered the task

      Can be one of: "RELOAD""SCHEDULED""MANUAL"

    • triggerStatsobject
      Required
      Show triggerStats properties
      • totalScansinteger
        Required

        The number of scans for the current condition.

      • last10Scansinteger
        Required

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

      • last100Scansinteger
        Required

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

    • hideSelectionsboolean

      Whether the selection needs to be hidden.

    • evaluationCountinteger

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

    • scheduleOptionsobject
      Show scheduleOptions properties
      • timezonestring

        The timezone for time calculations in SCHEDULED triggers, optional.

      • recurrencearray 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.

      • endDateTimestring

        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.

      • chronosJobIDstring

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

      • startDateTimestring

        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.

      • lastExecutionTimestring

        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.

      • nextExecutionTimestring

        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.

    • subscriptionIdsarray of strings

      list of subscriptions related to this alerting task

    • absoluteLastScanstring

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

    • conditionResponseobject

      Should reference ConditionResponse type in condition-manager api docs

    • alertingTaskErrorsarray of objects
    • absoluteLastTriggerstring

      last time an execution had been created

    • hasHistoryConditionboolean

      true if the alert has history condition enabled

    • lastExecutionStatusstring

      Can be one of: "OK""FAILED"

    • recipientsChangeHistoryarray of objects
    • lastEvaluationCountUpdatestring

      the date when the evaluation count was updated

400

application/json

Bad request, malformed syntax or errors in parameters.

  • application/jsonobject
    Show application/json properties
    • errorsarray of objects
    • traceIdstring

500

application/json

Internal server error.

  • application/jsonobject
    Show application/json properties
    • errorsarray of objects
    • traceIdstring

default

application/json

Error response.

  • application/jsonobject
    Show application/json properties
    • errorsarray of objects
    • traceIdstring
POST /v1/data-alerts
curl "https://your-tenant.us.qlikcloud.com/api/v1/data-alerts" \
-X POST \
-H "Content-type: application/json" \
-H "Authorization: Bearer <API-key>" \
-d '{"name":"string","appId":"string","enabled":true,"sheetId":"string","bookmarkId":"string","recipients":{"DLUsers":[],"userIds":[{}],"DLGroups":[],"DLListId":"string","groupIds":[{}]},"throttling":{"capacity":42,"timezone":"Etc/UTC","replenishRate":42,"recurrenceRule":"string","initialTokenCount":42,"referenceTimestamp":"string"},"conditionId":"string","description":"string","triggerType":"RELOAD","scheduleOptions":{"timezone":"Canada/Pacific","recurrence":["RRULE:FREQ=HOURLY;INTERVAL=2"],"endDateTime":"","startDateTime":"2006-01-02T16:04:05"}}'
const https = require('https')
  const data = JSON.stringify({"name":"string","appId":"string","enabled":true,"sheetId":"string","bookmarkId":"string","recipients":{"DLUsers":[],"userIds":[{}],"DLGroups":[],"DLListId":"string","groupIds":[{}]},"throttling":{"capacity":42,"timezone":"Etc/UTC","replenishRate":42,"recurrenceRule":"string","initialTokenCount":42,"referenceTimestamp":"string"},"conditionId":"string","description":"string","triggerType":"RELOAD","scheduleOptions":{"timezone":"Canada/Pacific","recurrence":["RRULE:FREQ=HOURLY;INTERVAL=2"],"endDateTime":"","startDateTime":"2006-01-02T16:04:05"}})
  const options =   {
    'hostname': 'https://your-tenant.us.qlikcloud.com',
    'port': 443,
    'path': '/api/v1/data-alerts',
    'method': 'POST',
    'headers': {
      'Content-type': 'application/json',
      'Authorization': 'Bearer <API-key>'
    }
  }
  const req = https.request(options)
  req.write(data)
  
This API is not included yet in qlik-cli

Request

{
  "name": "string",
  "appId": "string",
  "enabled": true,
  "sheetId": "string",
  "bookmarkId": "string",
  "recipients": {
    "DLUsers": [],
    "userIds": [
      {}
    ],
    "DLGroups": [],
    "DLListId": "string",
    "groupIds": [
      {}
    ]
  },
  "throttling": {
    "capacity": 42,
    "timezone": "Etc/UTC",
    "replenishRate": 42,
    "recurrenceRule": "string",
    "initialTokenCount": 42,
    "referenceTimestamp": "string"
  },
  "conditionId": "string",
  "description": "string",
  "triggerType": "RELOAD",
  "scheduleOptions": {
    "timezone": "Canada/Pacific",
    "recurrence": [
      "RRULE:FREQ=HOURLY;INTERVAL=2"
    ],
    "endDateTime": "",
    "startDateTime": "2006-01-02T16:04:05"
  }
}

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": [
      {}
    ],
    "DLGroups": [],
    "DLListId": "string",
    "groupIds": [
      {}
    ]
  },
  "throttling": {
    "capacity": 42,
    "timezone": "Etc/UTC",
    "replenishRate": 42,
    "recurrenceRule": "string",
    "initialTokenCount": 42,
    "referenceTimestamp": "string"
  },
  "conditionId": "string",
  "dateCreated": "2019-10-15T16:07:01.492Z",
  "description": "string",
  "errorStatus": "OK",
  "lastTrigger": "string",
  "lastUpdated": "2019-10-15T16:07:01.492Z",
  "triggerType": "RELOAD",
  "triggerStats": {
    "totalScans": 42,
    "last10Scans": 42,
    "last100Scans": 42
  },
  "hideSelections": true,
  "evaluationCount": 42,
  "scheduleOptions": {
    "timezone": "Canada/Pacific",
    "recurrence": [
      "RRULE:FREQ=HOURLY;INTERVAL=2"
    ],
    "endDateTime": "",
    "chronosJobID": "string",
    "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": [
    {}
  ],
  "absoluteLastTrigger": "string",
  "hasHistoryCondition": true,
  "lastExecutionStatus": "OK",
  "recipientsChangeHistory": [
    {}
  ],
  "lastEvaluationCountUpdate": "string"
}

Get an alerting task by its id

Facts

Rate limit Tier 1 (1000 requests per minute)
Categories manage

Path Parameters

  • alertIdstring
    Required

    The alerting task identifier.

Responses

200

application/json

Alert has been successfully returned.

  • application/jsonobject
    Show application/json properties
    • idstring

      data alerting identifier (this is the alertID)

    • namestring

      name associated to alerting task

    • appIdstring

      appId associated to this alert definition

    • linksobject
      Show links properties
      • selfobject

        Object with Href to a particular element or set of elements

        Show self properties
        • hrefstring
    • statusstring

      particular status of the alerting task

      Can be one of: "creating""deleting"

    • enabledboolean

      true if the alerting task is enabled

    • ownerIdstring

      the owner of this alert

    • sheetIdstring

      sheetId associated to this alert definition

    • lastScanstring

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

    • tenantIdstring

      the tenant of this alert

    • ownerNamestring

      the owner name of this alert

    • accessModestring

      Can be one of: "SOURCE_ACCESS""TARGET_ACCESS"

    • bookmarkIdstring

      bookmarkId associated to this alert definition

    • recipientsobject

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

      Show recipients properties
      • DLUsersarray
      • userIdsarray of objects
        Required
      • DLGroupsarray
      • DLListIdstring
      • groupIdsarray of objects
    • throttlingobject

      The rules and setup for throttling

      Show throttling properties
      • capacityinteger

        the maximum number of tokens that the bucket can contain

      • timezonestring

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

      • replenishRateinteger

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

      • recurrenceRulestring

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

      • initialTokenCountinteger

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

      • referenceTimestampstring

        a date and time reference specified in RFC3339 format

    • conditionIdstring

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

    • dateCreatedstring

      Timestamp for the creation of the task (rfc3339 format)

    • descriptionstring

      description associated to alerting task

    • errorStatusstring

      error labels from the latest workflow that happened within the task

      Can be one of: "OK""FATAL-ERROR""PARTIAL-TRIGGER"

    • lastTriggerstring

      last time an execution had been created for requesting user

    • lastUpdatedstring

      Timestamp of the most recent update.

    • triggerTypestring

      Type of job that triggered the task

      Can be one of: "RELOAD""SCHEDULED""MANUAL"

    • triggerStatsobject
      Required
      Show triggerStats properties
      • totalScansinteger
        Required

        The number of scans for the current condition.

      • last10Scansinteger
        Required

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

      • last100Scansinteger
        Required

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

    • hideSelectionsboolean

      Whether the selection needs to be hidden.

    • evaluationCountinteger

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

    • scheduleOptionsobject
      Show scheduleOptions properties
      • timezonestring

        The timezone for time calculations in SCHEDULED triggers, optional.

      • recurrencearray 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.

      • endDateTimestring

        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.

      • chronosJobIDstring

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

      • startDateTimestring

        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.

      • lastExecutionTimestring

        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.

      • nextExecutionTimestring

        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.

    • subscriptionIdsarray of strings

      list of subscriptions related to this alerting task

    • absoluteLastScanstring

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

    • conditionResponseobject

      Should reference ConditionResponse type in condition-manager api docs

    • alertingTaskErrorsarray of objects
    • absoluteLastTriggerstring

      last time an execution had been created

    • hasHistoryConditionboolean

      true if the alert has history condition enabled

    • lastExecutionStatusstring

      Can be one of: "OK""FAILED"

    • recipientsChangeHistoryarray of objects
    • lastEvaluationCountUpdatestring

      the date when the evaluation count was updated

400

application/json

Bad request, malformed syntax or errors in parameters.

  • application/jsonobject
    Show application/json properties
    • errorsarray of objects
    • traceIdstring

404

application/json

Task or execution not found.

  • application/jsonobject
    Show application/json properties
    • errorsarray of objects
    • traceIdstring

500

application/json

Internal server error.

  • application/jsonobject
    Show application/json properties
    • errorsarray of objects
    • traceIdstring

default

application/json

Error response.

  • application/jsonobject
    Show application/json properties
    • errorsarray of objects
    • traceIdstring
GET /v1/data-alerts/{alertId}
curl "https://your-tenant.us.qlikcloud.com/api/v1/data-alerts/{alertId}" \
-H "Authorization: Bearer <API-key>"
const https = require('https')
  const data = JSON.stringify("")
  const options =   {
    'hostname': 'https://your-tenant.us.qlikcloud.com',
    'port': 443,
    'path': '/api/v1/data-alerts/{alertId}',
    'method': 'GET',
    'headers': {
      'Authorization': 'Bearer <API-key>'
    }
  }
  const req = https.request(options)
  
This API is not included yet in qlik-cli

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": [
      {}
    ],
    "DLGroups": [],
    "DLListId": "string",
    "groupIds": [
      {}
    ]
  },
  "throttling": {
    "capacity": 42,
    "timezone": "Etc/UTC",
    "replenishRate": 42,
    "recurrenceRule": "string",
    "initialTokenCount": 42,
    "referenceTimestamp": "string"
  },
  "conditionId": "string",
  "dateCreated": "2019-10-15T16:07:01.492Z",
  "description": "string",
  "errorStatus": "OK",
  "lastTrigger": "string",
  "lastUpdated": "2019-10-15T16:07:01.492Z",
  "triggerType": "RELOAD",
  "triggerStats": {
    "totalScans": 42,
    "last10Scans": 42,
    "last100Scans": 42
  },
  "hideSelections": true,
  "evaluationCount": 42,
  "scheduleOptions": {
    "timezone": "Canada/Pacific",
    "recurrence": [
      "RRULE:FREQ=HOURLY;INTERVAL=2"
    ],
    "endDateTime": "",
    "chronosJobID": "string",
    "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": [
    {}
  ],
  "absoluteLastTrigger": "string",
  "hasHistoryCondition": true,
  "lastExecutionStatus": "OK",
  "recipientsChangeHistory": [
    {}
  ],
  "lastEvaluationCountUpdate": "string"
}

Updates an existing alerting task

Facts

Rate limit Tier 2 (100 requests per minute)
Categories manage

Path Parameters

  • alertIdstring
    Required

    The alerting task identifier.

Request Body

Required

application/json

Patch request definition for an alerting task.

  • application/jsonarray of objects
    Show application/json properties
    • opstring
      Required

      The operation to be performed

      Can be one of: "replace"

    • pathstring
      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"

    • valueobject

      The value to be used for this operation.

Responses

204

The alerting task has been successfully updated.

400

application/json

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

  • application/jsonobject
    Show application/json properties
    • errorsarray of objects
    • traceIdstring

404

application/json

An alerting task with the specified ID was not found.

  • application/jsonobject
    Show application/json properties
    • errorsarray of objects
    • traceIdstring

500

application/json

Internal server error.

  • application/jsonobject
    Show application/json properties
    • errorsarray of objects
    • traceIdstring

default

application/json

Error response.

  • application/jsonobject
    Show application/json properties
    • errorsarray of objects
    • traceIdstring
PATCH /v1/data-alerts/{alertId}
curl "https://your-tenant.us.qlikcloud.com/api/v1/data-alerts/{alertId}" \
-X PATCH \
-H "Content-type: application/json" \
-H "Authorization: Bearer <API-key>" \
-d '[{"op":"replace","path":"/ownerName","value":{}}]'
const https = require('https')
  const data = JSON.stringify([{"op":"replace","path":"/ownerName","value":{}}])
  const options =   {
    'hostname': 'https://your-tenant.us.qlikcloud.com',
    'port': 443,
    'path': '/api/v1/data-alerts/{alertId}',
    'method': 'PATCH',
    'headers': {
      'Content-type': 'application/json',
      'Authorization': 'Bearer <API-key>'
    }
  }
  const req = https.request(options)
  req.write(data)
  
This API is not included yet in qlik-cli

Request

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

Deletes an alerting task.

Facts

Rate limit Tier 2 (100 requests per minute)
Categories manage

Path Parameters

  • alertIdstring
    Required

    The alerting task identifier.

Responses

204

The alerting task has been successfully deleted.

400

application/json

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

  • application/jsonobject
    Show application/json properties
    • errorsarray of objects
    • traceIdstring

404

application/json

An alerting task with the specified ID was not found.

  • application/jsonobject
    Show application/json properties
    • errorsarray of objects
    • traceIdstring

500

application/json

Internal server error.

  • application/jsonobject
    Show application/json properties
    • errorsarray of objects
    • traceIdstring

default

application/json

Error response.

  • application/jsonobject
    Show application/json properties
    • errorsarray of objects
    • traceIdstring
DELETE /v1/data-alerts/{alertId}
curl "https://your-tenant.us.qlikcloud.com/api/v1/data-alerts/{alertId}" \
-X DELETE \
-H "Authorization: Bearer <API-key>"
const https = require('https')
  const data = JSON.stringify("")
  const options =   {
    'hostname': 'https://your-tenant.us.qlikcloud.com',
    'port': 443,
    'path': '/api/v1/data-alerts/{alertId}',
    'method': 'DELETE',
    'headers': {
      'Authorization': 'Bearer <API-key>'
    }
  }
  const req = https.request(options)
  
This API is not included yet in qlik-cli

Get the condition associated with an alerting task

Facts

Rate limit Tier 1 (1000 requests per minute)
Categories manage

Path Parameters

  • alertIdstring
    Required

    The alerting task identifier.

Responses

200

application/json

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

  • application/jsonobject
    Show application/json properties
    • hideSelectionsboolean
    • conditionResponseobject

      Should reference ConditionResponse type in condition-manager api docs

400

application/json

Bad request, malformed syntax or errors in parameters.

  • application/jsonobject
    Show application/json properties
    • errorsarray of objects
    • traceIdstring

404

application/json

Task or condition not found.

  • application/jsonobject
    Show application/json properties
    • errorsarray of objects
    • traceIdstring

500

application/json

Internal server error.

  • application/jsonobject
    Show application/json properties
    • errorsarray of objects
    • traceIdstring

default

application/json

Error response.

  • application/jsonobject
    Show application/json properties
    • errorsarray of objects
    • traceIdstring
GET /v1/data-alerts/{alertId}/condition
curl "https://your-tenant.us.qlikcloud.com/api/v1/data-alerts/{alertId}/condition" \
-H "Authorization: Bearer <API-key>"
const https = require('https')
  const data = JSON.stringify("")
  const options =   {
    'hostname': 'https://your-tenant.us.qlikcloud.com',
    'port': 443,
    'path': '/api/v1/data-alerts/{alertId}/condition',
    'method': 'GET',
    'headers': {
      'Authorization': 'Bearer <API-key>'
    }
  }
  const req = https.request(options)
  
This API is not included yet in qlik-cli

Response

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

Gets a specified alerting execution.

Facts

Rate limit Tier 1 (1000 requests per minute)
Categories manage

Path Parameters

  • alertIdstring
    Required

    The alerting task identifier.

  • executionIdstring
    Required

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

Responses

200

application/json

The execution has been successfully returned.

  • application/jsonobject
    Show application/json properties
    • idstring

      Gets the execution identifier.

    • errorsarray of objects
      Show errors properties
      • codestring

        Error code specific to sharing service.

      • titlestring

        Error title.

      • detailstring

        Error cause.

    • resultobject
      Show result properties
      • alertTriggerStatusstring
      • throttlerTokensLeftinteger
    • alertIdstring

      ID for the alerting task that this execution references

    • ownerIdstring

      The owner that this execution belongs to

    • measuresarray of strings

      Measures applied in the condition

    • tenantIdstring

      The tenant that this execution belongs to

    • accessModestring

      Can be one of: "SOURCE_ACCESS""TARGET_ACCESS"

    • bookmarkIdstring

      Id of the bookmark associated with an alert

    • dimensionsarray of strings

      Dimensions applied in the condition

    • workflowIdstring

      ID for the workflow, coming from eventing service

    • conditionIdstring

      Id of the condition the alert is associated with

    • triggerTimestring

      Timestamp of execution start

    • evaluationIdstring

      Id of the evaluation for the condition

    • executionTypestring

      Can be one of: "INDIVIDUAL""SHARED"

    • conditionStatusstring

      Can be one of: "FINISHED""FAILED"

    • executionEvaluationStatusstring

      Can be one of: "CONDITION_MET""CONDITION_NOT_MET""FAILED"

    • linksobject
      Show links properties
      • selfobject

        Object with Href to a particular element or set of elements

        Show self properties
        • hrefstring
    • evaluationobject
      Show evaluation properties
      • idstring

        The unique id for the resource

      • resultstring

        The final result of the evalution

        Can be one of: "success""failure""error"

      • statusstring

        The status of the evaluation execution

        Can be one of: "RUNNING""FAILED""FINISHED"

      • endTimestring

        The time the evaluation ended

      • ownerIdstring

        userId of user being impersonated to evaluate the condition

      • tenantIdstring

        The tenant id

      • contextIdstring

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

      • startTimestring

        The time the evaluation started

      • resultDataobject

        Condition type specific result, one of dataResult or compoundResult

      • causalEventobject

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

      • conditionIdstring

        The unique id of the associated condition

      • dataConditionEvaluatorIdstring

        The unique id for the resource given from Data Condition Evaluator

400

application/json

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

  • application/jsonobject
    Show application/json properties
    • errorsarray of objects
    • traceIdstring

404

application/json

Task or execution not found.

  • application/jsonobject
    Show application/json properties
    • errorsarray of objects
    • traceIdstring

500

application/json

Internal server error.

  • application/jsonobject
    Show application/json properties
    • errorsarray of objects
    • traceIdstring

default

application/json

Error response.

  • application/jsonobject
    Show application/json properties
    • errorsarray of objects
    • traceIdstring
GET /v1/data-alerts/{alertId}/executions/{executionId}
curl "https://your-tenant.us.qlikcloud.com/api/v1/data-alerts/{alertId}/executions/{executionId}" \
-H "Authorization: Bearer <API-key>"
const https = require('https')
  const data = JSON.stringify("")
  const options =   {
    'hostname': 'https://your-tenant.us.qlikcloud.com',
    'port': 443,
    'path': '/api/v1/data-alerts/{alertId}/executions/{executionId}',
    'method': 'GET',
    'headers': {
      'Authorization': 'Bearer <API-key>'
    }
  }
  const req = https.request(options)
  
This API is not included yet in qlik-cli

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 an execution.

Facts

Rate limit Tier 2 (100 requests per minute)
Categories manage

Path Parameters

  • alertIdstring
    Required

    The alerting task identifier.

  • executionIdstring
    Required

    The execution identifier.

Responses

204

The execution has been successfully deleted.

400

application/json

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

  • application/jsonobject
    Show application/json properties
    • errorsarray of objects
    • traceIdstring

404

application/json

Task or execution not found.

  • application/jsonobject
    Show application/json properties
    • errorsarray of objects
    • traceIdstring

500

application/json

Internal server error.

  • application/jsonobject
    Show application/json properties
    • errorsarray of objects
    • traceIdstring

default

application/json

Error response.

  • application/jsonobject
    Show application/json properties
    • errorsarray of objects
    • traceIdstring
DELETE /v1/data-alerts/{alertId}/executions/{executionId}
curl "https://your-tenant.us.qlikcloud.com/api/v1/data-alerts/{alertId}/executions/{executionId}" \
-X DELETE \
-H "Authorization: Bearer <API-key>"
const https = require('https')
  const data = JSON.stringify("")
  const options =   {
    'hostname': 'https://your-tenant.us.qlikcloud.com',
    'port': 443,
    'path': '/api/v1/data-alerts/{alertId}/executions/{executionId}',
    'method': 'DELETE',
    'headers': {
      'Authorization': 'Bearer <API-key>'
    }
  }
  const req = https.request(options)
  
This API is not included yet in qlik-cli

Get the recipient stats for an alerting task

Facts

Rate limit Tier 1 (1000 requests per minute)
Categories manage

Query Parameters

  • groupsarray of strings

    The name of the groups you would like to filter by

  • sortarray of strings

    Values may be any of: "+userID""-userID""subscribed""+subscribed"

  • subscribedboolean

    Subscribed property you would like to filter by

  • userIDstring

    The recipients ID you would like to filter by

Path Parameters

  • alertIdstring
    Required

    The alerting task identifier.

Responses

200

application/json

Alert recipient stats have been successfully returned.

  • application/jsonobject
    Show application/json properties
    • recipientStatsarray of objects
      Show recipientStats properties
      • typestring

        Can be one of: "userid"

      • valuestring
      • errorsarray of objects
        Show errors properties
        • codestring

          Error code specific to sharing service.

        • titlestring

          Error title.

        • detailstring

          Error cause.

      • groupsarray of strings

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

      • enabledboolean
        Required

        Whether the recipient is enabled.

      • lastScanstring

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

      • subscribedboolean

        Whether the recipient is subscribed.

      • lastTriggerstring

        last time an execution had been created

      • conditionStatusstring

        Can be one of: "OK""FAILED"

400

application/json

Bad request, malformed syntax or errors in parameters.

  • application/jsonobject
    Show application/json properties
    • errorsarray of objects
    • traceIdstring

404

application/json

Task or execution not found.

  • application/jsonobject
    Show application/json properties
    • errorsarray of objects
    • traceIdstring

500

application/json

Internal server error.

  • application/jsonobject
    Show application/json properties
    • errorsarray of objects
    • traceIdstring

default

application/json

Error response.

  • application/jsonobject
    Show application/json properties
    • errorsarray of objects
    • traceIdstring
GET /v1/data-alerts/{alertId}/recipient-stats
curl "https://your-tenant.us.qlikcloud.com/api/v1/data-alerts/{alertId}/recipient-stats" \
-H "Authorization: Bearer <API-key>"
const https = require('https')
  const data = JSON.stringify("")
  const options =   {
    'hostname': 'https://your-tenant.us.qlikcloud.com',
    'port': 443,
    'path': '/api/v1/data-alerts/{alertId}/recipient-stats',
    'method': 'GET',
    'headers': {
      'Authorization': 'Bearer <API-key>'
    }
  }
  const req = https.request(options)
  
This API is not included yet in qlik-cli

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 all alerting-executions linked to a user and a tenant.

Facts

Rate limit Tier 1 (1000 requests per minute)
Categories manage

Query Parameters

  • conditionIdstring

    Filter by condition id related to the executions.

  • conditionStatusstring

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

    Can be one of: "FINISHED""FAILED""ALL"

  • daysOfMontharray of integers

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

  • daysOfWeekarray 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"

  • fieldsarray 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"

  • includeEvaluationboolean

    Specifies whether to include evaluation details

  • lastEachDayboolean

    Specifies whether to only show the last execution in each day

  • limitinteger

    Limit the returned result set

  • minimumGapDaysinteger

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

  • nextstring

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

  • offsetinteger

    Offset for pagination - how many elements to skip

  • prevstring

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

  • searchResultsLimitinteger

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

  • sincestring

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

  • sortarray of strings

    Values may be any of: "triggertime""-triggertime""+triggertime"

  • timezonestring

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

  • triggeredboolean

    Filter by whether the alerting task is triggered.

  • untilstring

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

Path Parameters

  • taskIdstring
    Required

    The alerting task identifier.

Responses

200

application/json

The alerting-executions list has been successfully returned.

  • application/jsonobject
    Show application/json properties
    • totalCountinteger
      Required

      total count of entries in the collection as a whole

    • currentPageCountinteger
      Required

      count of entries on the currently shown page

    • linksobject
      Show links properties
      • nextobject
        Show next properties
        • hrefstring

          URL to particular set of elements

        • typestring

          Page type, can be next or prev

          Can be one of: "prev""next"

        • tokenstring

          Page unique token

      • prevobject
        Show prev properties
        • hrefstring

          URL to particular set of elements

        • typestring

          Page type, can be next or prev

          Can be one of: "prev""next"

        • tokenstring

          Page unique token

      • selfobject

        Object with Href to a particular element or set of elements

        Show self properties
        • hrefstring
    • executionsarray of objects

400

application/json

Bad request, malformed syntax or errors in parameters.

  • application/jsonobject
    Show application/json properties
    • errorsarray of objects
    • traceIdstring

404

application/json

Task or execution not found.

  • application/jsonobject
    Show application/json properties
    • errorsarray of objects
    • traceIdstring

500

application/json

Internal server error.

  • application/jsonobject
    Show application/json properties
    • errorsarray of objects
    • traceIdstring

default

application/json

Error response.

  • application/jsonobject
    Show application/json properties
    • errorsarray of objects
    • traceIdstring
GET /v1/data-alerts/{taskId}/executions
curl "https://your-tenant.us.qlikcloud.com/api/v1/data-alerts/{taskId}/executions" \
-H "Authorization: Bearer <API-key>"
const https = require('https')
  const data = JSON.stringify("")
  const options =   {
    'hostname': 'https://your-tenant.us.qlikcloud.com',
    'port': 443,
    'path': '/api/v1/data-alerts/{taskId}/executions',
    'method': 'GET',
    'headers': {
      'Authorization': 'Bearer <API-key>'
    }
  }
  const req = https.request(options)
  
This API is not included yet in qlik-cli

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": [
    {}
  ]
}

Gets the content of an evaluation from an execution

Facts

Rate limit Tier 1 (1000 requests per minute)
Categories manage

Path Parameters

  • executionIdstring
    Required

    The execution identifier.

  • taskIdstring
    Required

    The alerting task identifier.

Responses

200

application/json

Evaluation successfully returned.

  • application/jsonobject
    Show application/json properties
    • conditionobject
    • evaluationobject
      Show evaluation properties
      • idstring

        The unique id for the resource

      • resultstring

        The final result of the evalution

        Can be one of: "success""failure""error"

      • statusstring

        The status of the evaluation execution

        Can be one of: "RUNNING""FAILED""FINISHED"

      • endTimestring

        The time the evaluation ended

      • ownerIdstring

        userId of user being impersonated to evaluate the condition

      • tenantIdstring

        The tenant id

      • contextIdstring

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

      • startTimestring

        The time the evaluation started

      • resultDataobject

        Condition type specific result, one of dataResult or compoundResult

      • causalEventobject

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

      • conditionIdstring

        The unique id of the associated condition

      • dataConditionEvaluatorIdstring

        The unique id for the resource given from Data Condition Evaluator

    • hideSelectionsboolean

404

application/json

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

  • application/jsonobject
    Show application/json properties
    • errorsarray of objects
    • traceIdstring

500

application/json

Internal server error.

  • application/jsonobject
    Show application/json properties
    • errorsarray of objects
    • traceIdstring

default

application/json

Error response.

  • application/jsonobject
    Show application/json properties
    • errorsarray of objects
    • traceIdstring
GET /v1/data-alerts/{taskId}/executions/{executionId}/evaluations
curl "https://your-tenant.us.qlikcloud.com/api/v1/data-alerts/{taskId}/executions/{executionId}/evaluations" \
-H "Authorization: Bearer <API-key>"
const https = require('https')
  const data = JSON.stringify("")
  const options =   {
    'hostname': 'https://your-tenant.us.qlikcloud.com',
    'port': 443,
    'path': '/api/v1/data-alerts/{taskId}/executions/{executionId}/evaluations',
    'method': 'GET',
    'headers': {
      'Authorization': 'Bearer <API-key>'
    }
  }
  const req = https.request(options)
  
This API is not included yet in qlik-cli

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
}

Gets the stats for alerting task executions

Deprecated

Facts

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

Query Parameters

  • periodstring
    Required

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

    Can be one of: "month"

Path Parameters

  • taskIdstring
    Required

    The alerting task identifier.

Responses

200

application/json

Evaluation successfully returned.

  • application/jsonobjectDeprecated
    Show application/json properties
    • totalCountinteger
      Required

      total count of entries in the collection as a whole

    • currentPageCountinteger
      Required

      count of entries on the currently shown page

    • linksobject
      Show links properties
      • nextobject
        Show next properties
        • hrefstring

          URL to particular set of elements

        • typestring

          Page type, can be next or prev

          Can be one of: "prev""next"

        • tokenstring

          Page unique token

      • prevobject
        Show prev properties
        • hrefstring

          URL to particular set of elements

        • typestring

          Page type, can be next or prev

          Can be one of: "prev""next"

        • tokenstring

          Page unique token

      • selfobject

        Object with Href to a particular element or set of elements

        Show self properties
        • hrefstring
    • executionsStatsarray of objects
      Show executionsStats properties
      • endTimestring
      • periodKeystring
      • startTimestring
      • totalExecutionsstring
      • triggeredExecutionsstring

404

application/json

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

  • application/jsonobject
    Show application/json properties
    • errorsarray of objects
    • traceIdstring

500

application/json

Internal server error.

  • application/jsonobject
    Show application/json properties
    • errorsarray of objects
    • traceIdstring

default

application/json

Error response.

  • application/jsonobject
    Show application/json properties
    • errorsarray of objects
    • traceIdstring
GET /v1/data-alerts/{taskId}/executions/stats
curl "https://your-tenant.us.qlikcloud.com/api/v1/data-alerts/{taskId}/executions/stats" \
-H "Authorization: Bearer <API-key>"
const https = require('https')
  const data = JSON.stringify("")
  const options =   {
    'hostname': 'https://your-tenant.us.qlikcloud.com',
    'port': 443,
    'path': '/api/v1/data-alerts/{taskId}/executions/stats',
    'method': 'GET',
    'headers': {
      'Authorization': 'Bearer <API-key>'
    }
  }
  const req = https.request(options)
  
This API is not included yet in qlik-cli

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 alerting trigger action.

Facts

Rate limit Tier 2 (100 requests per minute)
Categories manage

Request Body

Required

application/json

The alerting trigger action create request definition.

  • application/jsonobject
    Show application/json properties
    • alertingTaskIDstring
      Required

Responses

202

application/json

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

  • application/jsonobject
    Show application/json properties
    • workflowIDstring

      the workflow id created for the manual triggering of alert

400

application/json

Bad request, malformed syntax or errors in parameters.

  • application/jsonobject
    Show application/json properties
    • errorsarray of objects
    • traceIdstring

500

application/json

Internal server error.

  • application/jsonobject
    Show application/json properties
    • errorsarray of objects
    • traceIdstring

default

application/json

Error response.

  • application/jsonobject
    Show application/json properties
    • errorsarray of objects
    • traceIdstring
POST /v1/data-alerts/actions/trigger
curl "https://your-tenant.us.qlikcloud.com/api/v1/data-alerts/actions/trigger" \
-X POST \
-H "Content-type: application/json" \
-H "Authorization: Bearer <API-key>" \
-d '{"alertingTaskID":"a1b2c3d4f5"}'
const https = require('https')
  const data = JSON.stringify({"alertingTaskID":"a1b2c3d4f5"})
  const options =   {
    'hostname': 'https://your-tenant.us.qlikcloud.com',
    'port': 443,
    'path': '/api/v1/data-alerts/actions/trigger',
    'method': 'POST',
    'headers': {
      'Content-type': 'application/json',
      'Authorization': 'Bearer <API-key>'
    }
  }
  const req = https.request(options)
  req.write(data)
  
This API is not included yet in qlik-cli

Request

{
  "alertingTaskID": "a1b2c3d4f5"
}

Response

{
  "workflowID": "a1b2c3d4f5"
}

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

Facts

Rate limit Tier 2 (100 requests per minute)
Categories manage

Request Body

Required

application/json

The alerting validate action validates a new alerting task.

a alerting task (a definition on an alert)

  • application/jsonobject

    a alerting task (a definition on an alert)

    Show application/json properties
    • namestring
      Required

      name associated to alerting task

    • appIdstring
      Required

      appId associated to this alert definition

    • enabledboolean

      if the alerting task is enabled

    • sheetIdstring

      sheetId associated to this alert definition

    • bookmarkIdstring

      bookmarkId associated to this alert definition

    • recipientsobject
      Required

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

      Show recipients properties
      • DLUsersarray
      • userIdsarray of objects
        Required
      • DLGroupsarray
      • DLListIdstring
      • groupIdsarray of objects
    • throttlingobject

      The rules and setup for throttling

      Show throttling properties
      • capacityinteger

        the maximum number of tokens that the bucket can contain

      • timezonestring

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

      • replenishRateinteger

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

      • recurrenceRulestring

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

      • initialTokenCountinteger

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

      • referenceTimestampstring

        a date and time reference specified in RFC3339 format

    • conditionIdstring
      Required

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

    • descriptionstring

      description associated to alerting task

    • triggerTypestring
      Required

      Type of job that triggered the task

      Can be one of: "RELOAD""SCHEDULED"

    • scheduleOptionsobject
      Show scheduleOptions properties
      • timezonestring

        The timezone for time calculations in SCHEDULED triggers, optional.

      • recurrencearray 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.

      • endDateTimestring

        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.

      • startDateTimestring

        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

application/json

Alerting task has been validated successfully.

  • application/jsonobject
    Show application/json properties
    • statusstring

      Can be one of: "FAILURE""SUCCESS"

    • validationsarray of objects
      Show validations properties
      • idstring

        Identifies for user id or condition id

      • typestring

        Identifier for type of a validation error occurring on alerting task

        Can be one of: "RECIPIENT""CONDITION""RECIPIENT_GROUP"

      • errorstringDeprecated

        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"

      • descriptionstring

        Description of the error

      • validationErrorsarray 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

application/json

Bad request, malformed syntax or errors in parameters.

  • application/jsonobject
    Show application/json properties
    • errorsarray of objects
    • traceIdstring

500

application/json

Internal server error.

  • application/jsonobject
    Show application/json properties
    • errorsarray of objects
    • traceIdstring

default

application/json

Error response.

  • application/jsonobject
    Show application/json properties
    • errorsarray of objects
    • traceIdstring
POST /v1/data-alerts/actions/validate
curl "https://your-tenant.us.qlikcloud.com/api/v1/data-alerts/actions/validate" \
-X POST \
-H "Content-type: application/json" \
-H "Authorization: Bearer <API-key>" \
-d '{"name":"string","appId":"string","enabled":true,"sheetId":"string","bookmarkId":"string","recipients":{"DLUsers":[],"userIds":[{}],"DLGroups":[],"DLListId":"string","groupIds":[{}]},"throttling":{"capacity":42,"timezone":"Etc/UTC","replenishRate":42,"recurrenceRule":"string","initialTokenCount":42,"referenceTimestamp":"string"},"conditionId":"string","description":"string","triggerType":"RELOAD","scheduleOptions":{"timezone":"Canada/Pacific","recurrence":["RRULE:FREQ=HOURLY;INTERVAL=2"],"endDateTime":"","startDateTime":"2006-01-02T16:04:05"}}'
const https = require('https')
  const data = JSON.stringify({"name":"string","appId":"string","enabled":true,"sheetId":"string","bookmarkId":"string","recipients":{"DLUsers":[],"userIds":[{}],"DLGroups":[],"DLListId":"string","groupIds":[{}]},"throttling":{"capacity":42,"timezone":"Etc/UTC","replenishRate":42,"recurrenceRule":"string","initialTokenCount":42,"referenceTimestamp":"string"},"conditionId":"string","description":"string","triggerType":"RELOAD","scheduleOptions":{"timezone":"Canada/Pacific","recurrence":["RRULE:FREQ=HOURLY;INTERVAL=2"],"endDateTime":"","startDateTime":"2006-01-02T16:04:05"}})
  const options =   {
    'hostname': 'https://your-tenant.us.qlikcloud.com',
    'port': 443,
    'path': '/api/v1/data-alerts/actions/validate',
    'method': 'POST',
    'headers': {
      'Content-type': 'application/json',
      'Authorization': 'Bearer <API-key>'
    }
  }
  const req = https.request(options)
  req.write(data)
  
This API is not included yet in qlik-cli

Request

{
  "name": "string",
  "appId": "string",
  "enabled": true,
  "sheetId": "string",
  "bookmarkId": "string",
  "recipients": {
    "DLUsers": [],
    "userIds": [
      {}
    ],
    "DLGroups": [],
    "DLListId": "string",
    "groupIds": [
      {}
    ]
  },
  "throttling": {
    "capacity": 42,
    "timezone": "Etc/UTC",
    "replenishRate": 42,
    "recurrenceRule": "string",
    "initialTokenCount": 42,
    "referenceTimestamp": "string"
  },
  "conditionId": "string",
  "description": "string",
  "triggerType": "RELOAD",
  "scheduleOptions": {
    "timezone": "Canada/Pacific",
    "recurrence": [
      "RRULE:FREQ=HOURLY;INTERVAL=2"
    ],
    "endDateTime": "",
    "startDateTime": "2006-01-02T16:04:05"
  }
}

Response

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

Lists alerting settings.

Facts

Rate limit Tier 1 (1000 requests per minute)
Categories manage

Responses

200

application/json

The alerting settings have been successfully returned

  • application/jsonobject
    Show application/json properties
    • tenantIdstring

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

    • dataAlertsLimitsnumber

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

    • dataAlertsConsumednumber

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

    • enable-data-alertingboolean
      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-statusstring

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

      Can be one of: "enabled""disabled"

    • max-recipients-in-target-accessinteger

      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-statusstring

      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-changestring

      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

application/json

Internal server error.

  • application/jsonobject
    Show application/json properties
    • errorsarray of objects
    • traceIdstring

default

application/json

Error response.

  • application/jsonobject
    Show application/json properties
    • errorsarray of objects
    • traceIdstring
GET /v1/data-alerts/settings
curl "https://your-tenant.us.qlikcloud.com/api/v1/data-alerts/settings" \
-H "Authorization: Bearer <API-key>"
const https = require('https')
  const data = JSON.stringify("")
  const options =   {
    'hostname': 'https://your-tenant.us.qlikcloud.com',
    'port': 443,
    'path': '/api/v1/data-alerts/settings',
    'method': 'GET',
    'headers': {
      'Authorization': 'Bearer <API-key>'
    }
  }
  const req = https.request(options)
  
This API is not included yet in qlik-cli

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 Alerting configuration. Accessible only by tenant admins.

Facts

Rate limit Tier 2 (100 requests per minute)
Categories manage

Request Body

Required

application/json

Request for updating the alerting settings

  • application/jsonobject
    Show application/json properties
    • enable-data-alertingboolean
      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

application/json

Bad request body

  • application/jsonobject
    Show application/json properties
    • errorsarray of objects
    • traceIdstring

409

application/json

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

  • application/jsonobject
    Show application/json properties
    • errorsarray of objects
    • traceIdstring

500

application/json

Internal server error.

  • application/jsonobject
    Show application/json properties
    • errorsarray of objects
    • traceIdstring

default

application/json

Error response.

  • application/jsonobject
    Show application/json properties
    • errorsarray of objects
    • traceIdstring
PUT /v1/data-alerts/settings
curl "https://your-tenant.us.qlikcloud.com/api/v1/data-alerts/settings" \
-X PUT \
-H "Content-type: application/json" \
-H "Authorization: Bearer <API-key>" \
-d '{"enable-data-alerting":true}'
const https = require('https')
  const data = JSON.stringify({"enable-data-alerting":true})
  const options =   {
    'hostname': 'https://your-tenant.us.qlikcloud.com',
    'port': 443,
    'path': '/api/v1/data-alerts/settings',
    'method': 'PUT',
    'headers': {
      'Content-type': 'application/json',
      'Authorization': 'Bearer <API-key>'
    }
  }
  const req = https.request(options)
  req.write(data)
  
This API is not included yet in qlik-cli

Request

{
  "enable-data-alerting": true
}