data-alerts

Download specification

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

Endpoints

Skip to section

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

Lists alerting settings.

Responses GET /data-alerts/settings

200 application/json AlertingSettings	The alerting settings have been successfully returned
500 application/json Errors	Internal server error.
default application/json Errors	Error response.

GET/data-alerts/settings

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

Response GET /data-alerts/settings

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

Updates Alerting configuration. Accessible only by tenant admins.

Request Body PUT /data-alerts/settings

application/json

AlertingSettingsUpload

Request for updating the alerting settings

Responses PUT /data-alerts/settings

204 object	Alerting settings have been successfully updated.
400 application/json Errors	Bad request body
409 application/json Errors	Request was denied at this time. This could happen when requesting to disable/enable the feature while there is an ongoing operation to enable/disable the feature
500 application/json Errors	Internal server error.
default application/json Errors	Error response.

PUT/data-alerts/settings

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

Request PUT /data-alerts/settings

{
  "enable-data-alerting": true
}

Get a list of alerting tasks.

Query Parameters GET /data-alerts

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

Responses GET /data-alerts

200 application/json AlertingTaskListResponse	The alerting tasks list has been successfully returned.
400 application/json Errors	Bad request, malformed syntax or errors in parameters.
500 application/json Errors	Internal server error.
default application/json Errors	Error response.

GET/data-alerts

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

Response GET /data-alerts

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

Creates a new alerting task.

Request Body POST /data-alerts

application/json

AlertingTaskCreateRequest

The alerting task create request definition.

Responses POST /data-alerts

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

POST/data-alerts

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

Request POST /data-alerts

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

Response POST /data-alerts

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

Get an alerting task by its id

Path Parameters GET /data-alerts/{alertId}

alertId

string

The alerting task identifier.

Responses GET /data-alerts/{alertId}

200 application/json AlertingTaskResponse	Alert has been successfully returned.
400 application/json Errors	Bad request, malformed syntax or errors in parameters.
404 application/json Errors	Task or execution not found.
500 application/json Errors	Internal server error.
default application/json Errors	Error response.

GET/data-alerts/{alertId}

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

Response GET /data-alerts/{alertId}

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

Deletes an alerting task.

Path Parameters DELETE /data-alerts/{alertId}

alertId

string

The alerting task identifier.

Responses DELETE /data-alerts/{alertId}

204 object	The alerting task has been successfully deleted.
400 application/json Errors	The specified alerting task ID is invalid (e.g. not a number).
404 application/json Errors	An alerting task with the specified ID was not found.
500 application/json Errors	Internal server error.
default application/json Errors	Error response.

DELETE/data-alerts/{alertId}

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

Updates an existing alerting task

Path Parameters PATCH /data-alerts/{alertId}

alertId

string

The alerting task identifier.

Request Body PATCH /data-alerts/{alertId}

application/json

Array<AlertingTaskPatchRequestCompliant>

Patch request definition for an alerting task.

Responses PATCH /data-alerts/{alertId}

204 object	The alerting task has been successfully updated.
400 application/json Errors	The specified alerting task ID or body is invalid (e.g. not a number).
404 application/json Errors	An alerting task with the specified ID was not found.
500 application/json Errors	Internal server error.
default application/json Errors	Error response.

PATCH/data-alerts/{alertId}

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

Request PATCH /data-alerts/{alertId}

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

Get the condition associated with an alerting task

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

alertId

string

The alerting task identifier.

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

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

GET/data-alerts/{alertId}/condition

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

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

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

Get the recipient stats for an alerting task

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

alertId

string

The alerting task identifier.

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

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

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

200 application/json AlertingRecipientStatsResponse	Alert recipient stats have been successfully returned.
400 application/json Errors	Bad request, malformed syntax or errors in parameters.
404 application/json Errors	Task or execution not found.
500 application/json Errors	Internal server error.
default application/json Errors	Error response.

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

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

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

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

Gets the stats for alerting task executions

deprecated

experimental

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

taskId

string

The alerting task identifier.

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

period

string

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

Enum:

month

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

200 application/json AlertingTaskAggregatedEvaluationStats	Evaluation successfully returned.
404 application/json Errors	A task or execution with the specified ID was not found.
500 application/json Errors	Internal server error.
default application/json Errors	Error response.

GET/data-alerts/{taskId}/stats

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

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

{
  "undefined": {
    "executionsStats": [
      {
        "startTime": "string",
        "endTime": "string",
        "totalExecutions": 0,
        "triggeredExecutions": 0,
        "periodKey": "string"
      }
    ]
  }
}

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

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

taskId

string

The alerting task identifier.

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

triggered optional boolean	Filter by whether the alerting task is triggered.
conditionStatus optional string	Filter by whether the alerting task execution status is FINISHED or FAILED. Enum: FINISHED FAILED ALL
conditionId optional string	Filter by condition id related to the executions.
limit optional, default=20, minimum=1, maximum=100 integer	Limit the returned result set
offset optional integer	Offset for pagination - how many elements to skip
sort optional Array<string>	No description Enum: triggertime -triggertime +triggertime
next optional string	The cursor to the next page of data. Only one of next or previous may be specified.
prev optional string	The cursor to the previous page of data. Only one of next or previous may be specified.
daysOfWeek optional Array<string>	Specifies a filter for custom handled periods of time in which the executions were handled Enum: MONDAY TUESDAY WEDNESDAY THURSDAY FRIDAY SATURDAY SUNDAY
timezone optional string	Specifies a timezone the other time-based filters in this query should consider. Expecting a momentjs format, such as America/Los_Angeles
daysOfMonth optional Array<integer>	Specifies required days of the month that the execution was created in
since optional string	Specifies a date that executions should have been created after. Date in RFC3339Nano format, such as 2020-01-01T00:00:00.000Z
until optional string	Specifies a date that executions should have been created before. Date in RFC3339Nano format, such as 2020-01-01T00:00:00.000Z
searchResultsLimit optional integer	Specifies a limit number for the search query, affects total count and is not related to pagination
minimumGapDays optional integer	Specifies the number of days required between each entry. This should require a sort by triggertime
fields optional Array<string>	Specifies specific properties to be populated Enum: evaluationId triggerTime conditionStatus executionEvaluationStatus evaluation evaluation.endTime evaluation.resultData evaluation.resultData.count evaluation.resultData.headers evaluation.resultData.positive evaluation.resultData.negative evaluation.resultData.dimensions evaluation.resultData.measures
includeEvaluation optional boolean	Specifies whether to include evaluation details
lastEachDay optional boolean	Specifies whether to only show the last execution in each day

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

