Conditions are used by features such as data alerting and subscriptions to determine when action should be taken, based on data in a Qlik app.
Every API here is available over the APIs.io API and to AI agents over MCP.
One button, every client — Claude, Cursor, VS Code and the rest.
https://apis.io/mcp
find_apisBrowse and filter every API in the catalog.get_api_artifactsOne API's artifacts, grouped by type.get_openapiThe primary OpenAPI for this API.find_similar_apisAPIs that look like this one.apis_io_searchSTART HERE — APIs, providers and tags for one query, each with its total.resolveTurn a domain, URL or GitHub org into the provider it belongs to.find_cohortsEvery scored population of providers in the catalog.curl "https://apis.io/api/v1/apis/conditions-api"curl "https://apis.io/api/v1/apis?limit=25"Discovery needs no key. Ratings and market analysis are Pro.
Free tier, no form to fill in. Signing in shares your email address with us — we store it to create your key and to recognise you if you sign in with another provider. See our Privacy Policy and Terms.
A second provider on the same verified email joins the account you already have.
{
"info": {
"title": "conditions",
"version": ""
},
"paths": {
"/api/v1/conditions": {
"post": {
"tags": [
"conditions"
],
"summary": "Creates a new condition.",
"responses": {
"201": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ConditionResponse"
}
}
},
"description": "Condition created"
},
"400": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ErrorResponse"
}
}
},
"description": "Bad request body"
},
"default": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ErrorResponse"
}
}
},
"description": "Error response."
}
},
"operationId": "createCondition",
"requestBody": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ConditionCreateRequest"
}
}
},
"description": "The condition create request definition."
},
"x-qlik-visibility": "public",
"x-qlik-stability": "stable",
"x-qlik-deprecated": false,
"x-qlik-tier": {
"tier": "2",
"limit": 100
}
}
},
"/api/v1/conditions/{id}": {
"get": {
"tags": [
"conditions"
],
"summary": "Retrieve a specific condition by id.",
"responses": {
"200": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Condition"
}
}
},
"description": "The condition"
},
"404": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ErrorResponse"
}
}
},
"description": "Resource does not exist."
},
"default": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ErrorResponse"
}
}
},
"description": "Error response."
}
},
"parameters": [
{
"in": "path",
"name": "id",
"schema": {
"type": "string",
"format": "uid"
},
"required": true,
"description": "The id of the condition"
}
],
"operationId": "getCondition",
"x-qlik-visibility": "public",
"x-qlik-stability": "stable",
"x-qlik-deprecated": false,
"x-qlik-tier": {
"tier": "1",
"limit": 1000
}
},
"patch": {
"tags": [
"conditions"
],
"summary": "Patch values in the condition",
"responses": {
"204": {
"description": "The condition was updated"
},
"400": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ErrorResponse"
}
}
},
"description": "A path or value was invalid"
},
"404": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ErrorResponse"
}
}
},
"description": "Resource does not exist."
},
"default": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ErrorResponse"
}
}
},
"description": "Error response"
}
},
"parameters": [
{
"in": "path",
"name": "id",
"schema": {
"type": "string",
"format": "uid"
},
"required": true,
"description": "The id of the condition"
}
],
"operationId": "updateCondition",
"requestBody": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ConditionPatch"
}
}
}
},
"x-qlik-visibility": "public",
"x-qlik-stability": "stable",
"x-qlik-deprecated": false,
"x-qlik-tier": {
"tier": "2",
"limit": 100
}
},
"delete": {
"tags": [
"conditions"
],
"summary": "Delete the condition",
"responses": {
"204": {
"description": "The record was deleted."
},
"404": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ErrorResponse"
}
}
},
"description": "Resource does not exist."
},
"default": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ErrorResponse"
}
}
},
"description": "Error response"
}
},
"parameters": [
{
"in": "path",
"name": "id",
"schema": {
"type": "string",
"format": "uid"
},
"required": true,
"description": "The id of the condition"
}
],
"operationId": "deleteCondition",
"x-qlik-visibility": "public",
"x-qlik-stability": "stable",
"x-qlik-deprecated": false,
"x-qlik-tier": {
"tier": "2",
"limit": 100
}
}
},
"/api/v1/conditions/{id}/evaluations": {
"post": {
"tags": [
"evaluations"
],
"summary": "Executes the condition",
"responses": {
"201": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/CreateEvaluationResponse"
}
}
},
"description": "Condition evaluation created"
},
"400": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ErrorResponse"
}
}
},
"description": "Bad request body"
},
"500": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ErrorResponse"
}
}
},
"description": "Internal server error."
},
"default": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ErrorResponse"
}
}
},
"description": "Error response."
}
},
"parameters": [
{
"in": "path",
"name": "id",
"schema": {
"type": "string",
"format": "uid"
},
"required": true,
"description": "The id of the condition"
}
],
"operationId": "executeCondition",
"requestBody": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/CreateEvaluationRequest"
}
}
}
},
"x-qlik-visibility": "public",
"x-qlik-stability": "stable",
"x-qlik-deprecated": false,
"x-qlik-tier": {
"tier": "2",
"limit": 100
}
}
},
"/api/v1/conditions/{id}/evaluations/{evaluationId}": {
"get": {
"tags": [
"evaluations"
],
"summary": "Get an Evaluation",
"responses": {
"200": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/GetEvaluationResponse"
}
}
},
"description": "The evaluation"
},
"404": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ErrorResponse"
}
}
},
"description": "Resource does not exist."
},
"default": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ErrorResponse"
}
}
},
"description": "Error response."
}
},
"parameters": [
{
"in": "path",
"name": "evaluationId",
"schema": {
"type": "string",
"format": "uid"
},
"required": true,
"description": "The id of the evaluation"
},
{
"in": "path",
"name": "id",
"schema": {
"type": "string",
"format": "uid"
},
"required": true,
"description": "The id of the condition"
}
],
"x-qlik-visibility": "public",
"x-qlik-stability": "stable",
"x-qlik-deprecated": false,
"x-qlik-tier": {
"tier": "1",
"limit": 1000
}
},
"delete": {
"tags": [
"evaluations"
],
"summary": "Delete an Evaluation",
"responses": {
"204": {
"description": "The evaluation was deleted"
},
"404": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ErrorResponse"
}
}
},
"description": "Resource does not exist."
},
"default": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ErrorResponse"
}
}
},
"description": "Error response"
}
},
"parameters": [
{
"in": "path",
"name": "evaluationId",
"schema": {
"type": "string",
"format": "uid"
},
"required": true,
"description": "The id of the evaluation"
},
{
"in": "path",
"name": "id",
"schema": {
"type": "string",
"format": "uid"
},
"required": true,
"description": "The id of the condition"
}
],
"x-qlik-visibility": "public",
"x-qlik-stability": "stable",
"x-qlik-deprecated": false,
"x-qlik-tier": {
"tier": "2",
"limit": 100
}
}
},
"/api/v1/conditions/previews": {
"post": {
"tags": [
"condition preview"
],
"summary": "Create condition preview request\\",
"responses": {
"201": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/PreviewResponse"
}
}
},
"description": "Condition preview request created."
},
"400": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ErrorResponse"
}
}
},
"description": "Bad request body"
},
"500": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ErrorResponse"
}
}
},
"description": "Internal server error."
},
"default": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ErrorResponse"
}
}
},
"description": "Error response."
}
},
"description": "Create condition preview request.",
"operationId": "conditionsPreview",
"requestBody": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ConditionCreateRequest"
}
}
},
"description": "Create condition preview request"
},
"x-qlik-visibility": "public",
"x-qlik-stability": "stable",
"x-qlik-deprecated": false,
"x-qlik-tier": {
"tier": "2",
"limit": 100
}
}
},
"/api/v1/conditions/previews/{id}": {
"get": {
"tags": [
"condition preview"
],
"summary": "Get condition preview response",
"responses": {
"200": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/PreviewStatusResponse"
}
}
},
"description": "The evaluation"
},
"400": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ErrorResponse"
}
}
},
"description": "Bad request body"
},
"404": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ErrorResponse"
}
}
},
"description": "Resource does not exist."
},
"500": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ErrorResponse"
}
}
},
"description": "Internal server error."
},
"default": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ErrorResponse"
}
}
},
"description": "Error response."
}
},
"parameters": [
{
"in": "path",
"name": "id",
"schema": {
"type": "string",
"format": "uid"
},
"required": true,
"description": "The id of the condition"
}
],
"description": "Get condition preview response.",
"operationId": "conditionsPreviewGet",
"x-qlik-visibility": "public",
"x-qlik-stability": "stable",
"x-qlik-deprecated": false,
"x-qlik-tier": {
"tier": "1",
"limit": 1000
}
}
},
"/api/v1/conditions/settings": {
"get": {
"tags": [
"api settings"
],
"summary": "Retrieves condition manager settings",
"responses": {
"200": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/APISettings"
}
}
},
"description": "The api settings have been successfully returned"
},
"404": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ErrorResponse"
}
}
},
"description": "Resource does not exist."
},
"500": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ErrorResponse"
}
}
},
"description": "Internal server error."
},
"default": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ErrorResponse"
}
}
},
"description": "Error response."
}
},
"description": "Lists api settings.",
"operationId": "ConditionManagerAPISettingsGet",
"x-qlik-visibility": "public",
"x-qlik-stability": "stable",
"x-qlik-deprecated": false,
"x-qlik-tier": {
"tier": "1",
"limit": 1000
}
},
"put": {
"tags": [
"api settings"
],
"summary": "Updates condition manager settings",
"responses": {
"204": {
"description": "api settings have been successfully updated."
},
"400": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ErrorResponse"
}
}
},
"description": "Bad request body"
},
"500": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ErrorResponse"
}
}
},
"description": "Internal server error."
},
"default": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ErrorResponse"
}
}
},
"description": "Error response."
}
},
"parameters": [
{
"in": "header",
"name": "Authorization",
"schema": {
"type": "string"
},
"required": false,
"description": "The JWT used for authentication. Send the JWT in the AuthRequest header using the Bearer schema."
}
],
"description": "Updates API configuration. Accessible only by tenant admins.",
"operationId": "conditionManagerAPISettingsUpload",
"requestBody": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/APISettingsUpload"
}
}
},
"description": "Request for updating the api settings"
},
"x-qlik-visibility": "public",
"x-qlik-stability": "stable",
"x-qlik-deprecated": false,
"x-qlik-tier": {
"tier": "2",
"limit": 100
}
}
}
},
"openapi": "3.0.0",
"components": {
"schemas": {
"APISettings": {
"type": "object",
"required": [
"enable-conditions"
],
"properties": {
"tenantId": {
"type": "string",
"example": "cgdsAumGmQ6l0Bi7CUKt9V8P_Y9GL0sC",
"readOnly": true,
"description": "These persisted api settings are only available for this tenant. Extracted from request JWT."
},
"enable-conditions": {
"type": "boolean",
"example": true,
"description": "Whether API endpoints for condition manager are enabled"
}
}
},
"APISettingsUpload": {
"type": "object",
"required": [
"enable-conditions"
],
"properties": {
"enable-conditions": {
"type": "boolean",
"example": true,
"description": "Whether API endpoints for condition manager are enabled"
}
}
},
"CausalEvent": {
"type": "object",
"properties": {
"data": {
"$ref": "#/components/schemas/CausalEventData"
},
"eventID": {
"type": "string",
"description": "the event id from eventing"
},
"extensions": {
"$ref": "#/components/schemas/CausalEventExtensions"
},
"manualTrigger": {
"type": "boolean"
},
"manualTriggerID": {
"type": "string",
"description": "the manual trigger id from eventing if present"
}
}
},
"CausalEventData": {
"type": "object",
"properties": {
"eventID": {
"type": "string",
"description": "the event id from eventing service."
},
"lastReloadTime": {
"type": "string",
"format": "RFC3339",
"example": "2006-01-02T15:04:05Z07:00",
"description": "The time of the last reload"
}
}
},
"CausalEventExtensions": {
"type": "object",
"properties": {
"userID": {
"type": "string"
},
"tenantID": {
"type": "string"
},
"sessionID": {
"type": "string"
}
}
},
"CompoundCondition": {
"type": "object",
"properties": {
"data": {
"$ref": "#/components/schemas/CompoundCondition_data"
},
"conditionBase": {
"$ref": "#/components/schemas/ConditionBase"
}
},
"description": "A condition made up of other conditions",
"x-discriminator-value": "compound",
"x-ms-discriminator-value": "compound"
},
"CompoundCondition_data": {
"type": "object",
"properties": {
"history": {
"$ref": "#/components/schemas/HistoryProperties"
},
"conditions": {
"type": "array",
"items": {
"type": "string"
},
"example": [
"rDDAcMEI1V0qzauEWepEVY8oSLJ9fvA2",
"qFPF1dAtPK4vfPTmKyyuKaqA6iERCwLi",
"4gnz8E6ZruG0lkSKwkau66P24CtORyLr",
"ATs--Z0b_NGyuHajcbQkxu7RrajgPaEQ"
],
"description": "Array of condition ids"
},
"expression": {
"type": "string",
"example": "($0 OR $1) AND ($2 OR $3)",
"description": "Boolean expression made up of variable names defined from the conditions section"
}
},
"description": "Condition data"
},
"Condition": {
"type": "object",
"required": [
"type"
],
"properties": {
"type": {
"enum": [
"compound",
"data"
],
"type": "string",
"example": "compound",
"description": "Indicates the condition type"
},
"ownerId": {
"type": "string",
"format": "uid",
"example": "EIwSIgqjmbHGwQJI0ShQoS3ORdz5nCpA",
"description": "UserID of the condition owner"
},
"tenantId": {
"type": "string",
"format": "uid",
"example": "5GI7yWoJk9lvNtuEc66SXCypXVfhbVeH",
"description": "The tenant id"
},
"dataCondition": {
"$ref": "#/components/schemas/DataCondition"
},
"compoundCondition": {
"$ref": "#/components/schemas/CompoundCondition"
}
},
"description": "only one of compoundCondition or dataCondition should be set"
},
"ConditionBase": {
"type": "object",
"properties": {
"id": {
"type": "string",
"format": "uid",
"example": "5f31c6e8476ae50001030fb6",
"readOnly": true,
"description": "The unique id for the resource"
},
"type": {
"enum": [
"compound",
"data"
],
"type": "string",
"example": "compound",
"description": "Indicates the condition type"
},
"appId": {
"type": "string",
"example": "4xQ1chLoHkOikyzUGcHJquteNrAfketW",
"description": "The id of the app the condition is evaluated against"
},
"created": {
"type": "string",
"format": "string",
"example": "2006-01-02T15:04:05Z07:00",
"readOnly": true,
"description": "When the resource was created"
},
"ownerId": {
"type": "string",
"format": "uid",
"example": "EIwSIgqjmbHGwQJI0ShQoS3ORdz5nCpA",
"readOnly": true,
"description": "The id of the user the user which owns the condition"
},
"updated": {
"type": "string",
"format": "string",
"example": "2006-01-02T14:04:05Z07:00",
"readOnly": true,
"description": "When the resource was last updated"
},
"tenantId": {
"type": "string",
"format": "uid",
"example": "5GI7yWoJk9lvNtuEc66SXCypXVfhbVeH",
"readOnly": true,
"description": "The tenant id"
},
"bookmarkId": {
"type": "string",
"example": "anTjnOABmxlCirVx8IRfhWhLd9IZjENl",
"description": "The bookmark corresponding to the selection state to apply to the app at evaluation time"
},
"createdById": {
"type": "string",
"format": "uid",
"example": "EIwSIgqjmbHGwQJI0ShQoS3ORdz5nCpA",
"readOnly": true,
"description": "The id of the user which created the condition"
},
"description": {
"type": "string",
"example": "My condition",
"description": "Description of the condition"
},
"lastReloadTime": {
"type": "string",
"format": "RFC3339",
"example": "2006-01-02T15:04:05Z07:00",
"readOnly": true,
"description": "The time of the last reload, if the scan is triggered by a reload. If exists and value does not match app's last reload time, the evaluation will fail."
}
},
"description": "A base condition"
},
"ConditionCreateRequest": {
"type": "object",
"required": [
"type"
],
"properties": {
"type": {
"enum": [
"compound",
"data"
],
"type": "string",
"example": "compound",
"description": "Indicates the condition type"
},
"dataCondition": {
"$ref": "#/components/schemas/DataConditionCreateRequest"
},
"compoundCondition": {
"$ref": "#/components/schemas/CompoundCondition"
}
},
"description": "only one of compoundCondition or dataCondition should be set"
},
"ConditionDimensions": {
"type": "array",
"items": {
"$ref": "#/components/schemas/ConditionDimensions_inner"
},
"description": "List of returned dimensions"
},
"ConditionDimensions_inner": {
"type": "object",
"properties": {
"field": {
"type": "string",
"example": "Neighborhood",
"description": "Field referred to the dimension where the selection is made. This may be used to generate deep links."
},
"title": {
"type": "string",
"example": "Neighborhood",
"description": "Dimension title"
},
"qLibraryId": {
"type": "string",
"example": "PgQKNQ",
"description": "Refers to a dimension stored in the library"
}
}
},
"ConditionHeaders": {
"type": "array",
"items": {
"type": "string"
},
"example": [
"sumnum"
],
"description": "List of header labels"
},
"ConditionMeasures": {
"type": "array",
"items": {
"$ref": "#/components/schemas/ConditionMeasures_inner"
},
"description": "List of returned measures"
},
"ConditionMeasures_inner": {
"type": "object",
"properties": {
"title": {
"type": "string",
"example": "sumnum",
"description": "Measure title"
},
"qLibraryId": {
"type": "string",
"example": "PgQKNQ",
"description": "Refers to a measure stored in the library"
},
"qNumFormat": {
"type": "object",
"example": {
"qDec": ".",
"qFmt": "###0",
"qType": "I",
"qnDec": 0,
"qUseThou": 1
},
"properties": {},
"description": "Format of the field"
}
}
},
"ConditionPatch": {
"type": "array",
"items": {
"$ref": "#/components/schemas/ConditionPatch_inner"
},
"example": [
{
"op": "replace",
"path": "/compoundCondition/conditionBase/ownerId",
"value": "I6mWVd60wRWIbOXZr1ZKV8QTnxhnitbX"
},
{
"op": "replace",
"path": "/dataCondition/conditionBase/description",
"value": "My description"
},
{
"op": "remove",
"path": "/compoundCondition/data/conditions/0"
},
{
"op": "replace",
"path": "/compoundCondition//data/expression",
"value": "$0 AND $1"
},
{
"op": "replace",
"path": "/dataCondition/conditionData/measure",
"value": "revenue"
}
],
"description": "A JSON Patch document as defined in https://datatracker.ietf.org/doc/html/rfc6902."
},
"ConditionPatch_inner": {
"type": "object",
"required": [
"op",
"path"
],
"properties": {
"op": {
"enum": [
"replace",
"remove",
"add"
],
"type": "string",
"description": "The operation to be performed."
},
"path": {
"type": "string",
"description": "The path for the given resource field to patch."
},
"value": {
"type": "object",
"properties": {},
"description": "The value to be used for this operation."
}
}
},
"ConditionResponse": {
"type": "object",
"properties": {
"errors": {
"$ref": "#/components/schemas/Errors"
},
"condition": {
"$ref": "#/components/schemas/Condition"
}
}
},
"CreateEvaluationRequest": {
"type": "object",
"required": [
"causalEvent",
"contextId"
],
"properties": {
"alertId": {
"type": "string",
"example": "5f64885b2e11d23982c09e03",
"description": "The id of the alerting task the condition and evaluation is part of"
},
"contextId": {
"type": "string",
# --- truncated at 32 KB (46 KB total) ---
# Full source: https://raw.githubusercontent.com/api-evangelist/qliksense/refs/heads/main/openapi/qliksense-conditions.json