Reporting tasks

Download AsyncAPI spec

Reporting task summary created

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
    • namestring
      Required

      The name of the report subscription.

    • taskIdstring
      Required

      The unique identifier of the sharing recurring task.

    • messagestring

      Message to be included in the mail body.

    • ownerIdstring

      The identifier of the sharing recurring task owner.

    • objectTypestring
      Required

      Object type is the template type (chart or sheet).

    • attachmentsarray of objects

      Array of attachment objects.

      Show attachments properties
      • fileTypestring
      • fileLocationstring
    • executionIdstring
      Required

      The unique identifier of the sharing recurring task execution.

    • insightLinkstring
      Required

      The insight link to open the app from the email.

    • imageLocationstring

      The temporary contents service URL of the PNG report to include in the email body.

    • attachmentLocationstring
      Required

      The temporary contents service URL of the PDF report to be attached in the email.

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": {
    "name": "My chart",
    "taskId": "602653af0a232c000170dec3",
    "message": "",
    "ownerId": "E347EilunjGVd3RTYcDXTVketixiwq_2",
    "objectType": "chart",
    "attachments": [
      {
        "fileType": "string",
        "fileLocation": "string"
      }
    ],
    "executionId": "60265e3b7c14f800011d99bc",
    "insightLink": "string",
    "imageLocation": "string",
    "attachmentLocation": "string"
  }
}