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.
# Generated by API Evangelist (build-phrasing.py). Our phrasing, not observed demand.
overlay: 1.0.0
info:
title: API Evangelist conversational phrasing for banners Banner API
version: 1.0.0
extends: openapi/qliksense-banner-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: 2
- target: $.paths['/api/v1/banners'].get
update:
x-apievangelist-phrasing:
intent: Get the announcement banner
effect: read
questions:
- What announcement banner is currently configured for the tenant?
- When is the tenant banner scheduled to show?
instructions:
- text: Show the tenant announcement banner.
- text: Get the current banner configuration.
method: generated
generated: '2026-09-26'
- target: $.paths['/api/v1/banners/actions/upsert'].post
update:
x-apievangelist-phrasing:
intent: Set the announcement banner
effect: write
questions:
- How do I post a maintenance announcement across the top of Qlik Cloud?
- Can the banner include a link and a start and end time?
instructions:
- text: Set a {type} banner saying {message} from {startTime} to {endTime}, enabled {enabled}, link enabled {linkEnabled}.
slots:
type: requestBody.type
message: requestBody.message
startTime: requestBody.startTime
endTime: requestBody.endTime
enabled: requestBody.enabled
linkEnabled: requestBody.linkEnabled
- text: Set a {type} banner {message} from {startTime} to {endTime}, enabled {enabled}, linkEnabled {linkEnabled}, linking to {linkUrl}.
slots:
type: requestBody.type
message: requestBody.message
startTime: requestBody.startTime
endTime: requestBody.endTime
enabled: requestBody.enabled
linkEnabled: requestBody.linkEnabled
linkUrl: requestBody.linkUrl
method: generated
generated: '2026-09-26'
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.