Every API here is available over the APIs.io API and to AI agents over MCP.
{
"info": {
"title": "data-alerts",
"version": ""
},
"paths": {
"/api/v1/data-alerts": {
"get": {
"tags": [
"alerting tasks"
],
"summary": "List data alert tasks",
"responses": {
"200": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/AlertingTaskListResponse"
}
}
},
"description": "The alerting tasks list has been successfully returned."
},
"400": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Errors"
}
}
},
"description": "Bad request, malformed syntax or errors in parameters."
},
"500": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Errors"
}
}
},
"description": "Internal server error."
},
"default": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Errors"
}
}
},
"description": "Error response."
}
},
"parameters": [
{
"in": "query",
"name": "appID",
"schema": {
"type": "string"
},
"required": false,
"description": "The app ID you would like to filter by"
},
{
"in": "query",
"name": "conditionId",
"schema": {
"type": "string"
},
"required": false,
"description": "The conditionId you would like to filter by"
},
{
"in": "query",
"name": "limit",
"schema": {
"type": "integer",
"default": 20,
"maximum": 100,
"minimum": 1
},
"required": false,
"description": "Limit the returned result set"
},
{
"in": "query",
"name": "next",
"schema": {
"type": "string"
},
"required": false,
"description": "The cursor to the next page of data. Only one of next or previous may be specified."
},
{
"in": "query",
"name": "offset",
"schema": {
"type": "integer",
"default": 0,
"minimum": 0
},
"required": false,
"description": "Offset for finding a list of entities - used for pagination"
},
{
"in": "query",
"name": "ownerId",
"schema": {
"type": "string"
},
"required": false,
"description": "The id of the owner you would like to filter by"
},
{
"in": "query",
"name": "ownerName",
"schema": {
"type": "string"
},
"required": false,
"description": "The name of the owner you would like to filter by"
},
{
"in": "query",
"name": "prev",
"schema": {
"type": "string"
},
"required": false,
"description": "The cursor to the previous page of data. Only one of next or previous may be specified."
},
{
"in": "query",
"name": "role",
"schema": {
"type": "array",
"items": {
"enum": [
"owner",
"recipient",
"notowner"
],
"type": "string"
}
},
"required": false,
"description": "The role you would like to filter by"
},
{
"in": "query",
"name": "sort",
"schema": {
"type": "array",
"items": {
"enum": [
"-datecreated",
"datecreated",
"+datecreated",
"-ownername",
"ownername",
"+ownername",
"lasttrigger",
"-lasttrigger",
"+lasttrigger",
"lastscan",
"-lastscan",
"+lastscan",
"name",
"-name",
"+name",
"enabled",
"-enabled",
"+enabled",
"status",
"-status",
"+status",
"nextexecutiontime",
"-nextexecutiontime",
"+nextexecutiontime"
],
"type": "string"
}
},
"required": false,
"description": "Sort the returned result set by the specified field"
},
{
"in": "query",
"name": "status",
"schema": {
"type": "array",
"items": {
"enum": [
"INVALID_RECIPIENT",
"INVALID_OWNER",
"DISABLED",
"VALID"
],
"type": "string"
}
},
"required": false,
"description": "The status you would like to filter by"
}
],
"description": "Retrieves all data alert tasks accessible to the user. Users assigned the `TenantAdmin` or `AnalyticsAdmin` role can view all tasks.",
"operationId": "alertingTasksList",
"x-qlik-visibility": "public",
"x-qlik-stability": "stable",
"x-qlik-deprecated": false,
"x-qlik-tier": {
"tier": "1",
"limit": 1000
}
},
"post": {
"tags": [
"alerting tasks"
],
"summary": "Create data alert task",
"responses": {
"202": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/AlertingTaskResponse"
}
}
},
"description": "Alert creation has been accepted. The alerting task will have status creating, until status is set to either valid or invalid."
},
"400": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Errors"
}
}
},
"description": "Bad request, malformed syntax or errors in parameters."
},
"500": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Errors"
}
}
},
"description": "Internal server error."
},
"default": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Errors"
}
}
},
"description": "Error response."
}
},
"description": "Creates a new data alerting task.",
"operationId": "alertingTasksCreate",
"requestBody": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/AlertingTaskCreateRequest"
}
}
},
"required": true,
"description": "The alerting task create request definition."
},
"x-qlik-visibility": "public",
"x-qlik-stability": "stable",
"x-qlik-deprecated": false,
"x-qlik-tier": {
"tier": "2",
"limit": 100
}
}
},
"/api/v1/data-alerts/{alertId}": {
"get": {
"tags": [
"alerting tasks"
],
"summary": "Get data alert task",
"responses": {
"200": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/AlertingTaskResponse"
}
}
},
"description": "Alert has been successfully returned."
},
"400": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Errors"
}
}
},
"description": "Bad request, malformed syntax or errors in parameters."
},
"404": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Errors"
}
}
},
"description": "Task or execution not found."
},
"500": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Errors"
}
}
},
"description": "Internal server error."
},
"default": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Errors"
}
}
},
"description": "Error response."
}
},
"parameters": [
{
"in": "path",
"name": "alertId",
"schema": {
"type": "string"
},
"required": true,
"description": "The alerting task identifier."
}
],
"description": "Returns the details of a specific data alert task.",
"operationId": "alertingTasksIDGet",
"x-qlik-visibility": "public",
"x-qlik-stability": "stable",
"x-qlik-deprecated": false,
"x-qlik-tier": {
"tier": "1",
"limit": 1000
}
},
"patch": {
"tags": [
"alerting tasks"
],
"summary": "Update data alert task",
"responses": {
"204": {
"description": "The alerting task has been successfully updated."
},
"400": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Errors"
}
}
},
"description": "The specified alerting task ID or body is invalid (e.g. not a number)."
},
"404": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Errors"
}
}
},
"description": "An alerting task with the specified ID was not found."
},
"500": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Errors"
}
}
},
"description": "Internal server error."
},
"default": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Errors"
}
}
},
"description": "Error response."
}
},
"parameters": [
{
"in": "path",
"name": "alertId",
"schema": {
"type": "string"
},
"required": true,
"description": "The alerting task identifier."
}
],
"description": "Updates one or more properties of a specific data alerting task.",
"operationId": "alertingTasksUpdate",
"requestBody": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/AlertingTaskPatchRequestCompliantList"
}
}
},
"required": true,
"description": "Patch request definition for an alerting task."
},
"x-qlik-visibility": "public",
"x-qlik-stability": "stable",
"x-qlik-deprecated": false,
"x-qlik-tier": {
"tier": "2",
"limit": 100
}
},
"delete": {
"tags": [
"alerting tasks"
],
"summary": "Delete data alert task",
"responses": {
"204": {
"description": "The alerting task has been successfully deleted."
},
"400": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Errors"
}
}
},
"description": "The specified alerting task ID is invalid (e.g. not a number)."
},
"404": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Errors"
}
}
},
"description": "An alerting task with the specified ID was not found."
},
"500": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Errors"
}
}
},
"description": "Internal server error."
},
"default": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Errors"
}
}
},
"description": "Error response."
}
},
"parameters": [
{
"in": "path",
"name": "alertId",
"schema": {
"type": "string"
},
"required": true,
"description": "The alerting task identifier."
}
],
"description": "Deletes a specific data alerting task.",
"operationId": "alertingTasksDelete",
"x-qlik-visibility": "public",
"x-qlik-stability": "stable",
"x-qlik-deprecated": false,
"x-qlik-tier": {
"tier": "2",
"limit": 100
}
}
},
"/api/v1/data-alerts/{alertId}/condition": {
"get": {
"tags": [
"alerting tasks"
],
"summary": "Get data alert task condition",
"responses": {
"200": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/AlertingConditionResponse"
}
}
},
"description": "Condition associated with the alerting task has been successfully returned. See ConditionResponse in condition-manager api docs"
},
"400": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Errors"
}
}
},
"description": "Bad request, malformed syntax or errors in parameters."
},
"404": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Errors"
}
}
},
"description": "Task or condition not found."
},
"500": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Errors"
}
}
},
"description": "Internal server error."
},
"default": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Errors"
}
}
},
"description": "Error response."
}
},
"parameters": [
{
"in": "path",
"name": "alertId",
"schema": {
"type": "string"
},
"required": true,
"description": "The alerting task identifier."
}
],
"description": "Retrieves the condition associated with a data alerting task.",
"operationId": "alertingConditionGet",
"x-qlik-visibility": "public",
"x-qlik-stability": "stable",
"x-qlik-deprecated": false,
"x-qlik-tier": {
"tier": "1",
"limit": 1000
}
}
},
"/api/v1/data-alerts/{alertId}/executions/{executionId}": {
"get": {
"tags": [
"alerting tasks executions"
],
"summary": "Get data alert task execution",
"responses": {
"200": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/AlertingExecutionResponse"
}
}
},
"description": "The execution has been successfully returned."
},
"400": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Errors"
}
}
},
"description": "The specified task or execution ID is invalid (e.g. not a number)."
},
"404": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Errors"
}
}
},
"description": "Task or execution not found."
},
"500": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Errors"
}
}
},
"description": "Internal server error."
},
"default": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Errors"
}
}
},
"description": "Error response."
}
},
"parameters": [
{
"in": "path",
"name": "alertId",
"schema": {
"type": "string"
},
"required": true,
"description": "The alerting task identifier."
},
{
"in": "path",
"name": "executionId",
"schema": {
"type": "string"
},
"required": true,
"description": "The execution identifier. If value is \"latest\", the latest execution will be returned"
}
],
"description": "Retrieves a specific execution for the specified data alerting task.",
"operationId": "alertingExecutionsIDGet",
"x-qlik-visibility": "public",
"x-qlik-stability": "stable",
"x-qlik-deprecated": false,
"x-qlik-tier": {
"tier": "1",
"limit": 1000
}
},
"delete": {
"tags": [
"alerting tasks executions"
],
"summary": "Delete data alert task execution",
"responses": {
"204": {
"description": "The execution has been successfully deleted."
},
"400": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Errors"
}
}
},
"description": "The specified task or execution ID is invalid (e.g. not a number)."
},
"404": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Errors"
}
}
},
"description": "Task or execution not found."
},
"500": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Errors"
}
}
},
"description": "Internal server error."
},
"default": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Errors"
}
}
},
"description": "Error response."
}
},
"parameters": [
{
"in": "path",
"name": "alertId",
"schema": {
"type": "string"
},
"required": true,
"description": "The alerting task identifier."
},
{
"in": "path",
"name": "executionId",
"schema": {
"type": "string"
},
"required": true,
"description": "The execution identifier."
}
],
"description": "Deletes a specific data alerting task execution.",
"operationId": "alertingExecutionsDelete",
"x-qlik-visibility": "public",
"x-qlik-stability": "stable",
"x-qlik-deprecated": false,
"x-qlik-tier": {
"tier": "2",
"limit": 100
}
}
},
"/api/v1/data-alerts/{alertId}/recipient-stats": {
"get": {
"tags": [
"alerting tasks"
],
"summary": "Get data alert task recipient stats",
"responses": {
"200": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/AlertingRecipientStatsResponse"
}
}
},
"description": "Alert recipient stats have been successfully returned."
},
"400": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Errors"
}
}
},
"description": "Bad request, malformed syntax or errors in parameters."
},
"404": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Errors"
}
}
},
"description": "Task or execution not found."
},
"500": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Errors"
}
}
},
"description": "Internal server error."
},
"default": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Errors"
}
}
},
"description": "Error response."
}
},
"parameters": [
{
"in": "path",
"name": "alertId",
"schema": {
"type": "string"
},
"required": true,
"description": "The alerting task identifier."
},
{
"in": "query",
"name": "groups",
"schema": {
"type": "array",
"items": {
"type": "string"
}
},
"required": false,
"description": "The name of the groups you would like to filter by"
},
{
"in": "query",
"name": "sort",
"schema": {
"type": "array",
"items": {
"enum": [
"+userID",
"-userID",
"subscribed",
"+subscribed"
],
"type": "string"
}
},
"required": false,
"description": "Sort the returned result set by the specified field"
},
{
"in": "query",
"name": "subscribed",
"schema": {
"type": "boolean"
},
"required": false,
"description": "Subscribed property you would like to filter by"
},
{
"in": "query",
"name": "userID",
"schema": {
"type": "string"
},
"required": false,
"description": "The recipients ID you would like to filter by"
}
],
"description": "Retrieve the recipient stats for a data alerting task.",
"operationId": "alertingRecipientStatsGet",
"x-qlik-visibility": "public",
"x-qlik-stability": "stable",
"x-qlik-deprecated": false,
"x-qlik-tier": {
"tier": "1",
"limit": 1000
}
}
},
"/api/v1/data-alerts/{taskId}/executions": {
"get": {
"tags": [
"alerting tasks executions"
],
"summary": "List data alert task executions",
"responses": {
"200": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/AlertingExecutionListResponse"
}
}
},
"description": "The alerting-executions list has been successfully returned."
},
"400": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Errors"
}
}
},
"description": "Bad request, malformed syntax or errors in parameters."
},
"404": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Errors"
}
}
},
"description": "Task or execution not found."
},
"500": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Errors"
}
}
},
"description": "Internal server error."
},
"default": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Errors"
}
}
},
"description": "Error response."
}
},
"parameters": [
{
"in": "path",
"name": "taskId",
"schema": {
"type": "string"
},
"required": true,
"description": "The alerting task identifier."
},
{
"in": "query",
"name": "conditionId",
"schema": {
"type": "string"
},
"required": false,
"description": "Filter by condition id related to the executions."
},
{
"in": "query",
"name": "conditionStatus",
"schema": {
"enum": [
"FINISHED",
"FAILED",
"ALL"
],
"type": "string"
},
"required": false,
"description": "Filter by whether the alerting task execution status is FINISHED or FAILED."
},
{
"in": "query",
"name": "daysOfMonth",
"schema": {
"type": "array",
"items": {
"type": "integer",
"maximum": 31,
"minimum": 1
}
},
"required": false,
"description": "Specifies required days of the month that the execution was created in"
},
{
"in": "query",
"name": "daysOfWeek",
"schema": {
"type": "array",
"items": {
"enum": [
"MONDAY",
"TUESDAY",
"WEDNESDAY",
"THURSDAY",
"FRIDAY",
"SATURDAY",
"SUNDAY"
],
"type": "string"
}
},
"required": false,
"description": "Specifies a filter for custom handled periods of time in which the executions were handled"
},
{
"in": "query",
"name": "fields",
"schema": {
"type": "array",
"items": {
"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"
],
"type": "string"
}
},
"required": false,
"description": "Specifies specific properties to be populated"
},
{
"in": "query",
"name": "includeEvaluation",
"schema": {
"type": "boolean"
},
"required": false,
"description": "Specifies whether to include evaluation details"
},
{
"in": "query",
"name": "lastEachDay",
"schema": {
"type": "boolean"
},
"required": false,
"description": "Specifies whether to only show the last execution in each day"
},
{
"in": "query",
"name": "limit",
"schema": {
"type": "integer",
"default": 20,
"maximum": 100,
"minimum": 1
},
"required": false,
"description": "Limit the returned result set"
},
{
"in": "query",
"name": "minimumGapDays",
"schema": {
"type": "integer"
},
"required": false,
"description": "Specifies the number of days required between each entry. This should require a sort by triggertime"
},
{
"in": "query",
"name": "next",
"schema": {
"type": "string"
},
"required": false,
"description": "The cursor to the next page of data. Only one of next or previous may be specified."
},
{
"in": "query",
"name": "offset",
"schema": {
"type": "integer",
"default": 0,
"minimum": 0
},
"required": false,
"description": "Offset for pagination - how many elements to skip"
},
{
"in": "query",
"name": "prev",
"schema": {
"type": "string"
},
"required": false,
"description": "The cursor to the previous page of data. Only one of next or previous may be specified."
},
# --- truncated at 32 KB (93 KB total) ---
# Full source: https://raw.githubusercontent.com/api-evangelist/qliksense/refs/heads/main/openapi/qliksense-data-alerts.json