200 application/json AlertingExecutionListResponse	The alerting-executions list has been successfully returned.
400 application/json Errors	Bad request, malformed syntax or errors in parameters.
404 application/json Errors	Task or execution not found.
500 application/json Errors	Internal server error.
default application/json Errors	Error response.

GET/data-alerts/{taskId}/executions

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

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

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

Gets a specified alerting execution.

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

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

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

200 application/json AlertingExecutionResponse	The execution has been successfully returned.
400 application/json Errors	The specified task or execution ID is invalid (e.g. not a number).
404 application/json Errors	Task or execution not found.
500 application/json Errors	Internal server error.
default application/json Errors	Error response.

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

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

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

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

Deletes an execution.

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

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

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

204 object	The execution has been successfully deleted.
400 application/json Errors	The specified task or execution ID is invalid (e.g. not a number).
404 application/json Errors	Task or execution not found.
500 application/json Errors	Internal server error.
default application/json Errors	Error response.

DELETE/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>"

Gets the content of an evaluation from an execution

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

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

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

200 application/json EvaluationGetResponse	Evaluation successfully returned.
404 application/json Errors	A task or execution with the specified ID was not found.
500 application/json Errors	Internal server error.
default application/json Errors	Error response.

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

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

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

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

Gets the stats for alerting task executions

deprecated

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

taskId

string

The alerting task identifier.

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

period

string

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

Enum:

month

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

200 application/json AlertingTaskExecutionStats	Evaluation successfully returned.
404 application/json Errors	A task or execution with the specified ID was not found.
500 application/json Errors	Internal server error.
default application/json Errors	Error response.

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

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

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

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

Creates a new alerting trigger action.

Request Body POST /data-alerts/actions/trigger

application/json

AlertingActionsTriggerCreateRequest

The alerting trigger action create request definition.

Responses POST /data-alerts/actions/trigger

202 application/json AlertingActionsTriggerCreateResponse	Action has been successfully done. Request to eventing was successfully triggered.
400 application/json Errors	Bad request, malformed syntax or errors in parameters.
500 application/json Errors	Internal server error.
default application/json Errors	Error response.

POST/data-alerts/actions/trigger

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

Request POST /data-alerts/actions/trigger

{
  "alertingTaskID": "a1b2c3d4f5"
}

Response POST /data-alerts/actions/trigger

{
  "workflowID": "a1b2c3d4f5"
}

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

Request Body POST /data-alerts/actions/validate

application/json

AlertingTaskCreateRequest

The alerting validate action validates a new alerting task.

Responses POST /data-alerts/actions/validate

200 application/json AlertingTaskValidationResponse	Alerting task has been validated successfully.
400 application/json Errors	Bad request, malformed syntax or errors in parameters.
500 application/json Errors	Internal server error.
default application/json Errors	Error response.

POST/data-alerts/actions/validate

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

Request POST /data-alerts/actions/validate

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

Response POST /data-alerts/actions/validate

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

JsonPatches

Array<JsonPatch>

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

Properties

op string	The operation to be performed. Enum: replace remove add
path string	The path for the given resource field to patch.
value optional object	The value to be used for this operation.

SharingSettings

object

Properties

tenantId optional string	These persisted sharing settings are only available for this tenant. Extracted from request JWT.
enable-sharing boolean	Whether API endpoints for sharing are enabled
enable-report-subscription boolean	true if report-subscription feature is enabled for this tenant
maxRecipients optional number	Maximum number of recipients when creating a sharing task
maxSubscriptionRecipients optional integer	Max Recipients accepted when creating a new subscription (excluding the owner)
reportSubscriptionStatus optional string	This indicates that there is an ongoing operation to either disable or enable the report subscription feature. none means that no such operation is ongoing. enabling/disabling means that system is currently enabling/disabling the feature Enum: none enabling disabling
reportSubscriptionStatusChangeTime optional string	UTC timestamp of the most recent change of reportSubscriptionStatus. If there has not been any such change, this is the timestamp of the initial creation of the record.

APISettingsUpload

object

Properties

enable-sharing boolean	Whether API endpoints for sharing are enabled
maxRecipients optional number	Maximum number of recipients when creating a sharing task

SharingSettingsPatchCompliantList

Array<SharingSettingsPatchCompliant>

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

Properties

op string	The operation to be performed. Enum: replace
path string	The path for the given resource field to patch. Enum: /enable-sharing /enable-report-subscription
value optional object	The value to be used for this operation.

SharingSettingsPatchCompliant

object

Properties

op string	The operation to be performed. Enum: replace
path string	The path for the given resource field to patch. Enum: /enable-sharing /enable-report-subscription
value optional object	The value to be used for this operation.

SharingSettingsPatch

object

Properties

enable-sharing boolean	true to enable the chart sharing via email feature, false to disable it
enable-report-subscription boolean	true to enable report subscription feature, false to disable it. A status change could potentially result in a considerable amount of API operations to enable/disable chronos jobs.

AlertingSettings

object

Properties

tenantId optional string	These persisted alerting settings are only available for this tenant. Extracted from request JWT.
enable-data-alerting boolean	true if data-alerting feature is enabled for this tenant. Enabling this feature also requires that the license has this feature enabled.
data-alerting-license-status optional string	Whether the license for the tenant has the data alerting feature enabled. Enum: enabled disabled
data-alerting-feature-operation-status optional string	This indicates that there is an ongoing operation to either disable or enable the data alerting feature. none means that no such operation is ongoing. enabling/disabling means that system is currently enabling/disabling the feature Enum: none enabling disabling
data-alerting-feature-operation-status-change optional string	UTC timestamp of the most recent change of data-alerting-feature-operation-status. If there has not been any such change, this is the timestamp of the initial creation of the record.
max-recipients-in-target-access optional integer	The maximum number of recipients that can be present in an alerting task in TARGET_ACCESS mode. New recipients cannot be added when this limit is exceeded
dataAlertsConsumed optional number	Represents the number of data alerts consumed by the user either as an owner or recipient
dataAlertsLimits optional number	Represents the number of data alerts limit to be consumed by the user either as an owner or recipient

AlertingSettingsUpload

object

Properties

enable-data-alerting

boolean

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

TemplatePersist

