How AI is applied across API Evangelist and APIs.io. Read my AI disclosure →
API Evangelist API Evangelist
Discovery
Learnings
Guidance
Toolbox
Alignment
API Evangelist LLC

Qlik Data alerts API

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 feat

Qlik Data alerts API is one of 82 APIs that Qlik Sense APIs publishes on the APIs.io network, described by a machine-readable OpenAPI specification.

Tagged areas include Business Intelligence, Data, Event, REST, and Real-Time. The published artifact set on APIs.io includes API documentation, an API reference, and an OpenAPI specification.

This API exposes 16 operations across 11 paths, organized into 4 resource areas, and defines 48 schemas. It is described by OpenAPI 3.0.0.

Requests are made against a single base URL, https://{tenant}.{region}.qlikcloud.com.

16 operations 11 paths 48 schemas 2 DELETE9 GET1 PATCH3 POST1 PUT

Metadata

The identity and technical contract details declared by the specification.

Specification
OpenAPI 3.0.0
Base URL
https://{tenant}.{region}.qlikcloud.com/api/v1/data-alerts
Resource Areas
4

Paths & Operations 16

Across 11 paths, the API surfaces 16 operations — 2 DELETE, 9 GET, 1 PATCH, 3 POST, 1 PUT. They span 4 resource areas: alerting tasks, alerting tasks executions, alerting actions, alerting settings. Each is listed below with its method, path, parameters, and response codes.

alerting tasks 7
GET
/api/v1/data-alerts
List data alert tasks
alertingTasksList 11 params → 200400500default
POST
/api/v1/data-alerts
Create data alert task
alertingTasksCreate body → 202400500default
GET
/api/v1/data-alerts/{alertId}
Get data alert task
alertingTasksIDGet 1 param → 200400404500default
PATCH
/api/v1/data-alerts/{alertId}
Update data alert task
alertingTasksUpdate 1 param body → 204400404500default
DELETE
/api/v1/data-alerts/{alertId}
Delete data alert task
alertingTasksDelete 1 param → 204400404500default
GET
/api/v1/data-alerts/{alertId}/condition
Get data alert task condition
alertingConditionGet 1 param → 200400404500default
GET
/api/v1/data-alerts/{alertId}/recipient-stats
Get data alert task recipient stats
alertingRecipientStatsGet 5 params → 200400404500default
alerting tasks executions 5
GET
/api/v1/data-alerts/{alertId}/executions/{executionId}
Get data alert task execution
alertingExecutionsIDGet 2 params → 200400404500default
DELETE
/api/v1/data-alerts/{alertId}/executions/{executionId}
Delete data alert task execution
alertingExecutionsDelete 2 params → 204400404500default
GET
/api/v1/data-alerts/{taskId}/executions
List data alert task executions
alertingExecutionsList 19 params → 200400404500default
GET
/api/v1/data-alerts/{taskId}/executions/{executionId}/evaluations
Get data alert task execution evaluation
alertingExecutionsEvaluationGet 2 params → 200404500default
GET
/api/v1/data-alerts/{taskId}/executions/stats
Get data alert task execution stats
alertingExecutionsEvaluationStats 2 params → 200404500default
alerting actions 2
POST
/api/v1/data-alerts/actions/trigger
Create data alert task trigger
alertingActionsTriggerCreate body → 202400500default
POST
/api/v1/data-alerts/actions/validate
Validate data alert task
alertingTaskActionsValidate body → 200400500default
alerting settings 2
GET
/api/v1/data-alerts/settings
Get data alert settings
alertingSettingsGet → 200500default
PUT
/api/v1/data-alerts/settings
Update data alert settings
alertingSettingsUpload body → 204400409500default

Schemas 48

The contract defines 48 schemas that model the data the API accepts and returns. The most detailed are AlertingTaskResponse (35 properties), AlertingExecutionPersist (17 properties), Evaluation (12 properties), AlertingTaskCreateRequest (11 properties). Each schema is shown below with its type and property counts.

