Reporting tasks

Download AsyncAPI spec

Reporting task events notify you about the execution of scheduled report generation and delivery workflows, helping you track report distribution activity.

Published when a summary is generated for a reporting task execution. Includes task metadata and execution statistics. Use this to track reporting outcomes.

Payload

object

idstring
Required

Identifies the event.

minLength = 1
timestring

Timestamp of when the occurrence happened. Must adhere to RFC 3339.

minLength = 1, format = "date-time"
typestring
Required

The unique identifier for the event type.

default = "com.qlik.reporting-task.summary.created"
sourcestring
Required

Identifies the context in which an event happened.

minLength = 1, format = "uri-reference"
specversionstring
Required

The version of the CloudEvents specification which the event uses.

minLength = 1
datacontenttypestring

Content type of the data value. Must adhere to RFC 2046 format.

minLength = 1
useridstring

The unique identifier for the user triggering the event.
authtypestring

The type of principal that triggered the occurrence.
tenantidstring
Required

The unique identifier for the tenant related to the event.
authclaimsstring

A JSON string representing claims of the principal that triggered the event.
tracestatestring

A comma-delimited list of key-value pairs.
traceparentstring

Contains a version, trace ID, span ID, and trace options.
dataobject

Contains the event-specific attributes of the payload.
Show data properties
- idstring
  Required
  
  The identifier of the report.
- namestring
  Required
  
  The name of the reporting task.
- appIdstring
  Required
  
  The identifier of the app.
- errorstring
  
  The error of the report task.
- expirystring
  
  The expiration date.
- statusstring
  Required
  
  The status of the report task.
- enabledboolean
  Required
  
  Indicates whether the recipient is enabled.
- ownerIdstring
  Required
  
  The identifier of the report owner.
- spaceIdstring
  
  The identifier of the space.
- traceIdstring
  
  The identifier used for tracing the reporting task summary event.
- creatorIdstring
  Required
  
  The identifier of the report creator.
- thumbnailstring
  Required
  
  The link to the thumbnail image.
- resourceIdstring
  Required
  
  The resource identifier of the reporting task.
- transportsarray
  Required
  
  Array of strings includes transports.
- workflowIdstring
  Required
  
  The identifier of the workflow that the reporting task execution is associated with.
- createdDatestring
  Required
  
  The date when the reporting task was created.
- descriptionstring
  Required
  
  The description of the reporting task.
- insightLinkstring
  Required
  
  An insight link to open the app from the email.
- typeOfSpacestring
  
  The type of space.
- resourceLinkstring
  Required
  
  The resourceLink of a reporting task.
- resourceTypestring
  Required
  
  The resource type of the reporting task.
- sharingTaskTypestring
  Required
  
  The type of sharing task.
- hassectionaccessboolean
  Required
  
  Whether the associated app has section access enabled.
- sharingTaskOwnerIdstring
  Required
  
  The identifier of the sharing task owner.
- distributionchannelsarray
  Required
  
  The distribution channels for the report task.
- sharingTaskExecutionIdstring
  
  The identifier of the sharing task execution.
- reportingServiceEventIdstring
  Required
  
  The identifier of the execution event associated with this report task.
- failedReportsinteger
  Required
  
  The count of reports that failed to generate.
- taskExecutionIdstring
  Required
  
  The identifier of the reporting task execution this summary pertains to.
- failedExecutionsinteger
  Required
  
  The count of failed executions for the reporting task.
- successfulReportsinteger
  Required
  
  The count of successfully generated reports.
- emailRecipientsCountinteger
  
  The total count of sharing email recipients.
- successfulExecutionsinteger
  Required
  
  The count of successful executions for the reporting task.
- emailRecipientEnabledExternalCountinteger
  
  The count of external enabled sharing email recipients.
- emailRecipientEnabledInternalCountinteger
  
  The count of internal enabled sharing email recipients.
- emailRecipientDisabledExternalCountinteger
  
  The count of external disabled sharing email recipients.
- emailRecipientDisabledInternalCountinteger
  
  The count of internal disabled sharing email recipients.

com.qlik.reporting-task.summary.created

Example payload of the "Reporting task summary created" event

{
  "id": "A234-1234-1234",
  "time": "2025-01-15T10:43:17Z",
  "type": "com.qlik.reporting-task.summary.created",
  "source": "com.qlik/my-service",
  "specversion": "1.0",
  "datacontenttype": "application/json",
  "userid": "VZhiEfgW2bLd7HgR-jjzAh6VnicipweT",
  "authtype": "User",
  "tenantid": "VZhiEfgW2bLd7HgR-jjzAh6VnicipweT",
  "authclaims": "{\n  \"sub\": \"VZhiEfgW2bLd7HgR-jjzAh6VnicipweT\",\n  \"email\": \"user@example.com\",\n  \"roles\": [\"admin\", \"editor\"]\n}\n",
  "tracestate": "rojo=00f067aa0ba902b7,congo=t61rcWkgMzE",
  "traceparent": "00-4bf92f3577b34da6a3ce929d0e0e4736-00f067aa0ba902b7-01",
  "data": {
    "id": "63f622472ef44d955d3442a2",
    "name": "test",
    "appId": "9c6b39c8-4624-4b2c-8c7b-bb91b919a421",
    "error": "string",
    "expiry": "",
    "status": "SUCCESS",
    "enabled": true,
    "ownerId": "63f622472ef44d955d3442a2",
    "spaceId": "63f622472ef44d955d3442a2",
    "traceId": "64b6d2e7a9f211331271421e",
    "creatorId": "63f622472ef44d955d3442a2",
    "thumbnail": "/api/v1/sharing-tasks/64b6d2e7a9f211331271421e/executions/latest/files/",
    "resourceId": "64b6d2e7a9f211331271421e",
    "transports": [
      "sharepoint",
      "email"
    ],
    "workflowId": "64b6d2e7a9f211331271421e",
    "createdDate": "2023-07-18T17:59:03Z",
    "description": "Weekly sales report for the EMEA region",
    "insightLink": "string",
    "typeOfSpace": "managed",
    "resourceLink": "https://tenant.us.qlikcloud.com/reporting/task/64b6d2e7a9f211331271421e",
    "resourceType": "reporting-task",
    "sharingTaskType": "template-sharing",
    "hassectionaccess": true,
    "sharingTaskOwnerId": "63f622472ef44d955d3442a2",
    "distributionchannels": [
      "DOU_Sharepoint_Connection",
      "dou@qlik.com"
    ],
    "sharingTaskExecutionId": "64b6d2e7a9f211331271421e",
    "reportingServiceEventId": "64b6d2e7a9f211331271421e",
    "failedReports": 0,
    "taskExecutionId": "64b6d2e7a9f211331271421e",
    "failedExecutions": 0,
    "successfulReports": 1,
    "emailRecipientsCount": 1,
    "successfulExecutions": 1,
    "emailRecipientEnabledExternalCount": 1,
    "emailRecipientEnabledInternalCount": 1,
    "emailRecipientDisabledExternalCount": 0,
    "emailRecipientDisabledInternalCount": 0
  }
}