object

Depending on the value of type, sharing service will internally validate a specific property regarding its data. Type "file" validates property "fileData", type "chart" validates property "chartData", type "story" validates property "storyData". Check description of each of the models for their required properties.

Properties

type string	No description Enum: file chart story sheet multi-sheet
subType optional, default='image' string	No description Enum: image snapshot pdf
fileAlias optional string	fileAlias provide an opaqueId for the client which can be used to filter and select the report generated
templateId optional string	ID of unique template
storyData optional StoryTemplate	No description
chartData optional ChartTemplate	If the template type is not "chart", this can be null. Otherwise, the following properties are required: appId, sheetId, objectId, widthPx, heightPx, language. The following properties are optional: outZoom, outDpi
sheetData deprecated optional SheetTemplate	No description
multiSheetData optional Array<MultiSheetTemplate>	array of sheet data for multi-sheet type template

TemplateResult

Properties

type string	No description Enum: file chart story sheet multi-sheet
subType default='image' string	No description Enum: image snapshot pdf
fileAlias string	fileAlias provide an opaqueId for the client which can be used to filter and select the report generated
templateId string	ID of unique template
storyData StoryTemplate	No description
chartData ChartTemplate	If the template type is not "chart", this can be null. Otherwise, the following properties are required: appId, sheetId, objectId, widthPx, heightPx, language. The following properties are optional: outZoom, outDpi
sheetData deprecated SheetTemplate	No description
multiSheetData Array<MultiSheetTemplate>	array of sheet data for multi-sheet type template

InsightURL

object

In case of multiple insight urls for multi-sheet sharing (or subsequent multi types) this defines those URLs and a mapping to the correct object.

Properties

directURL string	No description
fallbackURL string	No description
insightID string	No description
templateID string	an identifier for the template that this insight link points to
resourceID string	an identifier for the object within the template that this insight link points to
status string	the status of the creation for this insight URL Enum: successful failed

ReportPersist

object

Properties

id string	Gets the report identifier.
links optional Links	No description
type string	Report Type (file, chart, story) Enum: file chart story sheet
subType string	File type for report
executionID string	The execution to which this report belongs
userID string	The user which this report belongs to
data Array<BinaryData>	No description

ReportResult

SharingExecutionPersist

object

Properties

id string	Gets the execution identifier.
files Array<SharingExecutionFile>	No description
tenantId string	The tenant that this execution belongs to
ownerId string	Owner of the execution
appId string	appId associated to sharing task execution
reloadId string	If this execution was triggered by an app reload. This will contain the reloadId from reloads service. Otherwise it is empty or omitted.
reloadTime string	If this execution was triggered by an app reload. This will contain the reload time to compare with reporting service when the report is requested.
status string	Status of the task execution Enum: initialized in-progress successful failed cancelled invalid presuccessful
totalCount integer	Total count of reports in this execution
successCount integer	Total count of successfully generated reports in this execution
failedCount integer	Total count of failed reports in this execution
startTime string	Timestamp of execution start
endTime string	Timestamp of execution successful stop
failedTime string	Timestamp of execution stop
sharingTaskID string	ID for the sharing task that this execution references
eventID string	eventID of the chronos NATS event
workflowID string	Workflow that the execution belongs to. Note that in a multi-recipient context we can have multiple executions (one per recipient) that share the same unique workflow.
errors Array<SharingExecutionError>	No description

SharingTasksRecipientStatsResponse

object

Properties

recipientStats

Array<SharingTasksRecipientStats>

No description

SharingTasksRecipientStats

object

Properties

type string	No description Enum: userid
value string	No description
enabled boolean	Whether the recipient is enabled.
subscribed boolean	Whether the recipient is subscribed.
lastExecutionTime string	last time an execution had been executed for this recipient
nextExecutionTime string	next time an execution will be executed for this recipient
errors Array<TaskRecipientError>	No description

SharingExecutionResponse

Properties

id string	Gets the execution identifier.
files Array<SharingExecutionFile>	No description
tenantId string	The tenant that this execution belongs to
ownerId string	Owner of the execution
appId string	appId associated to sharing task execution
reloadId string	If this execution was triggered by an app reload. This will contain the reloadId from reloads service. Otherwise it is empty or omitted.
reloadTime string	If this execution was triggered by an app reload. This will contain the reload time to compare with reporting service when the report is requested.
status string	Status of the task execution Enum: initialized in-progress successful failed cancelled invalid presuccessful
totalCount integer	Total count of reports in this execution
successCount integer	Total count of successfully generated reports in this execution
failedCount integer	Total count of failed reports in this execution
startTime string	Timestamp of execution start
endTime string	Timestamp of execution successful stop
failedTime string	Timestamp of execution stop
sharingTaskID string	ID for the sharing task that this execution references
eventID string	eventID of the chronos NATS event
workflowID string	Workflow that the execution belongs to. Note that in a multi-recipient context we can have multiple executions (one per recipient) that share the same unique workflow.
errors Array<SharingExecutionError>	No description
links Links	No description
fileLocations Array<string>	No description

SharingExecutionFile

object

Properties

tempContentsLocation string	No description
fileID string	No description
fileAlias string	No description
type string	No description Enum: image pdf
userId string	userId associated with the file

SharingExecutionListResponse

Properties

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

SharingExecutionStatus

object

Properties

links optional Links	No description
status string	Status of the task execution

SharingTaskRecurringRecipients

object

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

Properties

userIds

Array<UserIDRecipient>

No description

SharingTaskRecurringRecipient

object

Single recipient to be subscribed/unsubscribed. If present, the whole list SharingTaskRecipients takes the precedence over it.

Properties

userId string	User ID of recipient (internal user).
subscribed boolean	Whether this recipient is subscribed to alerts of a task

SharingTaskRecipients

object

List of recipients. For internal user a list of userids, for external users a list of email addresses.

Properties

emails Array<string<email>>	No description
userids Array<string>	No description

RecipientsPersist

object

List of persisted recipients.

Properties

userIds Array<UserIDRecipientPersist>	No description
groupIds Array<GroupIDRecipientPersist>	No description

Recipients

object

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

Properties

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

UserIDRecipientPersist

object

recipient object model that is directly persisted in the DB

Properties

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

GroupIDRecipientPersist

object

recipient object model that is directly persisted in the DB

Properties

