Introduction
Qlik Cloud offers a number of distribution and reporting capabilities. From in-app download, Data Alerts, and Subscriptions, to enterprise report distribution, there are many ways to produce and delivery analytics to stakeholders.
Administrators may be interested in seeing, or analyzing, the result of activity for these capabilties. This post is intended to offer some insight on a number of event types found in Management Console > Events as it relates to reporting and distribution use cases on Qlik Cloud. The post was created in response to some common questions from customers.
Disclaimer:
- This document does not override or alter Qlik Product Terms or Qlik Help.
- These events may be subject to change without notice, until they are published on the qlik.dev API reference.
- This is not intended to be a comprehensive guide, typically the explicit event type has been referenced below, administrators can explore/filter on the related source events to see the variety of CRUD information available.
Interactive reporting/distribution
Interactive reporting/distribution events are found by filtering within the Management Console > Events on the Event Type = com.qlik.v1.reporting-service.audit
Ad hoc download use cases
Ad hoc download events surface when a user is working within an application and downloading a produced file to their local system. This activity has the tags "sense-dialog.download".
Sample event
{
"data": [
{
"id": "6696d14047e1fa3e821fc21f",
"contentType": "application/json",
"data": {
"appIds": [
"09eea519-a69c-456e-8790-ef0bacc42310"
],
"endTime": "2024-07-16T20:00:00.752237504Z",
"reportId": "a1e65f7f-d6ef-4e4d-b619-23574a8c87d8:0",
"requestId": "a1e65f7f-d6ef-4e4d-b619-23574a8c87d8",
"startTime": "2024-07-16T19:59:59.468816403Z",
"success": true,
"tags": [
"sense-dialog.download"
],
"templateType": "sense-data-1.0",
"traceId": "f71cdbe3dfabc79acd1e73b9d4648176",
"version": "1.0.0"
},
"eventId": "1d7e3ab7-dc80-427c-bbdb-19bbfedf",
"eventTime": "2024-07-16T20:00:00.756Z",
"eventType": "com.qlik.v1.reporting-service.audit",
"eventTypeVersion": "1.0.0",
"source": "com.qlik/reporting-service",
"tenantId": "<tenant>",
"userId": "uzWYcE_cOycXMWhuD6BlRKH82I2dI-J8",
"links": {
"Self": {
"Href": "https://<tenant>/api/v1/audits/6696d14047e1fa3e821fc21f"
},
"self": {
"href": "https://<tenant>/api/v1/audits/6696d14047e1fa3e821fc21f"
}
}
}
Event variants:
Object (chart) data download
|
Attribute
|
Value
|
Description
|
|
templateType
|
Sense-data-1.0
|
Data export (XLS)
|
Object (chart) image download
|
Attribute
|
Value
|
Description
|
|
templateType
|
Sense-image-1.0
|
Image export (PDF, PNG)
|
Sheet download
|
Attribute
|
Value
|
Description
|
|
templateType
|
Sense-sheet-1.0
|
Sheet export (PDF, PNG)
|
Story download
|
Attribute
|
Value
|
Description
|
|
templateType
|
Sense-story-1.0
|
Story export (PDF)
|
Tabular reporting, on-demand download
|
Attribute
|
Value
|
Description
|
|
templateType
|
Sense-excel-template-1.0
|
Tabular report run on-demand. This is a metered event against the monthly Qlik Reporting Service allocation for the tenant
|
Subscription use cases
These events surface when a user schedules a file to be deliver to their inbox via email. This activity has the tags "Subscription.execution".
Sample Event:
{
"id": "66969fee79c1c5c9c01f221d",
"contentType": "application/json",
"data": {
"appIds": [
"09eea519-a69c-456e-8790-ef0bacc42310"
],
"endTime": "2024-07-16T16:29:34.075307903Z",
"reportId": "a5d1aa11-25f3-4400-add4-f4f637dca380:0",
"requestId": "a5d1aa11-25f3-4400-add4-f4f637dca380",
"startTime": "2024-07-16T16:29:03.860783997Z",
"success": true,
"tags": [
"subscription.execution"
],
"templateType": "composition-1.0",
"traceId": "78edb521626993b692a89a52535ad946",
"version": "1.0.0"
},
"eventId": "37030b7a-af9e-4313-84a8-b397bd0a",
"eventTime": "2024-07-16T16:29:34.079Z",
"eventType": "com.qlik.v1.reporting-service.audit",
"eventTypeVersion": "1.0.0",
"source": "com.qlik/reporting-service",
"tenantId": "<tenant>",
"userId": "6437fea62c33a33f8e579163",
"links": {
"Self": {
"Href": "https://<tenant>.us.qlikcloud.com/api/v1/audits/66969fee79c1c5c9c01f221d"
},
"self": {
"href": "https://<tenant>.us.qlikcloud.com/api/v1/audits/66969fee79c1c5c9c01f221d"
}
}
}
Subscription to Chart
|
Attribute
|
Value
|
Description
|
|
templateType
|
sense-image-1.0
|
Subscription to a single object Image file
|
Subscription to Sheet
|
Attribute
|
Value
|
Description
|
|
templateType
|
composition-1.0
|
Subscription to a multi-sheet file
|
Subscription to Sheet (legacy event)
|
Attribute
|
Value
|
Description
|
|
templateType
|
Sense-sheet-1.0
|
Subscription to a single sheet Image file
|
Related: Subscriptions reports are produced by a task - the task event information is found with the event type = com.qlik.sharing-task.executed with attribute
{
"id": "66969fee79c1c5c9c01f2222",
"contentType": "application/json",
"data": {
"appId": "09eea519-a69c-456e-8790-ef0bacc42310",
"createdDate": "2024-05-17T16:30:26Z",
"creatorId": "658079d5374a6c533936afa8",
"description": "",
"enabled": true,
"expiry": "",
"insightLink": "",
"name": "US Sales Overview and Product Details",
"ownerId": "658079d5374a6c533936afa8",
"resourceId": "66478621f5cee84514946139",
"resourceLink": "",
"resourceType": "sharing-task",
"sharingTaskType": "sheet-sharing",
"sheetCount": 2,
"spaceId": "",
"thumbnail": "/api/v1/sharing-tasks/66478621f5cee84514946139/executions/latest/files/",
"transports": null
},
"eventId": "1f725851-2526-4aaa-9387-ac5d19fb",
"eventTime": "2024-07-16T16:29:34Z",
"eventType": "com.qlik.sharing-task.updated",
"eventTypeVersion": "1.0",
"source": "com.qlik/sharing",
"tenantId": "<tenant>",
"userId": "",
"links": {
"Self": {
"Href": "https://<tenant>/api/v1/audits/66969fee79c1c5c9c01f2222"
},
"self": {
"href": "https://<tenant>/api/v1/audits/66969fee79c1c5c9c01f2222"
}
}
}
Share Image
These events surface when a user selects the share > image and enters an email address of their choice. An email will be sent containing an image of the chart in the users session to the entered recipient(s).
Sample Event:
{
"id": "6696e3a747e1fa3e822422a7",
"contentType": "application/json",
"data": {
"appIds": [
"09eea519-a69c-456e-8790-ef0bacc42310"
],
"endTime": "2024-07-16T21:18:31.797924952Z",
"reportId": "0385f4fa-c0a5-4fa9-a5e6-550b48d4b652:0",
"requestId": "0385f4fa-c0a5-4fa9-a5e6-550b48d4b652",
"startTime": "2024-07-16T21:18:28.350152565Z",
"success": true,
"tags": [
"share.execution"
],
"templateType": "sense-image-1.0",
"traceId": "9c0695b2802a7e1957adde8571d80b46",
"version": "1.0.0"
},
"eventId": "e4bc1bea-d433-49f2-8ef4-4f8329f6",
"eventTime": "2024-07-16T21:18:31.802Z",
"eventType": "com.qlik.v1.reporting-service.audit",
"eventTypeVersion": "1.0.0",
"source": "com.qlik/reporting-service",
"tenantId": "<tenant>",
"userId": "658079d5374a6c533936afa8",
"links": {
"Self": {
"Href": "https://<tenant>/api/v1/audits/6696e3a747e1fa3e822422a7"
},
"self": {
"href": "https://<tenant>/api/v1/audits/6696e3a747e1fa3e822422a7"
}
}
}
Share an image
|
Attribute
|
Value
|
Description
|
|
templateType
|
Sense-image-1.0
|
image
|
Related: Sharing of images are executed by a one-time task - the task event information is found with the event type = com.qlik.sharing-task.created.
{
"id": "66953c96e5a6921af0723fea",
"contentType": "application/json",
"data": {
"creator": "658079d5374a6c533936afa8",
"notification": {
"resourcetype": "chart",
"trigger": "onetime-tasks"
},
"recipientCount": 1,
"transports": [
"Email"
]
},
"eventId": "2fe569ff-c25e-4437-bc9e-315ac0ffd7fb",
"eventTime": "2024-07-15T15:13:26Z",
"eventType": "com.qlik.sharing.created",
"eventTypeVersion": "1.0",
"source": "com.qlik/sharing",
"tenantId": "<tenant>",
"userId": "",
"links": {
"Self": {
"Href": "https://<tenant>/api/v1/audits/66953c96e5a6921af0723fea"
},
"self": {
"href": "https://<tenant>/api/v1/audits/66953c96e5a6921af0723fea"
}
}
Qlik Reporting Service
Report (file) production events are found by filtering within the Management Console > Events on the Event Type = com.qlik.v1.reporting-service.audit.
Sheet Based Reporting - Automation or api execution triggered reports
Advance sheet/object composition reports are produced with the reporting execution type composition-1.0 from one of two sources - Qlik Application Automation or Public API.
For associated task information with reports produced from Qlik Application Automation use the associated task history view within Qlik Application Automation. Qlik Cloud has no additional visibility of events produced by integrated systems that use the public.api.
{
"id": "6696ce0079c1c5c9c02b4b01",
"contentType": "application/json",
"data": {
"appIds": [
"1af4b714-2775-4953-83b8-987c0774c5c6"
],
"endTime": "2024-07-16T19:46:08.764518686Z",
"reportId": "5be4a6a3-ef5f-4c6c-b017-282c961cb358:0",
"requestId": "5be4a6a3-ef5f-4c6c-b017-282c961cb358",
"startTime": "2024-07-16T19:45:49.67199137Z",
"success": true,
"tags": [
"automation.execution"
],
"templateType": "composition-1.0",
"traceId": "3d4186dfc1ca6aabbd53186a50b4b455",
"version": "1.0.0"
},
"eventId": "1112234b-eb09-4669-9428-4a6b50d9",
"eventTime": "2024-07-16T19:46:08.772Z",
"eventType": "com.qlik.v1.reporting-service.audit",
"eventTypeVersion": "1.0.0",
"source": "com.qlik/reporting-service",
"tenantId": "<tenant>",
"userId": "658079d5374a6c533936afa8",
"links": {
"Self": {
"Href": "https://<tenant>.us.qlikcloud.com/api/v1/audits/6696ce0079c1c5c9c02b4b01"
},
"self": {
"href": "https://<tenant>.us.qlikcloud.com/api/v1/audits/6696ce0079c1c5c9c02b4b01"
}
}
}
Qlik Application Automation - reports
|
Attribute
|
Value
|
Description
|
|
tags
|
automation.execution
|
Use of the report block in an automation triggers this call and uses the template type composition-1.0. This is a metered event against the Qlik Reporting Service
|
Public API - reports
|
Attribute
|
Value
|
Description
|
|
tags
|
public.api
|
Public api use of the reporting service template type composition-1.0 method is a metered event
against the Qlik Reporting Service
|
Tabular Reporting
Tabular reports are produced during authoring, task execution, on-demand or even api.
Task execution
{
"id": "668ea84a3b6614357241c921",
"contentType": "application/json",
"data": {
"appIds": [
"09eea519-a69c-456e-8790-ef0bacc42310"
],
"endTime": "2024-07-10T15:27:06.093116069Z",
"reportId": "41957445-f17b-499b-b65a-695619337e55:0",
"requestId": "41957445-f17b-499b-b65a-695619337e55",
"startTime": "2024-07-10T15:26:48.879380599Z",
"success": true,
"tags": [
"reporttask.execution"
],
"templateType": "sense-excel-template-1.0",
"traceId": "30b27fec6e342c3c204bf194e2d25498",
"version": "1.0.0"
},
"eventId": "430146ea-5c0c-42cc-bd4f-687de440",
"eventTime": "2024-07-10T15:27:06.097Z",
"eventType": "com.qlik.v1.reporting-service.audit",
"eventTypeVersion": "1.0.0",
"source": "com.qlik/reporting-service",
"tenantId": "<tenant>",
"userId": "uzWYcE_cOycXMWhuD6BlRKH82I2dI-J8",
"links": {
"Self": {
"Href": "https://<tenant>.us.qlikcloud.com/api/v1/audits/668ea84a3b6614357241c921"
},
"self": {
"href": "https://<tenant>.us.qlikcloud.com/api/v1/audits/668ea84a3b6614357241c921"
}
}
}
Tabular reporting - task execution
| Attribute |
Value |
Description |
| tags |
reporttask.execution |
Execution by the sharing service. This is a metered event against the Qlik Reporting Service |
Tabular reporting - Qlik add-in preview
| Attribute |
Value |
Description |
| tags |
excel-addin.download |
Preview/download from the xls-addin. This is a metered event against the Qlik Reporting Service |
Tabular reporting - public api execution
| Attribute |
Value |
Description |
| tags |
Public.api |
Generation from a direct api call. This is a metered event against the Qlik Reporting Service |
Tabular reporting, on-demand download
|
Attribute
|
Value
|
Description
|
|
templateType
|
Sense-excel-template-1.0
|
Tabular report run on-demand. This is a metered event against the monthly Qlik Reporting Service allocation for the tenant
|
The users referenced in the audit event varies on a number of factors.
- For reports against non-section access apps the Report Task owner will always be the user associated with an attempted execution event
- For reports against a section access controlled app, each recipient is processed:
- If a recipient is a Qlik Cloud users and has access to the app and is in the recipient list the attempted report execution will be in that users name.
- If a recipient is not a Qlik Cloud user the attempted execution will be in the name of the task owner.
A report task execution can be better understood by filtering within the Management Console > Events on the Event Type = com.qlik.reporting-task.summary.created
{
"id": "6692c82bfc781165f388f0f0",
"contentType": "application/json",
"data": {
"appId": "e9318b86-eef4-40dc-9209-56d563aeaf51",
"createdDate": "2023-11-13T19:32:31Z",
"creatorId": "uzWYcE_cOycXMWhuD6BlRKH82I2dI-J8",
"description": "",
"distributionchannels": [
"email"
],
"emailRecipientDisabledExternalCount": 0,
"emailRecipientDisabledInternalCount": 0,
"emailRecipientEnabledExternalCount": 1,
"emailRecipientEnabledInternalCount": 4,
"emailRecipientsCount": 5,
"enabled": true,
"error": "",
"expiry": "",
"failedExecutions": 4,
"hassectionaccess": false,
"id": "655279cf9b65ec9d88e5e475",
"insightLink": "",
"name": "PL Value Report",
"ownerId": "uzWYcE_cOycXMWhuD6BlRKH82I2dI-J8",
"reportingServiceEventId": "e890b0f5-6a5c-4ca7-b0c7-4450e07f02af:0",
"resourceId": "655279cf9b65ec9d88e5e475",
"resourceLink": "",
"resourceType": "reporting-task",
"sharingTaskExecutionId": "6692c821827ec440bf7f5278",
"sharingTaskOwnerId": "uzWYcE_cOycXMWhuD6BlRKH82I2dI-J8",
"sharingTaskType": "template-sharing",
"spaceId": "6552705a2d187abbfe607291",
"status": "FAILED",
"successfulExecutions": 1,
"taskExecutionId": "6692c821827ec440bf7f5278",
"thumbnail": "",
"transports": [
"email"
],
"typeOfSpace": "shared",
"workflowId": ""
},
"eventId": "414731b1-15cf-4413-8eb3-fe77f98c",
"eventTime": "2024-07-13T18:32:11Z",
"eventType": "com.qlik.reporting-task.summary.created",
"eventTypeVersion": "1.0",
"source": "com.qlik/reporting-task",
"tenantId": "<tenant>",
"userId": "",
"links": {
"Self": {
"Href": "https://<tenant>/api/v1/audits/6692c82bfc781165f388f0f0"
},
"self": {
"href": "https://<tenant>/api/v1/audits/6692c82bfc781165f388f0f0"
}
}
}
| EmailRecipientsCount |
The email recipient counts reflect attempted emails sent (see Mail Transport below) |
| SuccessfulExecutions |
The number of unique reports created as part of the task - this would be the increment to the Qlik Reporting Service metric.
|
| Failedexecutions |
The number of failed report creation executions for any reason as part of the submitted task structure. Failures are not counted in the Qlik Reporting Service.
|
For those that make use of the Qlik Reporting Service with the integrated report task capability within a Qlik Sense App, a deeper understanding of the related events will be helpful. For a Report Task there are two pre-execution checks:
- In the event of Section Access available in the app
It checks whether recipients are known in the Qlik Cloud tenant (via email address) and if so, whether the user has access to the app. If a recipient is known to Qlik Cloud but does not have access to the app, then no attempted report execution will take place for that recipient. No event will surface in the event log whatsoever in this scenario.
- The Recipient list with Filters is optimized
If common filters exist across the recipient list (non-section access scenario), only a single report will be produced for that filter and will be distributed to the corresponding recipients. This means only one (1) event is logged for the filter based report (e.g. there won't be an event per recipient with the same filter)
The net of these pre-checks is that it is not possible to do a reliable sum-check on recipients vs reporting-service events.
Data Alerts
Data Alert events are found by filtering within the Management Console > Events on the Event Type =com.qlik.alerting-task.execution-summary.created.
Note that the Data Alert feature is designed to automatically produce a CSV attachment if the number of rows meeting the event are greater than a certain number (refer to feature documentation for the more). There is no tracking of this CSV file, it is produced within the Alert service.
{
"id": "66963df32ea1bb46a72a930b",
"contentType": "application/json",
"data": {
"alertId": "664785f7f5cee8451494610c",
"alertName": "Quarterly YOY Performance",
"summary": {
"accessMode": "TARGET_ACCESS",
"alertId": "664785f7f5cee8451494610c",
"alertName": "Quarterly YOY Performance",
"complete": true,
"disabledRecipientsCount": 0,
"failedExecutionsCount": 1,
"failedExecutionsRecipientsInfo": [
{
"alertingTaskRecipientErrors": [],
"userId": "ugzEPnk6mF9_iRFoGF7NUmX3CIYXUO6H"
}
],
"ownerId": "658079d5374a6c533936afa8",
"successfulExecutionsCount": 3,
"tenantId": "5rTVZhiekEho5Om7w3bdyfGtmwX8BumO",
"totalRecipientCount": 4,
"workflowId": "308d069c-acaf-456a-b9a1-0a42d2876e0b"
},
"tracking": {
"alertId": "664785f7f5cee8451494610c",
"workflowId": "308d069c-acaf-456a-b9a1-0a42d2876e0b"
}
},
"eventId": "335b25c5-1fe0-4302-9241-89bfde4d",
"eventTime": "2024-07-16T09:31:31Z",
"eventType": "com.qlik.alerting-task.execution-summary.created",
"eventTypeVersion": "1.0",
"source": "com.qlik/alerting",
"tenantId": "<tenant>",
"userId": "",
"links": {
"Self": {
"Href": "https://<tenant>/api/v1/audits/66963df32ea1bb46a72a930b"
},
"self": {
"href": "https://<tenant>/api/v1/audits/66963df32ea1bb46a72a930b"
}
}
}
Mail Transport events
Another event that may be relevant to distribution use cases like Subscriptions, Tabular Reporting or Data Alerts is the transport event found by filtering within the Management Console > Events on the Event Type = com.qlik.transport-response.email.sent. The event indicates that a connection was made and the payload was passed to the SMTP service. This event has no knowledge of any SMTP service processing of the payload.
{
"id": "66969fef2ea1bb46a740a013",
"contentType": "application/json",
"data": {
"accepted": [
"6437fea62c33a33f8e579163"
],
"connectionFailed": false,
"failure": false,
"message": "250 Ok: queued as gYcCT7j0RVWVG1Rov1RxXQ",
"rejected": [],
"requestId": null,
"serviceProvider": "classicSMTP",
"smtpResponseCode": 250,
"tracking": null
},
"eventId": "iqyjh8tg1Kgb9EeBgKrwcCuY3voqHrgz",
"eventTime": "2024-07-16T16:29:35.035Z",
"eventType": "com.qlik.transport-response.email.sent",
"eventTypeVersion": "1.0",
"source": "com.qlik/transport",
"tenantId": "<tenant>",
"userId": "",
"links": {
"Self": {
"Href": "https://<tenant>/api/v1/audits/66969fef2ea1bb46a740a013"
},
"self": {
"href": "https://<tenant>/api/v1/audits/66969fef2ea1bb46a740a013"
}
}
}
