How AI is applied across API Evangelist and APIs.io. Read my AI disclosure →
API Evangelist API Evangelist
Discovery
Learnings
Guidance
Toolbox
Alignment
API Evangelist LLC

Qlik Sense Reports API

The reports API from Qlik Sense — 1 operation(s) for reports.

Qlik Sense Reports API is one of 135 APIs that Qlik Sense publishes on the APIs.io network, described by a machine-readable OpenAPI specification.

Tagged areas include Reports. The published artifact set on APIs.io includes an OpenAPI specification, API documentation, an API reference, and authentication docs.

This API exposes 1 operation across 1 path, and defines 45 schemas. It is described by OpenAPI 3.2.0.

Requests are made against a single base URL, https://{tenant}.{region}.qlikcloud.com.

1 operations 1 paths 45 schemas 1 POST

Metadata

The identity and technical contract details declared by the specification.

Specification
OpenAPI 3.2.0
Base URL
wss://your-tenant.qlikcloud.com/app/
Resource Areas
1

Paths & Operations 1

Across 1 path, the API surfaces 1 operation — 1 POST. Each is listed below with its method, path, parameters, and response codes.

Reports 1
POST
/api/v1/reports
Queue a new report request generation
postReports body → 202400401403404409429500

Schemas 45

The contract defines 45 schemas that model the data the API accepts and returns. The most detailed are ReportRequest (14 properties), SenseDataTemplate (11 properties), OutputItem (10 properties), SenseImageTemplate (10 properties). Each schema is shown below with its type and property counts.

SelectionChain
array
Array of ChainableSelection
AppErrors
array
Errors occurring when dealing with the app.
Sheet
object
It refers to the Sense Sheet to be exported. Note that if widthPx and heightPx are not specified, default values will be applied depending on the actual size a…
6 properties 1 required
ReportRequest
object
14 properties 2 required
ChainableSelectionType
string
DocProperties
object
Properties of the document. In case of multiple composition, only properties specified in the composition output are taken and the ones specified in each outpu…
3 properties
ImageOutput
object
Output to be used to export a single visualization as image.
3 properties
ChainableSelection
object
4 properties 1 required
SenseDataTemplate
object
11 properties 2 required
PptxCompositionOutput
object
Output to be used to export a composition of templates as pptx.
1 property
CycleOutput
object
4 properties 1 required
SensePersistentBookmark
object
1 property 1 required
SelectionErrors
array
Errors occurring in selections.
PdfOutput
object
Output to be used to export a single visualization, a sheet, Sense Excel template as pdf. For Sense Excel template (sense-excel-template-1.0) no properties are…
7 properties
SelectionStrategy
string
PptxOutput
object
Output to be used to export a single visualization or a sheet as PowerPoint presentation.
5 properties
SenseFileTemplate
object
Used to produce reports from a template file.
5 properties 1 required
OutputItem
object
10 properties 2 required
SenseSheetTemplate
object
Used to export a sheet as pdf or pptx.
9 properties 2 required
CallBackAction
object
The callback to be performed once the report is done.
1 property
HttpRequest
object
Http callback. The provided uri will be called once the report is done.
1 property
Definitions
object
Definitions of common properties that are shared between templates, e.g. selectionsByState can be the same for all templates within a composition of templates.
1 property
SenseTemporaryBookmarkV2
object
The temporary bookmark to apply. Patches and Variables are ignored if passed to the API, because they already are applied in the backend.
1 property 1 required
ExcelOutput
object
Output to be used to export an excel template.
1 property
QFieldValue
object
In order to apply a selection just one of text/number needs to be set, this must be associated with the correct isNumeric bool. In some scenarios both text and…
3 properties
PostReportsResponse
object
3 properties
Float64
number
SenseSelectionType
string
Meta
object
Define the request metadata. It includes priority, deadline and future settings on execution policy of the request.
2 properties
ComposableTemplate
object
3 properties 1 required
ExportErrors
array
Errors occured during report generation.
NxPatch
object
Patches to apply to sense charts. Patches are soft properties meaning that are not persistent and they live within a session.
3 properties 2 required
ExportError
object
Error occured during report generation.
4 properties 2 required
AppError
object
Error in resource handling
3 properties
Error
object
1 property
TemplateLocation
object
The location of the report template. Currently it can be an absolute or relative URL to a persisted report template, or to a template file saved as temporary c…
2 properties 1 required
PdfCompositionOutput
object
Output to be used to export a composition of templates as pdf.
2 properties
MetaExportError
object
Define the export error metadata. Each property is filled if it is related to the export error type.
2 properties
SelectionError
object
Selection error related to a fieldName. The field name is missing or some of his selection values are missing or a state is missing
6 properties
reloadTimestampMatchType
string
Choose the reloadTimestamp constraint to apply. An empty value leads to the default noCheck.
QSelection
object
3 properties 3 required
ExportDataOptions
object
3 properties
Visualization
object
6 properties 3 required
SenseImageTemplate
object
Used to export a single visualization as pdf, pptx or png.
10 properties 2 required
SelectionFilter
object
3 properties

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

qliksense-reports-api-openapi.yml Raw ↑

Other APIs Qlik Sense publishes across the network.

Qlik Engine API
Qlik Server-Side Extension Protocol
Qlik Cloud System Events
Qlik MCP Server
Qlik Sense Engine API
Qlik Sense Repository API
Qlik Sense Proxy API
Qlik Data Integration API
Qlik Embedding API
Qlik Sense alerting actions API
Qlik Sense alerting settings API
Qlik Sense alerting tasks API
Where this information came from

This is an independent, third-party profile of Qlik Sense Reports API, published by API Evangelist. We do not operate, host, resell, or support these APIs, and we are not affiliated with or endorsed by the company unless stated above. Everything here is built from publicly available information — the company's own site, developer portal, documentation, public repositories, and the specifications it publishes for public use. Nothing is obtained by breaching a system, defeating an access control, or using credentials.

The Kin Score and Agent Readiness rating are independently calculated assessments of a company's public API artifacts, scored against a published rubric. They are not certifications, endorsements, security assessments, or audits.

Corrections, re-scores, and removal are free — no partnership or purchase required, and you do not need to justify the request. A removed company is recorded as unrated, never scored zero for having asked. Acknowledgement within one business day; removal within two.

info@apievangelist.com · Read the full data-sourcing policy →
On a security or compliance team? Put security in the subject line and you will get a person, not a form — we will tell you exactly which public URLs this profile was built from.