value string	Group ID of recipient.
enabledByUser boolean	Whether this recipient can receive alerts, set by api calls.
enabledBySystem boolean	Whether this recipient can receive alerts, set by external settings.
alertingTaskGroupRecipientErrors Array<AlertingTaskGroupRecipientError>	No description
taskGroupRecipientErrors Array<TaskGroupRecipientError>	No description

UserIDRecipient

object

an internal recipient based on its user id.

Properties

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

GroupIDRecipient

object

an internal recipient based on its group id.

Properties

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

EmailRecipientPersist

object

Properties

value string<email>	Email of recipient (external user).
enabled boolean	Whether this recipient can receive alerts.

SharingTaskOnetime

object

Properties

id optional string	Gets the sharing task resource identifier.
template TemplateResult	No description
recipients optional SharingTaskRecipients	List of recipients. For internal user a list of userids, for external users a list of email addresses.
owner optional string	User id of the sharing task owner
tenant optional string	Tenant of the sharing task
message optional string	Message along with sharing task
creation-time optional string	Timestamp for the creation of the task
state optional State	State of the selections and jsOpts

SharingTaskOnetimeCreate

object

Properties

template TemplateResult	No description
recipients optional SharingTaskRecipients	List of recipients. For internal user a list of userids, for external users a list of email addresses.
message optional string	Message along with sharing task
state optional State	State of the selections and jsOpts

State

object

State of the selections and jsOpts

Properties

selections Array<Selection>	No description
fields Array<object>	Selected fields that led to discovery of monitored Insight Advisor chart
queryItems Array<object>	Query that led to discovery of monitored Insight Advisor chart

EncryptedProperty

object

Encrypted property in DB

Properties

value	No description
cipher string	No description

SharingTaskRecurringResponse

Whatever is persisted in the db + links

Properties

id string	Gets the sharing task resource identifier.
type string	the sharing task resource type. Enum: office-template-sharing chart-monitoring chart-sharing sheet-sharing
executeOnCreation boolean	making this true will execute the sharing task upon creation regardless of next trigger
tags Array<string>	No description
dateCreated string	Timestamp for the creation of the task
name string	Name of this sharing task
appName string	Name of the app associated (through the templates) with this sharing task
appId string	ID of the app associated (through the templates) with this sharing task
description string	A description of this sharing task
statusCode string	the status of this recurring sharing task Enum: CHART_NOT_FOUND APP_NOT_FOUND STORY_NOT_FOUND SHEET_NOT_FOUND ENGINE_POD_NOT_AVAILABLE APP_FORBIDDEN CHART_TYPE_NOT_ALLOWED FAILED DELETING IN_PROGRESS VALID
statusLabel string	error message indicating the underlying failure
enabledByUser boolean	Toggle for enabling sharing task (user level). Example: user chooses to enable/ disable task.
enabledBySystem boolean	Toggle for enabling sharing task (system level). Example: when task owner gets enabled/ disabled.
message string	Message along with sharing task
owner string	User id of owner of the sharing task
tenant string	Tenant of the sharing task
startTime string	Time to start capturing the history
expiration string	Time for the termination of the task
lastRun string	The last execution start date time timestamp of the task
nextScheduledRun string	Time for the next scheduled run
reportProperties object	No description
trigger Trigger	No description
scheduleOptions ScheduleOptions	No description
thumbnail string	No description
createdBy string	ID of creator
multiInsightURLs Array<InsightURL>	Contains one or more insight links. Currently only used in multi sheet scenarios. Sharing will ensure that the persisted sort order is aligned to the order of sheets provided.
insightDirectURL string	The direct insights URL for the first template of this sharing task. (currently not used in multi-sheet scenarios)
insightFallbackURL string	The insights fallback URL for the first template of this sharing task. (currently not used in multi-sheet scenarios)
insightID string	The identifier for the insight URLs in this sharing task. Needed to remove the permanent insight upon task deletion. (currently not used in multi-sheet scenarios)
lastExecutionDate string	The last execution end date time timestamp of the task
templates Array<TemplateResult>	No description
encryptedTemplates EncryptedProperty	Encrypted property in DB
state State	State of the selections and jsOpts
encryptedState EncryptedProperty	Encrypted property in DB
retentionPolicy RetentionPolicy	No description
selectionErrors object	reporting service returns rendering errors for missing selections
recipients RecipientsPersist	List of persisted recipients.
taskErrors Array<TaskError>	No description
lastUpdated string	Timestamp of the most recent update.
ownerName string	User name of owner of the sharing task
isCandidateForVerification boolean	true if the sharing task is a candidate for verification
failedVerificationsCount integer	the number of failed verifications. This is reset on a successful verification
failedExecutionsCount integer	the number of consecutive failed executions for all recipeints. This is reset on a successful execution for at least one recipient
latestExecutionURL string	URL to querying the latest execution tied to this sharing task
latestExecutionFilesURL Array<string>	URL to querying the files of the latest execution tied to this sharing task
links Links	No description
enabled boolean	true if the sharing task is enabled

SharingTaskRecurringResponseLite

object

ID of the sharing task + links

Properties

id string	Gets the sharing task resource identifier.
links optional Links	No description

SharingTaskRecurringPersist

object

Type of object stored in the database. Required fields mean that property cannot be null

Properties