AlertingActionsTriggerCreateRequest
object
1 property 1 required
AlertingActionsTriggerCreateResponse
object
1 property
AlertingConditionResponse
object
2 properties
AlertingExecutionError
object
3 properties
AlertingExecutionErrors
array
AlertingExecutionListResponse
AlertingExecutionPersist
object
17 properties
AlertingExecutionResponse
AlertingExecutionResult
object
2 properties
AlertingRecipientStats
object
9 properties 1 required
AlertingRecipientStatsError
object
3 properties
AlertingRecipientStatsErrors
array
AlertingRecipientStatsResponse
object
1 property
AlertingSettings
object
8 properties 1 required
AlertingSettingsUpload
object
1 property 1 required
AlertingTaskCreateRequest
object
a alerting task (a definition on an alert)
11 properties 5 required
AlertingTaskError
object
2 properties
AlertingTaskExecutionStats
AlertingTaskGroupRecipientError
object
2 properties
AlertingTaskListResponse
AlertingTaskPatchRequestCompliant
object
3 properties 2 required
AlertingTaskPatchRequestCompliantList
array
AlertingTaskRecipientError
object
2 properties
AlertingTaskRecipientPatch
array
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…
AlertingTaskRecipientPatch_inner
object
3 properties 3 required
AlertingTaskResponse
object
35 properties 1 required
AlertingTaskTriggerStats
object
3 properties 3 required
AlertingTaskValidation
object
5 properties
AlertingTaskValidationResponse
object
2 properties
Error
object
4 properties
Error_meta
object
1 property
Errors
object
2 properties
Evaluation
object
12 properties
EvaluationGetResponse
object
3 properties
ExecutionStats
object
5 properties
GroupIDRecipient
object
an internal recipient based on its group id.
4 properties
Links
object
1 property
ListLinks
object
3 properties
Page
object
3 properties
Recipients
object
List of recipients. An internal recipient is represented by either their user id or group id.
5 properties 1 required
RecipientsChange
object
Change in a recipient for an alerting task
2 properties
ScheduleOptions
object
7 properties
Self
object
Object with Href to a particular element or set of elements
1 property
StandardListResponseProps
object
properties that should be added to every list response
2 properties 2 required
TaskGroupRecipientError
object
2 properties
TaskRecipientError
object
2 properties
ThrottlingResource
object
The rules and setup for throttling
6 properties
UserIDRecipient
object
an internal recipient based on its user id.
6 properties

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

qliksense-data-alerts.json Raw ↑

Other APIs Qlik Sense APIs publishes across the network.

Qlik Engine API
Qlik Server-Side Extension Protocol
Qlik Cloud System Events
Qlik MCP Server
Qlik Apps API
Qlik Change stores API
Qlik Adaptive cards API
Qlik ODAG apps API
Qlik ODAG links API
Qlik ODAG requests API
Qlik ODAG settings API
Qlik API keys API
Where this information came from

This is an independent, third-party profile of Qlik Data alerts API, published by API Evangelist. We do not operate, host, resell, or support these APIs, and we are not affiliated with or endorsed by the company unless stated above. Everything here is built from publicly available information — the company's own site, developer portal, documentation, public repositories, and the specifications it publishes for public use. Nothing is obtained by breaching a system, defeating an access control, or using credentials.

The Kin Score and Agent Readiness rating are independently calculated assessments of a company's public API artifacts, scored against a published rubric. They are not certifications, endorsements, security assessments, or audits.

Corrections, re-scores, and removal are free — no partnership or purchase required, and you do not need to justify the request. A removed company is recorded as unrated, never scored zero for having asked. Acknowledgement within one business day; removal within two.

info@apievangelist.com · Read the full data-sourcing policy →
On a security or compliance team? Put security in the subject line and you will get a person, not a form — we will tell you exactly which public URLs this profile was built from.