---
source: https://qlik.dev/apis/event/reports/
last_updated: 2026-10-28T17:52:10Z
---
# Reports
## Table of Contents
### system-events.report
- [com.qlik.v1.report.collected](#comqlikv1reportcollected)
- [com.qlik.v1.report.triggered](#comqlikv1reporttriggered)
## Events published on the `system-events.report` channel
### com.qlik.v1.report.collected
**Title:** Report processing data collected
**Action:** `send`
**Visibility:** `public`
**Stability:** `stable`
Emitted when the processing of a report has completed, whether it succeeded or failed. It carries the report data and the outcome, and it is immediately followed by the report finished event, unless the latter is suppressed by configuration. It is not emitted for the parent request of a cycle-based request, but it is emitted for each report generated by the cycle.
**Payload**
| Name | Type | Required | Description |
| --- | --- | --- | --- |
| `id` | `string` | Yes | Identifies the event. Metadata: minLength = 1. |
| `time` | `string` | No | Timestamp of when the occurrence happened. Must adhere to RFC 3339. Metadata: minLength = 1, format = "date-time". |
| `type` | `string` | Yes | Unique identifier for the event type. Allowed values: com.qlik.v1.report.collected. Metadata: default = "com.qlik.v1.report.collected". |
| `source` | `string` | Yes | Identifies the context in which an event happened. Metadata: minLength = 1, format = "uri-reference". |
| `specversion` | `string` | Yes | The version of the CloudEvents specification which the event uses. Metadata: minLength = 1. |
| `datacontenttype` | `string` | No | Content type of the data value. Must adhere to RFC 2046 format. Metadata: minLength = 1, default = "application/json". |
| `userid` | `string` | No | Unique identifier for the user triggering the event. |
| `authtype` | `string` | No | Representing the type of principal that triggered the occurrence. |
| `tenantid` | `string` | Yes | Unique identifier for the tenant related to the event. |
| `authclaims` | `string` | No | A JSON string representing claims of the principal that triggered the event. |
| `data` | `dataPayload` | Yes | The data payload for a report processing event. |
Properties of `data`
| Name | Type | Required | Description |
| --- | --- | --- | --- |
| `act` | `act` | No | The actor on whose behalf, or through which, the request was made, taken from the act claim of the access token (RFC 8693). It is present only when the request was made by a party acting for the principal identified by subject, for example a service acting for a user. |
| `tags` | `tags[]` | No | Array of tags sent by requester client. |
| `issuer` | `string` | No | The issuer of the request from the jwt |
| `reports` | `reports` | Yes | The summary information on the triggered request |
| `subject` | `string` | No | The subject of the request from the jwt |
| `subtype` | `string` | No | The subtype of the request from the jwt |
| `traceId` | `string` | Yes | telemetry trace ID |
| `version` | `string` | Yes | Version of the EventType, it uses semantic versioning. |
| `clientId` | `string` | No | The unique ID identifying the client |
| `reportId` | `string` | Yes | Unique identifier of the report. It is an opaque string, consumers must not parse it or rely on its format. |
| `requestId` | `string` | Yes | The unique ID identifying the request |
| `consumption` | `consumption` | Yes | Resource consumption of the report generation. All durations are expressed in milliseconds. |
| `originalURL` | `string` | No | The Original URL of the caller. |
| `globalResult` | `string` | Yes | All reports succeeded is "success", all reports failed is "failed", else is "partial". Allowed values: success \| partial \| failed. |
| `browserLikeOrigin` | `boolean` | Yes | The flag indicating the request is likely coming from a client. |
Properties of `act`
| Name | Type | Required | Description |
| --- | --- | --- | --- |
| `issuer` | `string` | No | Identifier of the issuer of the acting party's identity. |
| `subject` | `string` | No | Identifier of the acting party (the sub claim of the act claim). |
| `subtype` | `string` | No | Type of the acting party, for example user or service. |
Properties of `reports`
| Name | Type | Required | Description |
| --- | --- | --- | --- |
| `meta` | `metaReport` | No | Report meta info |
| `results` | `results[]` | Yes | Array of results that occurred during report generation. |
| `loadType` | `string` | Yes | Identifies the request load type that determines the engine workload. "interactive" is used for interactive downloads from the Sense UI. "batch" is used for scheduled reports. "anonymous-batch" is used for reports requested by anonymous users. |
| `templates` | `templates` | Yes | The template of the request: template holds a single template, compositionTemplates holds the ordered list of templates when the request is a composition. |
| `templateType` | `string` | Yes | Template type and version using semantic versioning [composition-1.0 sense-image-1.0 sense-data-1.0 ... etc], Refer to API docs for the full list |
Properties of `meta`
_Properties truncated due to depth limit._
Properties of `results`
_Properties truncated due to depth limit._
Properties of `templates`
_Properties truncated due to depth limit._
Properties of `consumption`
| Name | Type | Required | Description |
| --- | --- | --- | --- |
| `level` | `` | No | |
| `endTime` | `string` | Yes | timestamp of when the response is ready. Metadata: format = "date-time". |
| `cellCount` | `integer` | No | Total number of data cells exported. |
| `startTime` | `string` | Yes | timestamp of when the request arrives. Metadata: format = "date-time". |
| `objectCount` | `integer` | Yes | exported object count |
| `maxCellCount` | `integer` | No | cell count of biggest data export |
| `minCellCount` | `integer` | No | cell count of the smallest data export |
| `variableCount` | `integer` | No | Number of variables applied to the report. |
| `taskRetryCount` | `integer` | No | Number of times tasks of the report were retried after a failure. |
| `senseSheetCount` | `integer` | Yes | Number of sheets in the request |
| `dataDurationStat` | `durationStat` | No | Statistics of a set of timed operations. All durations are in milliseconds. |
| `queuingDelayStat` | `durationStat` | No | Statistics of a set of timed operations. All durations are in milliseconds. |
| `taskDurationStat` | `` | No | |
| `chartDurationStat` | `` | No | |
| `tcsUploadTimeMsecs` | `integer` | Yes | Total time in milliseconds spent uploading the generated report to the storage service. |
| `exportDurationMsecs` | `integer` | Yes | Total elapsed time in milliseconds from the arrival of the request to the completion of the report generation, including queuing time. |
| `openAppDurationStat` | `durationStat` | No | Statistics of a set of timed operations. All durations are in milliseconds. |
| `renderedDurationStat` | `durationStat` | No | Statistics of a set of timed operations. All durations are in milliseconds. |
| `applyFilterDurationStat` | `durationStat` | No | Statistics of a set of timed operations. All durations are in milliseconds. |
| `compositionDurationMsecs` | `integer` | No | Time in milliseconds spent composing the final output from the generated parts, for composition and template-based reports. |
| `applyVariablesDurationStat` | `durationStat` | No | Statistics of a set of timed operations. All durations are in milliseconds. |
Properties of `dataDurationStat`
_Properties truncated due to depth limit._
Properties of `queuingDelayStat`
_Properties truncated due to depth limit._
Properties of `openAppDurationStat`
_Properties truncated due to depth limit._
Properties of `renderedDurationStat`
_Properties truncated due to depth limit._
Properties of `applyFilterDurationStat`
_Properties truncated due to depth limit._
Properties of `applyVariablesDurationStat`
_Properties truncated due to depth limit._
**Example**
```json
{
"id": "A234-1234-1234",
"time": "2024-01-15T10:30:00Z",
"type": "com.qlik.v1.report.collected",
"source": "com.qlik/reporting-service",
"specversion": "1.0",
"datacontenttype": "application/json",
"userid": "VZhiEfgW2bLd7HgR-jjzAh6VnicipweT",
"authtype": "user",
"tenantid": "VZhiEfgW2bLd7HgR-jjzAh6VnicipweT",
"authclaims": "{\"sub\":\"VZhiEfgW2bLd7HgR-jjzAh6VnicipweT\"}",
"data": {
"reports": {
"results": [
{
"success": true,
"outputId": "Chart_image",
"timeMsecs": 150,
"serverError": false
}
],
"loadType": "batch",
"templates": {
"template": {
"appId": "ba2af9e6-0489-49a9-ae4d-8bf4a187f3c5",
"objectId": "uarJk",
"templateType": "sense-image-1.0"
}
},
"templateType": "sense-image-1.0"
},
"traceId": "0af7651916cd43dd8448eb211c80319c",
"version": "1.5.0",
"reportId": "47604fcb-a07d-4549-92a4-38fe11e5eff8:0",
"requestId": "47604fcb-a07d-4549-92a4-38fe11e5eff8",
"consumption": {
"endTime": "2018-10-30T07:06:22Z",
"startTime": "2018-10-30T07:06:22Z",
"objectCount": 1,
"senseSheetCount": 1,
"tcsUploadTimeMsecs": 20,
"exportDurationMsecs": 500
},
"globalResult": "success",
"browserLikeOrigin": true
}
}
```
### com.qlik.v1.report.triggered
**Title:** Cycle-based report generation triggered
**Action:** `send`
**Visibility:** `public`
**Stability:** `stable`
Event emitted when a cycle-based request has generated its individual report requests. A cycle-based request uses template cycle fields to produce multiple reports. Each generated report emits its own report collected and report finished events, while no report finished event is emitted for the parent request.
**Payload**
| Name | Type | Required | Description |
| --- | --- | --- | --- |
| `id` | `string` | Yes | Identifies the event. Metadata: minLength = 1. |
| `time` | `string` | No | Timestamp of when the occurrence happened. Must adhere to RFC 3339. Metadata: minLength = 1, format = "date-time". |
| `type` | `string` | Yes | Unique identifier for the event type. Allowed values: com.qlik.v1.report.triggered. Metadata: default = "com.qlik.v1.report.triggered". |
| `source` | `string` | Yes | Identifies the context in which an event happened. Metadata: minLength = 1, format = "uri-reference". |
| `specversion` | `string` | Yes | The version of the CloudEvents specification which the event uses. Metadata: minLength = 1. |
| `datacontenttype` | `string` | No | Content type of the data value. Must adhere to RFC 2046 format. Metadata: minLength = 1, default = "application/json". |
| `userid` | `string` | No | Unique identifier for the user triggering the event. |
| `authtype` | `string` | No | Representing the type of principal that triggered the occurrence. |
| `tenantid` | `string` | Yes | Unique identifier for the tenant related to the event. |
| `authclaims` | `string` | No | A JSON string representing claims of the principal that triggered the event. |
| `data` | `dataPayload` | Yes | The data payload for a report processing event. |
Properties of `data`
| Name | Type | Required | Description |
| --- | --- | --- | --- |
| `act` | `act` | No | The actor on whose behalf, or through which, the request was made, taken from the act claim of the access token (RFC 8693). It is present only when the request was made by a party acting for the principal identified by subject, for example a service acting for a user. |
| `tags` | `tags[]` | No | Array of tags sent by requester client. |
| `issuer` | `string` | No | The issuer of the request from the jwt |
| `reports` | `reports` | Yes | The summary information on the triggered request |
| `subject` | `string` | No | The subject of the request from the jwt |
| `subtype` | `string` | No | The subtype of the request from the jwt |
| `traceId` | `string` | Yes | telemetry trace ID |
| `version` | `string` | Yes | Version of the EventType, it uses semantic versioning. |
| `clientId` | `string` | No | The unique ID identifying the client |
| `reportId` | `string` | Yes | Unique identifier of the report. It is an opaque string, consumers must not parse it or rely on its format. |
| `requestId` | `string` | Yes | The unique ID identifying the request |
| `consumption` | `consumption` | Yes | Resource consumption of the report generation. All durations are expressed in milliseconds. |
| `originalURL` | `string` | No | The Original URL of the caller. |
| `globalResult` | `string` | Yes | All reports succeeded is "success", all reports failed is "failed", else is "partial". Allowed values: success \| partial \| failed. |
| `browserLikeOrigin` | `boolean` | Yes | The flag indicating the request is likely coming from a client. |
Properties of `act`
| Name | Type | Required | Description |
| --- | --- | --- | --- |
| `issuer` | `string` | No | Identifier of the issuer of the acting party's identity. |
| `subject` | `string` | No | Identifier of the acting party (the sub claim of the act claim). |
| `subtype` | `string` | No | Type of the acting party, for example user or service. |
Properties of `reports`
| Name | Type | Required | Description |
| --- | --- | --- | --- |
| `meta` | `metaReport` | No | Report meta info |
| `results` | `results[]` | Yes | Array of results that occurred during report generation. |
| `loadType` | `string` | Yes | Identifies the request load type that determines the engine workload. "interactive" is used for interactive downloads from the Sense UI. "batch" is used for scheduled reports. "anonymous-batch" is used for reports requested by anonymous users. |
| `templates` | `templates` | Yes | The template of the request: template holds a single template, compositionTemplates holds the ordered list of templates when the request is a composition. |
| `templateType` | `string` | Yes | Template type and version using semantic versioning [composition-1.0 sense-image-1.0 sense-data-1.0 ... etc], Refer to API docs for the full list |
Properties of `meta`
_Properties truncated due to depth limit._
Properties of `results`
_Properties truncated due to depth limit._
Properties of `templates`
_Properties truncated due to depth limit._
Properties of `consumption`
| Name | Type | Required | Description |
| --- | --- | --- | --- |
| `level` | `` | No | |
| `endTime` | `string` | Yes | timestamp of when the response is ready. Metadata: format = "date-time". |
| `cellCount` | `integer` | No | Total number of data cells exported. |
| `startTime` | `string` | Yes | timestamp of when the request arrives. Metadata: format = "date-time". |
| `objectCount` | `integer` | Yes | exported object count |
| `maxCellCount` | `integer` | No | cell count of biggest data export |
| `minCellCount` | `integer` | No | cell count of the smallest data export |
| `variableCount` | `integer` | No | Number of variables applied to the report. |
| `taskRetryCount` | `integer` | No | Number of times tasks of the report were retried after a failure. |
| `senseSheetCount` | `integer` | Yes | Number of sheets in the request |
| `dataDurationStat` | `durationStat` | No | Statistics of a set of timed operations. All durations are in milliseconds. |
| `queuingDelayStat` | `durationStat` | No | Statistics of a set of timed operations. All durations are in milliseconds. |
| `taskDurationStat` | `` | No | |
| `chartDurationStat` | `` | No | |
| `tcsUploadTimeMsecs` | `integer` | Yes | Total time in milliseconds spent uploading the generated report to the storage service. |
| `exportDurationMsecs` | `integer` | Yes | Total elapsed time in milliseconds from the arrival of the request to the completion of the report generation, including queuing time. |
| `openAppDurationStat` | `durationStat` | No | Statistics of a set of timed operations. All durations are in milliseconds. |
| `renderedDurationStat` | `durationStat` | No | Statistics of a set of timed operations. All durations are in milliseconds. |
| `applyFilterDurationStat` | `durationStat` | No | Statistics of a set of timed operations. All durations are in milliseconds. |
| `compositionDurationMsecs` | `integer` | No | Time in milliseconds spent composing the final output from the generated parts, for composition and template-based reports. |
| `applyVariablesDurationStat` | `durationStat` | No | Statistics of a set of timed operations. All durations are in milliseconds. |
Properties of `dataDurationStat`
_Properties truncated due to depth limit._
Properties of `queuingDelayStat`
_Properties truncated due to depth limit._
Properties of `openAppDurationStat`
_Properties truncated due to depth limit._
Properties of `renderedDurationStat`
_Properties truncated due to depth limit._
Properties of `applyFilterDurationStat`
_Properties truncated due to depth limit._
Properties of `applyVariablesDurationStat`
_Properties truncated due to depth limit._
**Example**
```json
{
"id": "A234-1234-1234",
"time": "2024-01-15T10:30:00Z",
"type": "com.qlik.v1.report.triggered",
"source": "com.qlik/reporting-service",
"specversion": "1.0",
"datacontenttype": "application/json",
"userid": "VZhiEfgW2bLd7HgR-jjzAh6VnicipweT",
"authtype": "user",
"tenantid": "VZhiEfgW2bLd7HgR-jjzAh6VnicipweT",
"authclaims": "{\"sub\":\"VZhiEfgW2bLd7HgR-jjzAh6VnicipweT\"}",
"data": {
"reports": {
"results": [
{
"success": true,
"outputId": "Chart_image",
"timeMsecs": 150,
"serverError": false
}
],
"loadType": "batch",
"templates": {
"template": {
"appId": "ba2af9e6-0489-49a9-ae4d-8bf4a187f3c5",
"objectId": "uarJk",
"templateType": "sense-image-1.0"
}
},
"templateType": "sense-image-1.0"
},
"traceId": "0af7651916cd43dd8448eb211c80319c",
"version": "1.5.0",
"reportId": "47604fcb-a07d-4549-92a4-38fe11e5eff8:0",
"requestId": "47604fcb-a07d-4549-92a4-38fe11e5eff8",
"consumption": {
"endTime": "2018-10-30T07:06:22Z",
"startTime": "2018-10-30T07:06:22Z",
"objectCount": 1,
"senseSheetCount": 1,
"tcsUploadTimeMsecs": 20,
"exportDurationMsecs": 500
},
"globalResult": "success",
"browserLikeOrigin": true
}
}
```
## Schemas
### act
The actor on whose behalf, or through which, the request was made, taken from the act claim of the access token (RFC 8693). It is present only when the request was made by a party acting for the principal identified by subject, for example a service acting for a user.
**Type:** `object`
**Properties**
| Name | Type | Required | Description |
| --- | --- | --- | --- |
| `issuer` | `string` | No | Identifier of the issuer of the acting party's identity. |
| `subject` | `string` | No | Identifier of the acting party (the sub claim of the act claim). |
| `subtype` | `string` | No | Type of the acting party, for example user or service. |
### cloudEventsContextAttributes
CloudEvents Specification JSON Schema
**Type:** `object`
**Properties**
| Name | Type | Required | Description |
| --- | --- | --- | --- |
| `id` | `string` | Yes | Identifies the event. Metadata: minLength = 1. |
| `time` | `string` | No | Timestamp of when the occurrence happened. Must adhere to RFC 3339. Metadata: minLength = 1, format = "date-time". |
| `type` | `string` | Yes | Describes the type of event related to the originating occurrence. Metadata: minLength = 1. |
| `source` | `string` | Yes | Identifies the context in which an event happened. Metadata: minLength = 1, format = "uri-reference". |
| `specversion` | `string` | Yes | The version of the CloudEvents specification which the event uses. Metadata: minLength = 1. |
| `datacontenttype` | `string` | No | Content type of the data value. Must adhere to RFC 2046 format. Metadata: minLength = 1, default = "application/json". |
### cloudEventsQlikExtensionsAttributes
**Type:** `object`
**Properties**
| Name | Type | Required | Description |
| --- | --- | --- | --- |
| `userid` | `string` | No | Unique identifier for the user triggering the event. |
| `authtype` | `string` | No | Representing the type of principal that triggered the occurrence. |
| `tenantid` | `string` | Yes | Unique identifier for the tenant related to the event. |
| `authclaims` | `string` | No | A JSON string representing claims of the principal that triggered the event. |
### compositionTemplates
Array of templates defining a composition
**Type:** `object[]`
**Properties**
| Name | Type | Required | Description |
| --- | --- | --- | --- |
| `appId` | `string` | Yes | The unique identifier of the app the request is related to. |
| `objectId` | `string` | Yes | The unique identifier of the app's object the report is related to. |
| `templateType` | `string` | Yes | Template type and version using semantic versioning [composition-1.0 sense-image-1.0 sense-data-1.0 ... etc], Refer to API docs for the full list |
### consumption
Resource consumption of the report generation. All durations are expressed in milliseconds.
**Type:** `object`
**Properties**
| Name | Type | Required | Description |
| --- | --- | --- | --- |
| `level` | `` | No | |
| `endTime` | `string` | Yes | timestamp of when the response is ready. Metadata: format = "date-time". |
| `cellCount` | `integer` | No | Total number of data cells exported. |
| `startTime` | `string` | Yes | timestamp of when the request arrives. Metadata: format = "date-time". |
| `objectCount` | `integer` | Yes | exported object count |
| `maxCellCount` | `integer` | No | cell count of biggest data export |
| `minCellCount` | `integer` | No | cell count of the smallest data export |
| `variableCount` | `integer` | No | Number of variables applied to the report. |
| `taskRetryCount` | `integer` | No | Number of times tasks of the report were retried after a failure. |
| `senseSheetCount` | `integer` | Yes | Number of sheets in the request |
| `dataDurationStat` | `durationStat` | No | Statistics of a set of timed operations. All durations are in milliseconds. |
| `queuingDelayStat` | `durationStat` | No | Statistics of a set of timed operations. All durations are in milliseconds. |
| `taskDurationStat` | `` | No | |
| `chartDurationStat` | `` | No | |
| `tcsUploadTimeMsecs` | `integer` | Yes | Total time in milliseconds spent uploading the generated report to the storage service. |
| `exportDurationMsecs` | `integer` | Yes | Total elapsed time in milliseconds from the arrival of the request to the completion of the report generation, including queuing time. |
| `openAppDurationStat` | `durationStat` | No | Statistics of a set of timed operations. All durations are in milliseconds. |
| `renderedDurationStat` | `durationStat` | No | Statistics of a set of timed operations. All durations are in milliseconds. |
| `applyFilterDurationStat` | `durationStat` | No | Statistics of a set of timed operations. All durations are in milliseconds. |
| `compositionDurationMsecs` | `integer` | No | Time in milliseconds spent composing the final output from the generated parts, for composition and template-based reports. |
| `applyVariablesDurationStat` | `durationStat` | No | Statistics of a set of timed operations. All durations are in milliseconds. |
Properties of `dataDurationStat`
| Name | Type | Required | Description |
| --- | --- | --- | --- |
| `failedCount` | `integer` | No | The number of failed exports |
| `sampleCount` | `integer` | No | Total sample count |
| `maxDurationMsecs` | `integer` | No | Max duration in milliseconds |
| `minDurationMsecs` | `integer` | No | Min duration in milliseconds |
| `totDurationMsecs` | `integer` | No | Total duration in milliseconds |
Properties of `queuingDelayStat`
| Name | Type | Required | Description |
| --- | --- | --- | --- |
| `failedCount` | `integer` | No | The number of failed exports |
| `sampleCount` | `integer` | No | Total sample count |
| `maxDurationMsecs` | `integer` | No | Max duration in milliseconds |
| `minDurationMsecs` | `integer` | No | Min duration in milliseconds |
| `totDurationMsecs` | `integer` | No | Total duration in milliseconds |
Properties of `openAppDurationStat`
| Name | Type | Required | Description |
| --- | --- | --- | --- |
| `failedCount` | `integer` | No | The number of failed exports |
| `sampleCount` | `integer` | No | Total sample count |
| `maxDurationMsecs` | `integer` | No | Max duration in milliseconds |
| `minDurationMsecs` | `integer` | No | Min duration in milliseconds |
| `totDurationMsecs` | `integer` | No | Total duration in milliseconds |
Properties of `renderedDurationStat`
| Name | Type | Required | Description |
| --- | --- | --- | --- |
| `failedCount` | `integer` | No | The number of failed exports |
| `sampleCount` | `integer` | No | Total sample count |
| `maxDurationMsecs` | `integer` | No | Max duration in milliseconds |
| `minDurationMsecs` | `integer` | No | Min duration in milliseconds |
| `totDurationMsecs` | `integer` | No | Total duration in milliseconds |
Properties of `applyFilterDurationStat`
| Name | Type | Required | Description |
| --- | --- | --- | --- |
| `failedCount` | `integer` | No | The number of failed exports |
| `sampleCount` | `integer` | No | Total sample count |
| `maxDurationMsecs` | `integer` | No | Max duration in milliseconds |
| `minDurationMsecs` | `integer` | No | Min duration in milliseconds |
| `totDurationMsecs` | `integer` | No | Total duration in milliseconds |
Properties of `applyVariablesDurationStat`
| Name | Type | Required | Description |
| --- | --- | --- | --- |
| `failedCount` | `integer` | No | The number of failed exports |
| `sampleCount` | `integer` | No | Total sample count |
| `maxDurationMsecs` | `integer` | No | Max duration in milliseconds |
| `minDurationMsecs` | `integer` | No | Min duration in milliseconds |
| `totDurationMsecs` | `integer` | No | Total duration in milliseconds |
### dataExport
Excel export info
**Type:** `object`
**Properties**
| Name | Type | Required | Description |
| --- | --- | --- | --- |
| `vizType` | `string` | No | visualization type |
| `cellCount` | `integer` | No | cell data count |
| `rowNumber` | `integer` | No | number of data rows |
| `columnNumber` | `integer` | No | number of data columns |
### dataPayload
The data payload for a report processing event.
**Type:** `object`
**Properties**
| Name | Type | Required | Description |
| --- | --- | --- | --- |
| `act` | `act` | No | The actor on whose behalf, or through which, the request was made, taken from the act claim of the access token (RFC 8693). It is present only when the request was made by a party acting for the principal identified by subject, for example a service acting for a user. |
| `tags` | `tags[]` | No | Array of tags sent by requester client. |
| `issuer` | `string` | No | The issuer of the request from the jwt |
| `reports` | `reports` | Yes | The summary information on the triggered request |
| `subject` | `string` | No | The subject of the request from the jwt |
| `subtype` | `string` | No | The subtype of the request from the jwt |
| `traceId` | `string` | Yes | telemetry trace ID |
| `version` | `string` | Yes | Version of the EventType, it uses semantic versioning. |
| `clientId` | `string` | No | The unique ID identifying the client |
| `reportId` | `string` | Yes | Unique identifier of the report. It is an opaque string, consumers must not parse it or rely on its format. |
| `requestId` | `string` | Yes | The unique ID identifying the request |
| `consumption` | `consumption` | Yes | Resource consumption of the report generation. All durations are expressed in milliseconds. |
| `originalURL` | `string` | No | The Original URL of the caller. |
| `globalResult` | `string` | Yes | All reports succeeded is "success", all reports failed is "failed", else is "partial". Allowed values: success \| partial \| failed. |
| `browserLikeOrigin` | `boolean` | Yes | The flag indicating the request is likely coming from a client. |
Properties of `act`
| Name | Type | Required | Description |
| --- | --- | --- | --- |
| `issuer` | `string` | No | Identifier of the issuer of the acting party's identity. |
| `subject` | `string` | No | Identifier of the acting party (the sub claim of the act claim). |
| `subtype` | `string` | No | Type of the acting party, for example user or service. |
Properties of `reports`
| Name | Type | Required | Description |
| --- | --- | --- | --- |
| `meta` | `metaReport` | No | Report meta info |
| `results` | `results[]` | Yes | Array of results that occurred during report generation. |
| `loadType` | `string` | Yes | Identifies the request load type that determines the engine workload. "interactive" is used for interactive downloads from the Sense UI. "batch" is used for scheduled reports. "anonymous-batch" is used for reports requested by anonymous users. |
| `templates` | `templates` | Yes | The template of the request: template holds a single template, compositionTemplates holds the ordered list of templates when the request is a composition. |
| `templateType` | `string` | Yes | Template type and version using semantic versioning [composition-1.0 sense-image-1.0 sense-data-1.0 ... etc], Refer to API docs for the full list |
Properties of `meta`
| Name | Type | Required | Description |
| --- | --- | --- | --- |
| `outputTtlSecs` | `integer` | No | Seconds to live of the final result artifacts |
| `exportDeadlineSecs` | `integer` | No | The maximum interval in seconds, starting from the time the API request is received, within which a report must be produced |
Properties of `results`
| Name | Type | Required | Description |
| --- | --- | --- | --- |
| `errors` | `errors[]` | No | Array of errors that occurred during report generation. |
| `format` | `string` | No | The output format |
| `success` | `boolean` | Yes | The flag indicating a successful report generation [true, false] |
| `outputId` | `string` | Yes | The outputId [Chart_image, Chart_pdf, chart_excel, Sheet_pdf, Multisheet_PDF]. |
| `sizeBytes` | `integer` | No | output size in bytes |
| `timeMsecs` | `integer` | Yes | The time elapsed in milliseconds |
| `dataExport` | `dataExport` | No | Excel export info |
| `serverError` | `boolean` | Yes | The flag indicating if there is a server/backend error |
Properties of `errors`
_Properties truncated due to depth limit._
Properties of `dataExport`
_Properties truncated due to depth limit._
Properties of `templates`
| Name | Type | Required | Description |
| --- | --- | --- | --- |
| `template` | `template` | No | The object with information for templateType |
| `compositionTemplates` | `compositionTemplates[]` | No | Array of templates defining a composition |
Properties of `template`
_Properties truncated due to depth limit._
Properties of `compositionTemplates`
_Properties truncated due to depth limit._
Properties of `consumption`
| Name | Type | Required | Description |
| --- | --- | --- | --- |
| `level` | `` | No | |
| `endTime` | `string` | Yes | timestamp of when the response is ready. Metadata: format = "date-time". |
| `cellCount` | `integer` | No | Total number of data cells exported. |
| `startTime` | `string` | Yes | timestamp of when the request arrives. Metadata: format = "date-time". |
| `objectCount` | `integer` | Yes | exported object count |
| `maxCellCount` | `integer` | No | cell count of biggest data export |
| `minCellCount` | `integer` | No | cell count of the smallest data export |
| `variableCount` | `integer` | No | Number of variables applied to the report. |
| `taskRetryCount` | `integer` | No | Number of times tasks of the report were retried after a failure. |
| `senseSheetCount` | `integer` | Yes | Number of sheets in the request |
| `dataDurationStat` | `durationStat` | No | Statistics of a set of timed operations. All durations are in milliseconds. |
| `queuingDelayStat` | `durationStat` | No | Statistics of a set of timed operations. All durations are in milliseconds. |
| `taskDurationStat` | `` | No | |
| `chartDurationStat` | `` | No | |
| `tcsUploadTimeMsecs` | `integer` | Yes | Total time in milliseconds spent uploading the generated report to the storage service. |
| `exportDurationMsecs` | `integer` | Yes | Total elapsed time in milliseconds from the arrival of the request to the completion of the report generation, including queuing time. |
| `openAppDurationStat` | `durationStat` | No | Statistics of a set of timed operations. All durations are in milliseconds. |
| `renderedDurationStat` | `durationStat` | No | Statistics of a set of timed operations. All durations are in milliseconds. |
| `applyFilterDurationStat` | `durationStat` | No | Statistics of a set of timed operations. All durations are in milliseconds. |
| `compositionDurationMsecs` | `integer` | No | Time in milliseconds spent composing the final output from the generated parts, for composition and template-based reports. |
| `applyVariablesDurationStat` | `durationStat` | No | Statistics of a set of timed operations. All durations are in milliseconds. |
Properties of `dataDurationStat`
| Name | Type | Required | Description |
| --- | --- | --- | --- |
| `failedCount` | `integer` | No | The number of failed exports |
| `sampleCount` | `integer` | No | Total sample count |
| `maxDurationMsecs` | `integer` | No | Max duration in milliseconds |
| `minDurationMsecs` | `integer` | No | Min duration in milliseconds |
| `totDurationMsecs` | `integer` | No | Total duration in milliseconds |
Properties of `queuingDelayStat`
| Name | Type | Required | Description |
| --- | --- | --- | --- |
| `failedCount` | `integer` | No | The number of failed exports |
| `sampleCount` | `integer` | No | Total sample count |
| `maxDurationMsecs` | `integer` | No | Max duration in milliseconds |
| `minDurationMsecs` | `integer` | No | Min duration in milliseconds |
| `totDurationMsecs` | `integer` | No | Total duration in milliseconds |
Properties of `openAppDurationStat`
| Name | Type | Required | Description |
| --- | --- | --- | --- |
| `failedCount` | `integer` | No | The number of failed exports |
| `sampleCount` | `integer` | No | Total sample count |
| `maxDurationMsecs` | `integer` | No | Max duration in milliseconds |
| `minDurationMsecs` | `integer` | No | Min duration in milliseconds |
| `totDurationMsecs` | `integer` | No | Total duration in milliseconds |
Properties of `renderedDurationStat`
| Name | Type | Required | Description |
| --- | --- | --- | --- |
| `failedCount` | `integer` | No | The number of failed exports |
| `sampleCount` | `integer` | No | Total sample count |
| `maxDurationMsecs` | `integer` | No | Max duration in milliseconds |
| `minDurationMsecs` | `integer` | No | Min duration in milliseconds |
| `totDurationMsecs` | `integer` | No | Total duration in milliseconds |
Properties of `applyFilterDurationStat`
| Name | Type | Required | Description |
| --- | --- | --- | --- |
| `failedCount` | `integer` | No | The number of failed exports |
| `sampleCount` | `integer` | No | Total sample count |
| `maxDurationMsecs` | `integer` | No | Max duration in milliseconds |
| `minDurationMsecs` | `integer` | No | Min duration in milliseconds |
| `totDurationMsecs` | `integer` | No | Total duration in milliseconds |
Properties of `applyVariablesDurationStat`
| Name | Type | Required | Description |
| --- | --- | --- | --- |
| `failedCount` | `integer` | No | The number of failed exports |
| `sampleCount` | `integer` | No | Total sample count |
| `maxDurationMsecs` | `integer` | No | Max duration in milliseconds |
| `minDurationMsecs` | `integer` | No | Min duration in milliseconds |
| `totDurationMsecs` | `integer` | No | Total duration in milliseconds |
### durationStat
Statistics of a set of timed operations. All durations are in milliseconds.
**Type:** `object`
**Properties**
| Name | Type | Required | Description |
| --- | --- | --- | --- |
| `failedCount` | `integer` | No | The number of failed exports |
| `sampleCount` | `integer` | No | Total sample count |
| `maxDurationMsecs` | `integer` | No | Max duration in milliseconds |
| `minDurationMsecs` | `integer` | No | Min duration in milliseconds |
| `totDurationMsecs` | `integer` | No | Total duration in milliseconds |
### error
Error occurred during report generation.
**Type:** `object`
**Properties**
| Name | Type | Required | Description |
| --- | --- | --- | --- |
| `code` | `string` | Yes | The unique code for the error. |
| `chartId` | `string` | No | Chart id. |
| `chartType` | `string` | No | Chart type. |
### errors
Array of errors that occurred during report generation.
**Type:** `object[]`
**Properties**
| Name | Type | Required | Description |
| --- | --- | --- | --- |
| `code` | `string` | Yes | The unique code for the error. |
| `chartId` | `string` | No | Chart id. |
| `chartType` | `string` | No | Chart type. |
### metaReport
Report meta info
**Type:** `object`
**Properties**
| Name | Type | Required | Description |
| --- | --- | --- | --- |
| `outputTtlSecs` | `integer` | No | Seconds to live of the final result artifacts |
| `exportDeadlineSecs` | `integer` | No | The maximum interval in seconds, starting from the time the API request is received, within which a report must be produced |
### reports
The summary information on the triggered request
**Type:** `object`
**Properties**
| Name | Type | Required | Description |
| --- | --- | --- | --- |
| `meta` | `metaReport` | No | Report meta info |
| `results` | `results[]` | Yes | Array of results that occurred during report generation. |
| `loadType` | `string` | Yes | Identifies the request load type that determines the engine workload. "interactive" is used for interactive downloads from the Sense UI. "batch" is used for scheduled reports. "anonymous-batch" is used for reports requested by anonymous users. |
| `templates` | `templates` | Yes | The template of the request: template holds a single template, compositionTemplates holds the ordered list of templates when the request is a composition. |
| `templateType` | `string` | Yes | Template type and version using semantic versioning [composition-1.0 sense-image-1.0 sense-data-1.0 ... etc], Refer to API docs for the full list |
Properties of `meta`
| Name | Type | Required | Description |
| --- | --- | --- | --- |
| `outputTtlSecs` | `integer` | No | Seconds to live of the final result artifacts |
| `exportDeadlineSecs` | `integer` | No | The maximum interval in seconds, starting from the time the API request is received, within which a report must be produced |
Properties of `results`
| Name | Type | Required | Description |
| --- | --- | --- | --- |
| `errors` | `errors[]` | No | Array of errors that occurred during report generation. |
| `format` | `string` | No | The output format |
| `success` | `boolean` | Yes | The flag indicating a successful report generation [true, false] |
| `outputId` | `string` | Yes | The outputId [Chart_image, Chart_pdf, chart_excel, Sheet_pdf, Multisheet_PDF]. |
| `sizeBytes` | `integer` | No | output size in bytes |
| `timeMsecs` | `integer` | Yes | The time elapsed in milliseconds |
| `dataExport` | `dataExport` | No | Excel export info |
| `serverError` | `boolean` | Yes | The flag indicating if there is a server/backend error |
Properties of `errors`
| Name | Type | Required | Description |
| --- | --- | --- | --- |
| `code` | `string` | Yes | The unique code for the error. |
| `chartId` | `string` | No | Chart id. |
| `chartType` | `string` | No | Chart type. |
Properties of `dataExport`
| Name | Type | Required | Description |
| --- | --- | --- | --- |
| `vizType` | `string` | No | visualization type |
| `cellCount` | `integer` | No | cell data count |
| `rowNumber` | `integer` | No | number of data rows |
| `columnNumber` | `integer` | No | number of data columns |
Properties of `templates`
| Name | Type | Required | Description |
| --- | --- | --- | --- |
| `template` | `template` | No | The object with information for templateType |
| `compositionTemplates` | `compositionTemplates[]` | No | Array of templates defining a composition |
Properties of `template`
| Name | Type | Required | Description |
| --- | --- | --- | --- |
| `appId` | `string` | Yes | The unique identifier of the app the request is related to. |
| `objectId` | `string` | Yes | The unique identifier of the app's object the report is related to. |
| `templateType` | `string` | Yes | Template type and version using semantic versioning [composition-1.0 sense-image-1.0 sense-data-1.0 ... etc], Refer to API docs for the full list |
Properties of `compositionTemplates`
| Name | Type | Required | Description |
| --- | --- | --- | --- |
| `appId` | `string` | Yes | The unique identifier of the app the request is related to. |
| `objectId` | `string` | Yes | The unique identifier of the app's object the report is related to. |
| `templateType` | `string` | Yes | Template type and version using semantic versioning [composition-1.0 sense-image-1.0 sense-data-1.0 ... etc], Refer to API docs for the full list |
### result
The object with information on report generation result.
**Type:** `object`
**Properties**
| Name | Type | Required | Description |
| --- | --- | --- | --- |
| `errors` | `errors[]` | No | Array of errors that occurred during report generation. |
| `format` | `string` | No | The output format |
| `success` | `boolean` | Yes | The flag indicating a successful report generation [true, false] |
| `outputId` | `string` | Yes | The outputId [Chart_image, Chart_pdf, chart_excel, Sheet_pdf, Multisheet_PDF]. |
| `sizeBytes` | `integer` | No | output size in bytes |
| `timeMsecs` | `integer` | Yes | The time elapsed in milliseconds |
| `dataExport` | `dataExport` | No | Excel export info |
| `serverError` | `boolean` | Yes | The flag indicating if there is a server/backend error |
Properties of `errors`
| Name | Type | Required | Description |
| --- | --- | --- | --- |
| `code` | `string` | Yes | The unique code for the error. |
| `chartId` | `string` | No | Chart id. |
| `chartType` | `string` | No | Chart type. |
Properties of `dataExport`
| Name | Type | Required | Description |
| --- | --- | --- | --- |
| `vizType` | `string` | No | visualization type |
| `cellCount` | `integer` | No | cell data count |
| `rowNumber` | `integer` | No | number of data rows |
| `columnNumber` | `integer` | No | number of data columns |
### results
Array of results that occurred during report generation.
**Type:** `object[]`
**Properties**
| Name | Type | Required | Description |
| --- | --- | --- | --- |
| `errors` | `errors[]` | No | Array of errors that occurred during report generation. |
| `format` | `string` | No | The output format |
| `success` | `boolean` | Yes | The flag indicating a successful report generation [true, false] |
| `outputId` | `string` | Yes | The outputId [Chart_image, Chart_pdf, chart_excel, Sheet_pdf, Multisheet_PDF]. |
| `sizeBytes` | `integer` | No | output size in bytes |
| `timeMsecs` | `integer` | Yes | The time elapsed in milliseconds |
| `dataExport` | `dataExport` | No | Excel export info |
| `serverError` | `boolean` | Yes | The flag indicating if there is a server/backend error |
Properties of `errors`
| Name | Type | Required | Description |
| --- | --- | --- | --- |
| `code` | `string` | Yes | The unique code for the error. |
| `chartId` | `string` | No | Chart id. |
| `chartType` | `string` | No | Chart type. |
Properties of `dataExport`
| Name | Type | Required | Description |
| --- | --- | --- | --- |
| `vizType` | `string` | No | visualization type |
| `cellCount` | `integer` | No | cell data count |
| `rowNumber` | `integer` | No | number of data rows |
| `columnNumber` | `integer` | No | number of data columns |
### tag
A tag optionally set by the client that requested the report, to identify the feature that originated the request. It is a string with the format "feature.subfeature". The list of values currently in use is not exhaustive and may be extended.
Values currently in use, by client:
- Sense: `sense.sheet-thumbnail-generation` (thumbnails generation).
- Sense dashboard: `sense-dialog.download` (image, pdf, data, sheet and story download), `sense-html-editor.download`, `sense-pixelperfect-editor.download`.
- QlikView dashboard: `qlikview-client.download` (data export).
- Office add-ins: `excel-addin.download`, `excel-addin.authoring`, `powerpoint-addin.download`, `powerpoint-addin.authoring`, `word-addin.download`, `word-addin.authoring`.
- Sense on demand: `sense-ondemand.download`.
- Insight advisor: `insight.snapshot`.
- Subscriptions: `subscription.execution`.
- Monitoring: `monitoring-chart.execution` (chart monitor).
- Sharing and reporting tasks: `share.execution` (image share), `reporttask.execution` (template reports).
- Notes: `notes.snapshot`.
- Automations: `automation.execution`.
- Qlik CLI: `qlik.simulation`.
- Public API: `api.public`.
- Sense capabilities API: `api.capabilities`.
- Qlik MCP server: `qlik.mcp`.
- App workflow orchestration: `app-preview.execution` (generate app preview).
**Type:** `string`
**Properties**
| Name | Type | Required | Description |
| --- | --- | --- | --- |
| `tag` | `string` | No | A tag optionally set by the client that requested the report, to identify the feature that originated the request. It is a string with the format "feature.subfeature". The list of values currently in use is not exhaustive and may be extended. Values currently in use, by client: - Sense: `sense.sheet-thumbnail-generation` (thumbnails generation). - Sense dashboard: `sense-dialog.download` (image, pdf, data, sheet and story download), `sense-html-editor.download`, `sense-pixelperfect-editor.download`. - QlikView dashboard: `qlikview-client.download` (data export). - Office add-ins: `excel-addin.download`, `excel-addin.authoring`, `powerpoint-addin.download`, `powerpoint-addin.authoring`, `word-addin.download`, `word-addin.authoring`. - Sense on demand: `sense-ondemand.download`. - Insight advisor: `insight.snapshot`. - Subscriptions: `subscription.execution`. - Monitoring: `monitoring-chart.execution` (chart monitor). - Sharing and reporting tasks: `share.execution` (image share), `reporttask.execution` (template reports). - Notes: `notes.snapshot`. - Automations: `automation.execution`. - Qlik CLI: `qlik.simulation`. - Public API: `api.public`. - Sense capabilities API: `api.capabilities`. - Qlik MCP server: `qlik.mcp`. - App workflow orchestration: `app-preview.execution` (generate app preview). |
### tags
Array of tags sent by requester client.
**Type:** `string[]`
**Properties**
| Name | Type | Required | Description |
| --- | --- | --- | --- |
| `tags` | `string[]` | No | Array of tags sent by requester client. |
### template
The object with information for templateType
**Type:** `object`
**Properties**
| Name | Type | Required | Description |
| --- | --- | --- | --- |
| `appId` | `string` | Yes | The unique identifier of the app the request is related to. |
| `objectId` | `string` | Yes | The unique identifier of the app's object the report is related to. |
| `templateType` | `string` | Yes | Template type and version using semantic versioning [composition-1.0 sense-image-1.0 sense-data-1.0 ... etc], Refer to API docs for the full list |
### templates
The template of the request: template holds a single template, compositionTemplates holds the ordered list of templates when the request is a composition.
**Type:** `object`
**Properties**
| Name | Type | Required | Description |
| --- | --- | --- | --- |
| `template` | `template` | No | The object with information for templateType |
| `compositionTemplates` | `compositionTemplates[]` | No | Array of templates defining a composition |
Properties of `template`
| Name | Type | Required | Description |
| --- | --- | --- | --- |
| `appId` | `string` | Yes | The unique identifier of the app the request is related to. |
| `objectId` | `string` | Yes | The unique identifier of the app's object the report is related to. |
| `templateType` | `string` | Yes | Template type and version using semantic versioning [composition-1.0 sense-image-1.0 sense-data-1.0 ... etc], Refer to API docs for the full list |
Properties of `compositionTemplates`
| Name | Type | Required | Description |
| --- | --- | --- | --- |
| `appId` | `string` | Yes | The unique identifier of the app the request is related to. |
| `objectId` | `string` | Yes | The unique identifier of the app's object the report is related to. |
| `templateType` | `string` | Yes | Template type and version using semantic versioning [composition-1.0 sense-image-1.0 sense-data-1.0 ... etc], Refer to API docs for the full list |