Banners

Banners display short messages at the top of the client interface to share tenant-wide information, warnings, or issues. When embedding content, banners aren't shown inside qlik-embed UIs. The only embedding method that displays banners is an iFrame generated using the App Integration API.

Download OpenAPI spec

Get banner

Retrieves announcement banner configuration for the tenant, including content, scheduling, and link information for display at the top of the client interface.

Facts

Rate limit Tier 1 (1000 requests per minute)

Responses

200

Banner retrieval was successful.

  • application/json object
    Show application/json properties
    • id string
      Required

      format = "uid"

    • type string
      Required

      Can be one of: "info""warning""error""resolved"

    • enabled boolean
      Required
    • endTime string
      Required

      date-time in UTC.

      format = "date-time"

    • linkUrl string

      format = "uri"

    • message string
      Required
    • tenantId string
      Required

      format = "uid"

    • createdAt string
      Required

      format = "date-time"

    • createdBy string
      Required

      userId of the user who created the banner

    • linkLabel string
    • startTime string
      Required

      date-time in UTC.

      format = "date-time"

    • updatedAt string
      Required

      format = "date-time"

    • updatedBy string
      Required

      userId of the user who last modified the banner

    • linkEnabled boolean
      Required

400

Bad Request

  • application/json object
    Show application/json properties
    • errors array of objects
      Show errors properties
      • code string
      • title string
      • detail string
      • status integer
    • traceId string

401

Unauthorized

  • application/json object
    Show application/json properties
    • errors array of objects
      Show errors properties
      • code string
      • title string
      • detail string
      • status integer
    • traceId string

403

Forbidden

  • application/json object
    Show application/json properties
    • errors array of objects
      Show errors properties
      • code string
      • title string
      • detail string
      • status integer
    • traceId string

404

Not found

  • application/json object
    Show application/json properties
    • errors array of objects
      Show errors properties
      • code string
      • title string
      • detail string
      • status integer
    • traceId string

500

Internal Server Error

  • application/json object
    Show application/json properties
    • errors array of objects
      Show errors properties
      • code string
      • title string
      • detail string
      • status integer
    • traceId string
GET /api/v1/banners 
import { createQlikApi } from '@qlik/api'


const qlik = createQlikApi({
  hostConfig: {
    host: 'https://{tenant}.{region}.qlikcloud.com',
    apiKey: '<access-token>',
  },
})


await qlik.banners.getBanners()
qlik banner ls
curl "https://{tenant}.{region}.qlikcloud.com/api/v1/banners" \
-H "Authorization: Bearer <access_token>"

Example Response

{
  "id": "TiQ8GPVr8qI714Lp5ChAAFFaU24MJy69",
  "type": "info",
  "enabled": true,
  "endTime": "2024-01-01T00:00:00.000Z",
  "linkUrl": "string",
  "message": "string",
  "tenantId": "TiQ8GPVr8qI714Lp5ChAAFFaU24MJy69",
  "createdAt": "2024-01-01T00:00:00.000Z",
  "createdBy": "string",
  "linkLabel": "string",
  "startTime": "2024-01-01T00:00:00.000Z",
  "updatedAt": "2024-01-01T00:00:00.000Z",
  "updatedBy": "string",
  "linkEnabled": true
}

Set banner

Sets content, scheduling, and optional action links for the tenant-wide announcement banner. Requires TenantAdmin role.

Facts

Rate limit Tier 2 (100 requests per minute)

Request Body

  • application/json object
    Show application/json properties
    • type string
      Required

      Can be one of: "info""warning""error""resolved"

    • enabled boolean
      Required
    • endTime string
      Required

      date-time in UTC.

      format = "date-time"

    • linkUrl string

      format = "uri"

    • message string
      Required
    • linkLabel string
    • startTime string
      Required

      date-time in UTC.

      format = "date-time"

    • linkEnabled boolean
      Required

Responses

201

The banner has been successfully upserted.

  • application/json object
    Show application/json properties
    • id string
      Required

      format = "uid"

    • type string
      Required

      Can be one of: "info""warning""error""resolved"

    • enabled boolean
      Required
    • endTime string
      Required

      date-time in UTC.

      format = "date-time"

    • linkUrl string

      format = "uri"

    • message string
      Required
    • tenantId string
      Required

      format = "uid"

    • createdAt string
      Required

      format = "date-time"

    • createdBy string
      Required

      userId of the user who created the banner

    • linkLabel string
    • startTime string
      Required

      date-time in UTC.

      format = "date-time"

    • updatedAt string
      Required

      format = "date-time"

    • updatedBy string
      Required

      userId of the user who last modified the banner

    • linkEnabled boolean
      Required

400

Bad Request

  • application/json object
    Show application/json properties
    • errors array of objects
      Show errors properties
      • code string
      • title string
      • detail string
      • status integer
    • traceId string

401

Unauthorized

  • application/json object
    Show application/json properties
    • errors array of objects
      Show errors properties
      • code string
      • title string
      • detail string
      • status integer
    • traceId string

403

Forbidden

  • application/json object
    Show application/json properties
    • errors array of objects
      Show errors properties
      • code string
      • title string
      • detail string
      • status integer
    • traceId string

404

Not found

  • application/json object
    Show application/json properties
    • errors array of objects
      Show errors properties
      • code string
      • title string
      • detail string
      • status integer
    • traceId string

500

Internal Server Error

  • application/json object
    Show application/json properties
    • errors array of objects
      Show errors properties
      • code string
      • title string
      • detail string
      • status integer
    • traceId string
POST /api/v1/banners/actions/upsert 
import { createQlikApi } from '@qlik/api'


const qlik = createQlikApi({
  hostConfig: {
    host: 'https://{tenant}.{region}.qlikcloud.com',
    apiKey: '<access-token>',
  },
})


await qlik.banners.upsertBanners({
  enabled: true,
  endTime: '2024-01-01T00:00:00.000Z',
  linkEnabled: true,
  linkLabel: 'string',
  linkUrl: 'string',
  message: 'string',
  startTime: '2024-01-01T00:00:00.000Z',
  type: 'info',
})
qlik banner upsert \
  --enabled true \
  --endTime '2024-01-01T00:00:00.000Z' \
  --linkEnabled true \
  --message 'string' \
  --startTime '2024-01-01T00:00:00.000Z' \
  --type 'info'
curl "https://{tenant}.{region}.qlikcloud.com/api/v1/banners/actions/upsert" \
-X POST \
-H "Content-type: application/json" \
-H "Authorization: Bearer <access_token>" \
-d '{"type":"info","enabled":true,"endTime":"2024-01-01T00:00:00.000Z","linkUrl":"string","message":"string","linkLabel":"string","startTime":"2024-01-01T00:00:00.000Z","linkEnabled":true}'

Example Response

{
  "id": "TiQ8GPVr8qI714Lp5ChAAFFaU24MJy69",
  "type": "info",
  "enabled": true,
  "endTime": "2024-01-01T00:00:00.000Z",
  "linkUrl": "string",
  "message": "string",
  "tenantId": "TiQ8GPVr8qI714Lp5ChAAFFaU24MJy69",
  "createdAt": "2024-01-01T00:00:00.000Z",
  "createdBy": "string",
  "linkLabel": "string",
  "startTime": "2024-01-01T00:00:00.000Z",
  "updatedAt": "2024-01-01T00:00:00.000Z",
  "updatedBy": "string",
  "linkEnabled": true
}