Qlik Sense · OpenAPI Overlay 1.0.0
API Evangelist conversational phrasing for data-alerts alerting tasks API
8 actions
8 updates
phrasing
extends
openapi/qliksense-alerting-tasks-api-openapi.yml
Generated by API Evangelist
Written by API Evangelist tooling for Qlik Sense's API. It is a proposal applied on top of the contract, not a document Qlik Sense publishes.
What the actions change
x-apievangelist-phrasing
Targets 8
$.info
$.paths['/api/v1/data-alerts'].get
$.paths['/api/v1/data-alerts'].post
$.paths['/api/v1/data-alerts/{alertId}'].get
$.paths['/api/v1/data-alerts/{alertId}'].delete
$.paths['/api/v1/data-alerts/{alertId}'].patch
$.paths['/api/v1/data-alerts/{alertId}/condition'].get
$.paths['/api/v1/data-alerts/{alertId}/recipient-stats'].get
OpenAPI Overlay
# Generated by API Evangelist (build-phrasing.py). Our phrasing, not observed demand.
overlay: 1.0.0
info:
title: API Evangelist conversational phrasing for data-alerts alerting tasks API
version: 1.0.0
extends: openapi/qliksense-alerting-tasks-api-openapi.yml
actions:
- target: $.info
update:
x-apievangelist-phrasing:
method: generated
generated: '2026-09-26'
generator: build-phrasing.py
label: Generated by API Evangelist
operations: 7
- target: $.paths['/api/v1/data-alerts'].get
update:
x-apievangelist-phrasing:
intent: List data alerts
effect: read
questions:
- Which data alerts exist in Qlik Cloud for a given app?
- Can I filter data alerts by owner or status?
instructions:
- text: List my data alerts.
- text: List data alerts on app {appID}.
slots:
appID: query.appID
- text: List data alerts owned by {ownerId} with status {status}.
slots:
ownerId: query.ownerId
status: query.status
method: generated
generated: '2026-09-26'
- target: $.paths['/api/v1/data-alerts'].post
update:
x-apievangelist-phrasing:
intent: Create a data alert
effect: write
questions:
- How do I set up a data alert that notifies people when a condition is met?
- Can a data alert run on a schedule instead of on reload?
instructions:
- text: Create data alert {name} on app {appId} for condition {conditionId}, triggered by {triggerType}, sent to {recipients}.
slots:
name: requestBody.name
appId: requestBody.appId
conditionId: requestBody.conditionId
triggerType: requestBody.triggerType
recipients: requestBody.recipients
- text: Create a scheduled alert {name} on app {appId} using condition {conditionId} with schedule {scheduleOptions}, triggered by {triggerType}, for {recipients}.
slots:
name: requestBody.name
appId: requestBody.appId
conditionId: requestBody.conditionId
scheduleOptions: requestBody.scheduleOptions
triggerType: requestBody.triggerType
recipients: requestBody.recipients
method: generated
generated: '2026-09-26'
- target: $.paths['/api/v1/data-alerts/{alertId}'].get
update:
x-apievangelist-phrasing:
intent: Get a data alert
effect: read
questions:
- How do I see the full settings of one data alert?
- Who receives a specific data alert?
instructions:
- text: Show data alert {alertId}.
slots:
alertId: path.alertId
- text: Get the recipients and settings of data alert {alertId}.
slots:
alertId: path.alertId
method: generated
generated: '2026-09-26'
- target: $.paths['/api/v1/data-alerts/{alertId}'].delete
update:
x-apievangelist-phrasing:
intent: Delete a data alert
effect: destructive
questions:
- How do I delete a data alert I no longer want?
- Can I permanently remove someone else's alert as an admin?
instructions:
- text: Delete data alert {alertId}.
slots:
alertId: path.alertId
- text: Permanently remove the data alert {alertId}.
slots:
alertId: path.alertId
method: generated
generated: '2026-09-26'
- target: $.paths['/api/v1/data-alerts/{alertId}'].patch
update:
x-apievangelist-phrasing:
intent: Update a data alert
effect: write
questions:
- Can I disable a data alert without deleting it?
- How do I change the recipients or name of an existing data alert?
instructions:
- text: Update data alert {alertId}.
slots:
alertId: path.alertId
- text: Disable data alert {alertId}.
slots:
alertId: path.alertId
method: generated
generated: '2026-09-26'
- target: $.paths['/api/v1/data-alerts/{alertId}/condition'].get
update:
x-apievangelist-phrasing:
intent: Get a data alert's condition
effect: read
questions:
- What condition triggers a particular data alert?
- How can I see the rule a data alert evaluates?
instructions:
- text: Show the condition behind data alert {alertId}.
slots:
alertId: path.alertId
- text: 'What rule does data alert {alertId} evaluate: fetch its condition.'
slots:
alertId: path.alertId
method: generated
generated: '2026-09-26'
- target: $.paths['/api/v1/data-alerts/{alertId}/recipient-stats'].get
update:
x-apievangelist-phrasing:
intent: Get data alert recipient stats
effect: read
questions:
- How many recipients are subscribed to a data alert?
- Can I see which users have unsubscribed from an alert?
instructions:
- text: Show recipient stats for data alert {alertId}.
slots:
alertId: path.alertId
- text: Show recipient stats for alert {alertId} where subscribed is {subscribed}.
slots:
alertId: path.alertId
subscribed: query.subscribed
method: generated
generated: '2026-09-26'
Work with this as data
Every overlay here is available over the APIs.io API and to AI agents over MCP.
MCP server
One button, every client — Claude, Cursor, VS Code and the rest.
https://apis.io/mcp
Tools for openapi overlays
4 MCP tools reach this
find_overlaysBrowse and filter every overlay in the catalog.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.
Call it yourself
curl for this page
This overlay
curl "https://apis.io/api/v1/overlays/qliksense-alerting-tasks-api-phrasing-overlay"
All openapi overlays
curl "https://apis.io/api/v1/overlays?limit=25"
Discovery needs no key. Ratings and market analysis are Pro.
Get an API key
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.