id string	Gets the sharing task resource identifier.
type string	the sharing task resource type. Enum: office-template-sharing chart-monitoring chart-sharing sheet-sharing
executeOnCreation boolean	making this true will execute the sharing task upon creation regardless of next trigger
tags Array<string>	No description
dateCreated string	Timestamp for the creation of the task
name string	Name of this sharing task
appName string	Name of the app associated (through the templates) with this sharing task
appId string	ID of the app associated (through the templates) with this sharing task
description string	A description of this sharing task
statusCode string	the status of this recurring sharing task Enum: CHART_NOT_FOUND APP_NOT_FOUND STORY_NOT_FOUND SHEET_NOT_FOUND ENGINE_POD_NOT_AVAILABLE APP_FORBIDDEN CHART_TYPE_NOT_ALLOWED FAILED DELETING IN_PROGRESS VALID
statusLabel string	error message indicating the underlying failure
enabledByUser boolean	Toggle for enabling sharing task (user level). Example: user chooses to enable/ disable task.
enabledBySystem boolean	Toggle for enabling sharing task (system level). Example: when task owner gets enabled/ disabled.
message string	Message along with sharing task
owner string	User id of owner of the sharing task
tenant string	Tenant of the sharing task
startTime string	Time to start capturing the history
expiration string	Time for the termination of the task
lastRun string	The last execution start date time timestamp of the task
nextScheduledRun string	Time for the next scheduled run
reportProperties optional object	No description
trigger optional Trigger	No description
scheduleOptions optional ScheduleOptions	No description
thumbnail string	No description
createdBy string	ID of creator
multiInsightURLs Array<InsightURL>	Contains one or more insight links. Currently only used in multi sheet scenarios. Sharing will ensure that the persisted sort order is aligned to the order of sheets provided.
insightDirectURL string	The direct insights URL for the first template of this sharing task. (currently not used in multi-sheet scenarios)
insightFallbackURL string	The insights fallback URL for the first template of this sharing task. (currently not used in multi-sheet scenarios)
insightID string	The identifier for the insight URLs in this sharing task. Needed to remove the permanent insight upon task deletion. (currently not used in multi-sheet scenarios)
lastExecutionDate string	The last execution end date time timestamp of the task
templates Array<TemplateResult>	No description
encryptedTemplates optional EncryptedProperty	Encrypted property in DB
state optional State	State of the selections and jsOpts
encryptedState optional EncryptedProperty	Encrypted property in DB
retentionPolicy optional RetentionPolicy	No description
selectionErrors optional object	reporting service returns rendering errors for missing selections
recipients optional RecipientsPersist	List of persisted recipients.
taskErrors Array<TaskError>	No description
lastUpdated string	Timestamp of the most recent update.
ownerName string	User name of owner of the sharing task
isCandidateForVerification boolean	true if the sharing task is a candidate for verification
failedVerificationsCount integer	the number of failed verifications. This is reset on a successful verification
failedExecutionsCount integer	the number of consecutive failed executions for all recipeints. This is reset on a successful execution for at least one recipient

SharingTaskRecurringCreateRequest

object

Properties

name string	Name of this sharing task
appName string	Name of the app associated (through the templates) with this sharing task
type string	the sharing task resource type. Enum: office-template-sharing chart-monitoring chart-sharing sheet-sharing
tags optional Array<string>	used to assign sharing task to a collection bucket (tags)
executeOnCreation optional, default=true boolean	making this true will execute the sharing task upon creation regardless of next trigger
enabled optional, default=true boolean	Toggle for enabling sharing task.
message optional string	Message along with sharing task
description optional string	Description of the sharing task
expiration optional string	Timestamp for the termination of the task
trigger optional Trigger	No description
scheduleOptions optional ScheduleOptions	No description
templates Array<TemplateResult>	No description
state optional State	State of the selections and jsOpts
recipients optional SharingTaskRecurringRecipients	List of recipients. An internal recipient is represented by their user id.
startTime optional string	Time to start capturing the history
retentionPolicy optional RetentionPolicy	No description

Trigger

object

Properties

chronosJobID optional string	The chronosJobId which triggers the sharing task
executeOnAppReload optional, default=true boolean	Toggle for executing sharing task on app reload.
recurrence Array<string>	List of RRULE lines for a recurring event, as specified in RFC5545. Note that DTSTART and DTEND, UNTIL lines are not allowed in this field; event 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. This field is omitted for single events.
executionHistoryInterval optional string	To prevent overflow in the history, setting this to daily store the chart of a previous day in the history and maintain the live version with the tag latest. Enum: minutely hourly daily weekly monthly quarterly yearly

Selection

object

Properties

isNumeric boolean	No description
name string	No description
displayName optional string	No description
values Array<string>	No description
displayValues optional Array<string>	No description
stateName string	No description

SharingTaskRecurringListResponse

Properties

totalCount integer	total count of entries in the collection as a whole
currentPageCount integer	count of entries on the currently shown page
sharingTasks Array<SharingTaskRecurringResponse>	Gets a list of recurring sharing tasks.
links ListLinks	No description
recipients SharingTaskRecurringRecipients	List of recipients. An internal recipient is represented by their user id.

SharingTaskPatchRequestCompliantList

Array<SharingTaskRecurringPatchRequestCompliant>

Properties

op string	The operation to be performed Enum: replace
path string	A JSON Patch document as defined in http://tools.ietf.org/html/rfc6902 Enum: /name /tags /ownerId /enabled /description /scheduleOptions /templates /recipients /recipient
value optional object	The value to be used for this operation.

SharingTaskRecurringPatchRequestCompliant

object

Properties

op string	The operation to be performed Enum: replace
path string	A JSON Patch document as defined in http://tools.ietf.org/html/rfc6902 Enum: /name /tags /ownerId /enabled /description /scheduleOptions /templates /recipients /recipient
value optional object	The value to be used for this operation.

SharingTaskRecurringPatchRequest

object

Properties

name string	Name of sharing task
tags Array<string>	Used to assign sharing task to a collection bucket (tags)
ownerID string	the new owner of this task. This change is allowed only for the owner
enabled boolean	to enable or disable the task. The change is allowed only for the owner
description string	Description of the sharing task
scheduleOptions optional ScheduleOptions	No description
templates Array<TemplateResult>	The templates to be applied.
recipients optional SharingTaskRecurringRecipients	List of recipients. An internal recipient is represented by their user id.
recipient optional SharingTaskRecurringRecipient	Single recipient to be subscribed/unsubscribed. If present, the whole list SharingTaskRecipients takes the precedence over it.

FileTemplatePersist

object

Properties

id string	Gets the file template resource identifier.
name string	Name of file template
dateCreated string	Timestamp for file template creation
owner string	Owner of file template
tenantId string	Tenant ID
templateType string	Type of template.
subType string	SubType of template.
valid boolean	Result of the file template validation
fileId string	ID of the file it references
storageEngine string	storage engine identifier
size integer	the size of the file in bytes
contentType string	The content type of the file

FileTemplateCreate

FileTemplateGetResult

Properties

id string	Gets the file template resource identifier.
name string	Name of file template
dateCreated string	Timestamp for file template creation
owner string	Owner of file template
tenantId string	Tenant ID
templateType string	Type of template.
subType string	SubType of template.
valid boolean	Result of the file template validation
fileId string	ID of the file it references
storageEngine string	storage engine identifier
size integer	the size of the file in bytes
contentType string	The content type of the file
links Links	No description

FileTemplateCreateResult

object

Properties

id string	ID of the created file template
links optional Links	No description

FileTemplatesListResult

object

Properties

fileTemplates Array<FileTemplateGetResult>	Gets a list of file templates.
links optional ListLinks	No description

FileTemplatesUploadFileResult

object

Properties

id string	ID of the uploaded file
links optional Links	No description

ChartTemplate

object

If the template type is not "chart", this can be null. Otherwise, the following properties are required: appId, sheetId, objectId, widthPx, heightPx, language. The following properties are optional: outZoom, outDpi

Properties

appId string	ID of app
sheetId string	sheetId of app
objectId string	ID of object
objectDef optional object	Session chart object definition
widthPx integer	widthPx of chart
heightPx integer	heightPx of chart
outZoom number	outZoom of chart
outDpi integer	outDpi of chart
jsOpts optional object	Visualization state from client as a string json value. Can include language, theme, viewState etc.
patches Array<object>	Soft property changes on chart

StoryTemplate

object

Properties

appId string	ID of app
storyId string	ID of story

SheetTemplate

object

deprecated

Properties

appId string	ID of app
sheetId string	ID of sheet
widthPx integer	widthPx of chart
heightPx integer	heightPx of chart
sheetName deprecated string	an optional name for the sheet (used in multi-sheet sharing)
isPrivate deprecated boolean	optional value to indicate that this sheet is private (used in multi-sheet sharing)
jsOpts optional object	Sheet state from client as a string json value. Can include language, theme, viewState etc.
jsOptsById object	No description
patchesById object	No description

MultiSheetTemplate

object

Properties

appId string	ID of app
sheetId string	ID of sheet
widthPx integer	widthPx of chart, must be 0 or omitted for autofit.
heightPx integer	heightPx of chart, must be 0 or omitted for autofit.
resizeType string	Currently only autofit is supported. If omitted, autofit is the default. The type of resize to be performed: none is used to export a visualization, sheet as is (e.g. normal size), regardless its size. This may result in cropping. autofit automatically fits the visualization, sheet into the output size (i.e. A4, A3 etc.). Any provided resizeData parameter will be ignored for this configuration. fit fits the visualization, sheet into the area specified in resizeData. The content will be rescaled to fit in that area. Enum: none fit autofit
sheetName string	an optional name for the sheet
isPrivate boolean	optional value to indicate that this sheet is private
jsOpts optional object	Sheet state from client as a string json value. Can include language, theme, viewState etc.
jsOptsById object	No description
patchesById object	No description

ListLinks

object

Properties

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

Self

object

Object with Href to a particular element or set of elements

Properties

href

string

No description

Page

object

Properties

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

Error

object

Properties

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

Errors

object

Properties

errors Array<Error>	No description
traceId string	No description

SharingExecutionError

object

Properties

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

SharingExecutionErrors

Array<SharingExecutionError>

Properties

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

BinaryData

object

Properties

fileId string	ID of the file it references
storageEngine string	storage engine identifier
size integer	the size of the file in bytes
contentType string	The content type of the file

RetentionPolicy

object

Properties

historySize integer	Number indicating the size of the window which stores the history. For Chart monitoring, the size should be 10.
overrideInterval default='FREQ=DAILY;INTERVAL=1' string	Using RFC-5545 provide the time interval in which the previous generated can be overridden with the newly generated report. For Chart monitoring, interval should be FREQ=DAILY;INTERVAL=1

AlertingTaskCreateRequest

object

a alerting task (a definition on an alert)

Properties

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

AlertingTaskPersist

object

a alerting task (a definition on an alert)

Properties

id string	data alerting identifier (this is the alertID)
name string	name associated to alerting task
enabledBySystem boolean	true if the alerting task is enabled by system (a task needs to be both enabled by system and user, to be considered enabled)
enabledByUser boolean	true if the alerting task is enabled by user (a task needs to be both enabled by system and user, to be considered enabled)
description string	description associated to alerting task
appId string	appId associated to this alert definition
sheetId string	sheetId associated to this alert definition
spaceId string	spaceId of the app associated to this alert definition
hasHistoryCondition boolean	true if the alert has history condition enabled
hasSectionAccess boolean	true if the associated app has section access enabled
bookmarkId string	bookmarkId associated to this alert definition
lastTrigger string	last time an execution had been created for requesting user
lastScan string	last time a trigger was detected, but not sure if executed for requesting user
status string	particular status of the alerting task Enum: creating valid invalid deleting
errorStatus string	error labels from the latest workflow that happened within the task Enum: OK FATAL-ERROR PARTIAL-TRIGGER
throttling optional ThrottlingResource	The rules and setup for throttling
recipients optional RecipientsPersist	List of persisted recipients.
recipientsChangeHistory Array<RecipientsChange>	No description
accessMode string	No description Enum: SOURCE_ACCESS TARGET_ACCESS
conditionId string	the id of the condition that determines if this data alert should be triggered
ownerId string	the owner of this alert
ownerName string	the owner name of this alert
tenantId string	the tenant of this alert
dateCreated string	Timestamp for the creation of the task (rfc3339 format)
lastUpdated string	Timestamp of the most recent update.
triggerType string	Type of job that triggered the task Enum: RELOAD SCHEDULED MANUAL
scheduleOptions optional ScheduleOptions	No description
underGoingConversion boolean	set to true if this task is undergoing conversion
underGoingConversionUpdated string	A RFC3339 UTC timestamp for them the undergoingConversion status was updated. Empty fields means that it never was updated.
underGoingConversionLastEventID string	The eventID that last triggered a conversion.
isCandidateForOptimization boolean	set to true if this task is a candate task to be optimized from TARGET_ACCESS to SOURCE_ACCESS
evaluationErrors optional EvaluationErrors	No description
alertingTaskErrors Array<AlertingTaskError>	No description
isCandidateForVerification boolean	true if the alerting task is a candidate for verification
failedVerificationsCount integer	the number of failed verifications. This is reset on a successful verification
evaluationCount integer	the number of actual evaluations with engine this task has consumed in the current month
lastEvaluationCountUpdate string	the date when the evaluation count was updated

AlertingTaskResponse

object

Properties

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

AlertingTaskValidationResponse

object

Properties

status

string

No description

Enum:

FAILURE

SUCCESS

validations

Array<AlertingTaskValidation>

No description

AlertingTaskTriggerStats

object

Properties

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

AlertingRecipientStatsResponse

object

Properties

recipientStats

Array<AlertingRecipientStats>

No description

AlertingRecipientStats

object

Properties

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

AlertingRecipientStatsErrors

Array<AlertingRecipientStatsError>

Properties

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

AlertingRecipientStatsError

object

Properties

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

AlertingTaskResponseLite

object

Properties

id string	data alerting identifier (this is the alertID)
links optional Links	No description

AlertingTaskListResponse

Properties

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

ExecutionStats

object

Properties

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

ExecutionStatsAggregated

object

Properties

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

AlertingTaskExecutionStats

deprecated

Properties

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

AlertingTaskAggregatedEvaluationStats

Properties

executionsStats

Array<ExecutionStatsAggregated>

No description

AlertingTaskPatchRequest

object

Properties

ownerName string	No description
ownerId string	No description
conditionId string	No description
enabledAction string	Specify ENABLED or DISABLED if you want enable or disable the alerting task Enum: ENABLED DISABLED
bookmarkId default='NA' string	Id of the bookmark associated with an alert
name string	name associated to alerting task
description string	description associated to alerting task
throttling optional ThrottlingResource	The rules and setup for throttling
recipients Array<AlertingTaskRecipientPatch_inner>	A custom custom JSON Patch document, as an array of objects with operation, recipient type and value. Original defined in https://datatracker.ietf.org/doc/html/rfc6902.
triggerType string	Type of job that triggered the task Enum: RELOAD SCHEDULED
scheduleOptions optional ScheduleOptions	No description

AlertingTaskPatchRequestCompliantList

Array<AlertingTaskPatchRequestCompliant>

Properties

op string	The operation to be performed Enum: replace
path string	A JSON Patch document as defined in https://datatracker.ietf.org/doc/html/rfc6902 Enum: /ownerName /ownerId /conditionId /enabledAction /bookmarkId /name /description /throttling /triggerType /scheduleOptions
value optional object	The value to be used for this operation.

AlertingTaskPatchRequestCompliant

object

Properties

op string	The operation to be performed Enum: replace
path string	A JSON Patch document as defined in https://datatracker.ietf.org/doc/html/rfc6902 Enum: /ownerName /ownerId /conditionId /enabledAction /bookmarkId /name /description /throttling /triggerType /scheduleOptions
value optional object	The value to be used for this operation.

AlertingExecutionListResponse

Properties

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

AlertingExecutionResponse

Properties

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

AlertingConditionResponse

object

Properties

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

AlertingExecutionPersist

object

Properties

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

EvaluationErrors

object

Properties

errors Array<EvaluationError>	No description
failCount integer	amount of failed evaluation errors received

EvaluationError

object

Properties

code string	Error code specific to condition smanager.
status	Error status.
title string	Error title.
meta optional EvaluationError_meta	No description

AlertingExecutionErrors

Array<AlertingExecutionError>

Properties

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

AlertingExecutionResult

object

Properties

alertTriggerStatus string	No description
throttlerTokensLeft integer	No description

AlertingExecutionError

object

Properties

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

ThrottlingResource

object

The rules and setup for throttling

Properties

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

NatsEvent

object

defines an event that will be transmitted of NATS.

Properties

subject string	the subject of the nats event. (in a system event this will be the eventType field)
data string	valid json-data that will will be the payload of the transmitted nats event.

AlertingAppData

object

metadata about the app. Relevant if type is "appReload"

Properties

appId

string

No description

AlertDeliveryMethod

object

Properties

type string	type of event that triggers an alert Enum: appReload
appData optional AlertingAppData	metadata about the app. Relevant if type is "appReload"

StandardListResponseProps

object

properties that should be added to every list response

Properties

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

AlertingTaskRecipientPatch

Array<AlertingTaskRecipientPatch_inner>

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

Properties

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

RecipientsChange

object

Change in a recipient for an alerting task

Properties

patchAction Array<AlertingTaskRecipientPatch_inner>	A custom custom JSON Patch document, as an array of objects with operation, recipient type and value. Original defined in https://datatracker.ietf.org/doc/html/rfc6902.
dateTime string	time of recipient state change

TriggerDefinition

object

Properties

id optional string<uid>	No description
conditionId string	No description
contextId optional string	Any extra data to identify this trigger or a group of triggers.
userId string	link this trigger to a specific user. Used to validate conditions
owner optional string	owner of the associated trigger group
emitOnStatus optional, default='success' string	Specify on which condition status emitEvent is to be triggered. success, fail, or all Enum: all conditionNotMet throttleExceeded anyFail success
enabled optional, default=true boolean	No description
triggerEvent optional TriggerDefinition_triggerEvent	No description
emitEvent optional TriggerDefinition_emitEvent	No description
stats optional TriggerDefinition_stats	No description
throttling optional TriggerDefinition_throttling	No description

ThrottlingOptions

object

Properties

dryRun boolean	No description
currentTime string	No description
reset boolean	No description
tokensToConsume integer	No description

EvaluationGetResponse

object

Properties

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

Evaluation

Properties

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

AlertingActionsTriggerCreateRequest

object

Properties

alertingTaskID

string

No description

AlertingActionsTriggerCreateResponse

object

Properties

workflowID

string

the workflow id created for the manual triggering of alert

SharingActionsTriggerCreateRequest

object

Properties

sharingTaskID

string

No description

ScheduleOptions

object

Properties

recurrence Array<string>	List of RRULEs for SCHEDULED triggers, as specified in RFC5545. Note that DTSTART and DTEND, UNTIL lines are not allowed in this field; start and end times are specified in the start and end fields. RDATE and EXDATE lines are not currently supported. EXRULE is not supported since it is deprecated by RFC5545. It is mandatory if the trigger type is SCHEDULED. At least 1 rule must be set and maximum 5 rules are allowed.
timezone string	The timezone for time calculations in SCHEDULED triggers, optional.
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.
endDateTime default='' string	EndDateTime is a local date time with respect to the above timezone parameter. If the timezone parameter is missing, then the timezone used is the one retrieved from user infos. Therefore ISO8601 time offsets are not allowed (e.g. "2026-01-02T16:04:05Z" or "2026-01-02T16:04:05+01"), if passed an error will be returned. EndDateTime is an optional parameter, when not set or when it's an empty string, the recurrence is intended to be never ending.
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.

AlertingTaskError

object

Properties

value string	Identifier for type of error occurring on alerting task Enum: OWNER_DISABLED OWNER_ACCESS OWNER_LICENSE APP_DELETED NO_RECIPIENTS PARTIAL_ACCESS EVAL_ERROR ORPHAN CONVERSION_DENIED EXPIRED PARTIAL_SENT
added string	Timestamp for the creation of the error

AlertingTaskRecipientError

object

Properties

value string	Identifier for type of error occurring on alerting task Enum: USER_IS_DELETED USER_DISABLED_IN_QCS NO_ACCESS_TO_APP UNSUBSCRIBED_FROM_ALERT CONDITION_EVAL_ERROR USER_DISABLED_IN_ALERT_BY_OWNER MAX_ALERTS_LIMIT_REACHED
added string	Timestamp for the creation of the error

AlertingTaskGroupRecipientError

object

Properties

value string	Identifier for type of error occurring on alerting task Enum: GROUP_IS_DISABLED MAX_ALERTS_LIMIT_REACHED GROUP_WITH_NO_APP_ACCESS GROUP_IS_DELETED
added string	Timestamp for the creation of the error

AlertingTaskValidation

object

Properties

validationErrors Array<string>	No description
error deprecated string	Identifier for a validation error occurring on alerting task Enum: NO_ACCESS USER_IS_DISABLED INVALID_CONDITION GROUP_IS_DISABLED GROUP_SIZE_EXCEEDED
id string	Identifies for user id or condition id
type string	Identifier for type of a validation error occurring on alerting task Enum: RECIPIENT CONDITION RECIPIENT_GROUP
description string	Description of the error

TaskError

object

Properties

value string	Identifier for type of error occurring on sharing task Enum: OWNER_DISABLED OWNER_ACCESS OWNER_LICENSE APP_DELETED NO_RECIPIENTS PARTIAL_ACCESS ORPHAN PARTIAL_SENT FATAL_SENT_ERROR
timestamp string	Timestamp for the creation of the error

TaskRecipientError

object

Properties

value string	Identifier for type of error occurring on sharing task specific for recipient Enum: USER_IS_DELETED USER_DISABLED_IN_QCS NO_ACCESS_TO_APP UNSUBSCRIBED_FROM_SHARING USER_DISABLED_IN_SHARING_BY_OWNER CHART_NOT_FOUND APP_NOT_FOUND SHEET_NOT_FOUND ENGINE_POD_NOT_AVAILABLE CHART_TYPE_NOT_ALLOWED GENERIC_EXECUTION_FAILURE
timestamp string	Timestamp for the creation of the error

TaskGroupRecipientError

object

Properties

value string	Identifier for type of error occurring on sharing task specific for group recipient Enum: GROUP_IS_DISABLED MAX_ALERTS_LIMIT_REACHED GROUP_WITH_NO_APP_ACCESS GROUP_IS_DELETED
timestamp string	Timestamp for the creation of the error

Condition

only one of compoundCondition or dataCondition should be set

Properties

type string	Indicates the condition type Enum: data
dataCondition optional DataCondition	A condition based on data within an app

DataCondition

A condition based on data within an app

Properties

history

optional

HistoryProperties

History properties

HistoryProperties

History properties

Properties

enabled

boolean

No description

NotificationDigestCreateRequest

object

Properties

frequency string	RRULE for SCHEDULED digest, as specified in RFC5545.
enabled boolean	Whether the digest is enabled or not

NotificationDigest

object

Properties

id string	id of digest
tenantId string	The tenant that this execution belongs to
ownerId string	Owner of the execution
chronosJobId string	The chronos job identifier. It is set once the related chronos job is created.
frequency string	RRULE for SCHEDULED digest, as specified in RFC5545.
enabled boolean	Whether the digest is enabled or not
timezone string	the timezone for the chronos job
startTime string	start time of the notification request
currentWorkflowId string	current workflowID to be written in the executions

JsonPatch

object

Properties

op string	The operation to be performed. Enum: replace remove add
path string	The path for the given resource field to patch.
value optional object	The value to be used for this operation.

NotificationDigestExecutions

list of Notification Digest Executions.

Properties

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

NotificationDigestExecution

object

Notification Digest Execution.

Properties

id string	id of execution
tenantId string	The tenant that this execution belongs to
ownerId string	Owner of the execution
workflowId string	workflow Id of related digest
content optional object	digest buffer content received from notification-prep
secureContent optional object	digest buffer secure content received from notification-prep
resourceId string	resourceId for the digest execution
resourceType string	resourceId for the digest execution
executionFlowStartTime string	Timestamp of execution start
dateCreated string	Timestamp for the creation of the task execution
expireAt string	Timestamp for TTL document deleted after time stamp is reached

NotificationItem

object

notification received from notification prep

CommonRecipientValidationRequest

object

a request to validate one or more users

Properties

appId string	appId used when validating access to app
recipients optional Recipients	List of recipients. An internal recipient is represented by either their user id or group id.

CommonRecipientValidationResponse

object

Properties

status

string

No description

Enum:

FAILURE

SUCCESS

validations

Array<CommonRecipientValidation>

No description

CommonRecipientValidation

object

Properties

error string	Identifier for a validation error occurring when validating a recipient Enum: NO_ACCESS USER_IS_DISABLED MAX_ALERTS_LIMIT_REACHED
id string	Identifies for user id
description string	Description of the error

Error_meta

object

Properties

httpCode

integer

HTTP error code.

EvaluationError_meta

object

Properties

fatal

boolean

defines whether an error is recoverable or not

AlertingTaskRecipientPatch_inner

object

Properties

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

TriggerDefinition_triggerEvent

object

Properties

channel string	No description
eventName string	No description
matchId optional string	No description
matchProperties optional object	No description

TriggerDefinition_emitEvent

object

Properties

channel string	The NATS channel to publish on
eventName string	The name of the NATS event to publish
data object	The data field of the message.
extensions optional object	The extensions field of the message.

TriggerDefinition_stats

object

Properties

successCount integer	Number of times the condition has passed for this trigger
failedCount integer	Number of times the condition has failed for this trigger
lastRun string<date-time>	No description

TriggerDefinition_throttling

object

Properties

recurrenceRule string	No description
replenishRate integer	No description
capacity integer	No description
initialTokenCount integer	No description
recurrence string	No description
timezone string	No description
referenceTime string	No description
alignWithSource string	only used during creation of the trigger. Specifies the id of an existing throttling resource to have previous consume information migrated to this one
throttlingOptions optional ThrottlingOptions	No description

v22.17.0