Reports

Download AsyncAPI spec

Report processing data collected

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

object
  • id string
    Required

    Identifies the event.

    minLength = 1

  • time string

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

    minLength = 1, format = "date-time"

  • type string
    Required

    Unique identifier for the event type.

    Can be one of: "com.qlik.v1.report.collected"

    default = "com.qlik.v1.report.collected"

  • source string
    Required

    Identifies the context in which an event happened.

    minLength = 1, format = "uri-reference"

  • specversion string
    Required

    The version of the CloudEvents specification which the event uses.

    minLength = 1

  • datacontenttype string

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

    minLength = 1, default = "application/json"

  • userid string

    Unique identifier for the user triggering the event.

  • authtype string

    Representing the type of principal that triggered the occurrence.

  • tenantid string
    Required

    Unique identifier for the tenant related to the event.

  • authclaims string

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

  • data object
    Required

    The data payload for a report processing event.

    Show data properties
    • act object

      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.

      Show act properties
      • issuer string

        Identifier of the issuer of the acting party's identity.

      • subject string

        Identifier of the acting party (the sub claim of the act claim).

      • subtype string

        Type of the acting party, for example user or service.
    • tags array of strings

      Array of tags sent by requester client.

    • issuer string

      The issuer of the request from the jwt

    • reports object
      Required

      The summary information on the triggered request

      Show reports properties
      • meta object

        Report meta info

        Show meta properties
        • outputTtlSecs integer

          Seconds to live of the final result artifacts

        • exportDeadlineSecs integer

          The maximum interval in seconds, starting from the time the API request is received, within which a report must be produced
      • results array of objects
        Required

        Array of results that occurred during report generation.

        Show results properties
        • errors array of objects

          Array of errors that occurred during report generation.

          Show errors properties
          • code string
            Required

            The unique code for the error.

          • chartId string

            Chart id.

          • chartType string

            Chart type.
        • format string

          The output format

        • success boolean
          Required

          The flag indicating a successful report generation [true, false]

        • outputId string
          Required

          The outputId [Chart_image, Chart_pdf, chart_excel, Sheet_pdf, Multisheet_PDF].

        • sizeBytes integer

          output size in bytes

        • timeMsecs integer
          Required

          The time elapsed in milliseconds

        • dataExport object

          Excel export info

          Show dataExport properties
          • vizType string

            visualization type

          • cellCount integer

            cell data count

          • rowNumber integer

            number of data rows

          • columnNumber integer

            number of data columns
        • serverError boolean
          Required

          The flag indicating if there is a server/backend error
      • loadType string
        Required

        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 object
        Required

        The template of the request: template holds a single template, compositionTemplates holds the ordered list of templates when the request is a composition.

        Show templates properties
        • template object

          The object with information for templateType

          Show template properties
          • appId string
            Required

            The unique identifier of the app the request is related to.

          • objectId string
            Required

            The unique identifier of the app's object the report is related to.

          • templateType string
            Required

            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
        • compositionTemplates array of objects

          Array of templates defining a composition

          Show compositionTemplates properties
          • appId string
            Required

            The unique identifier of the app the request is related to.

          • objectId string
            Required

            The unique identifier of the app's object the report is related to.

          • templateType string
            Required

            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
      • templateType string
        Required

        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
    • subject string

      The subject of the request from the jwt

    • subtype string

      The subtype of the request from the jwt

    • traceId string
      Required

      telemetry trace ID

    • version string
      Required

      Version of the EventType, it uses semantic versioning.

    • clientId string

      The unique ID identifying the client

    • reportId string
      Required

      Unique identifier of the report. It is an opaque string, consumers must not parse it or rely on its format.

    • requestId string
      Required

      The unique ID identifying the request

    • consumption object
      Required

      Resource consumption of the report generation. All durations are expressed in milliseconds.

      Show consumption properties
      • level any
      • endTime string
        Required

        timestamp of when the response is ready.

        format = "date-time"

      • cellCount integer

        Total number of data cells exported.

      • startTime string
        Required

        timestamp of when the request arrives.

        format = "date-time"

      • objectCount integer
        Required

        exported object count

      • maxCellCount integer

        cell count of biggest data export

      • minCellCount integer

        cell count of the smallest data export

      • variableCount integer

        Number of variables applied to the report.

      • taskRetryCount integer

        Number of times tasks of the report were retried after a failure.

      • senseSheetCount integer
        Required

        Number of sheets in the request

      • dataDurationStat object

        Statistics of a set of timed operations. All durations are in milliseconds.

        Show dataDurationStat properties
        • failedCount integer

          The number of failed exports

        • sampleCount integer

          Total sample count

        • maxDurationMsecs integer

          Max duration in milliseconds

        • minDurationMsecs integer

          Min duration in milliseconds

        • totDurationMsecs integer

          Total duration in milliseconds
      • queuingDelayStat object

        Statistics of a set of timed operations. All durations are in milliseconds.

        Show queuingDelayStat properties
        • failedCount integer

          The number of failed exports

        • sampleCount integer

          Total sample count

        • maxDurationMsecs integer

          Max duration in milliseconds

        • minDurationMsecs integer

          Min duration in milliseconds

        • totDurationMsecs integer

          Total duration in milliseconds
      • taskDurationStat any
      • chartDurationStat any
      • tcsUploadTimeMsecs integer
        Required

        Total time in milliseconds spent uploading the generated report to the storage service.

      • exportDurationMsecs integer
        Required

        Total elapsed time in milliseconds from the arrival of the request to the completion of the report generation, including queuing time.

      • openAppDurationStat object

        Statistics of a set of timed operations. All durations are in milliseconds.

        Show openAppDurationStat properties
        • failedCount integer

          The number of failed exports

        • sampleCount integer

          Total sample count

        • maxDurationMsecs integer

          Max duration in milliseconds

        • minDurationMsecs integer

          Min duration in milliseconds

        • totDurationMsecs integer

          Total duration in milliseconds
      • renderedDurationStat object

        Statistics of a set of timed operations. All durations are in milliseconds.

        Show renderedDurationStat properties
        • failedCount integer

          The number of failed exports

        • sampleCount integer

          Total sample count

        • maxDurationMsecs integer

          Max duration in milliseconds

        • minDurationMsecs integer

          Min duration in milliseconds

        • totDurationMsecs integer

          Total duration in milliseconds
      • applyFilterDurationStat object

        Statistics of a set of timed operations. All durations are in milliseconds.

        Show applyFilterDurationStat properties
        • failedCount integer

          The number of failed exports

        • sampleCount integer

          Total sample count

        • maxDurationMsecs integer

          Max duration in milliseconds

        • minDurationMsecs integer

          Min duration in milliseconds

        • totDurationMsecs integer

          Total duration in milliseconds
      • compositionDurationMsecs integer

        Time in milliseconds spent composing the final output from the generated parts, for composition and template-based reports.

      • applyVariablesDurationStat object

        Statistics of a set of timed operations. All durations are in milliseconds.

        Show applyVariablesDurationStat properties
        • failedCount integer

          The number of failed exports

        • sampleCount integer

          Total sample count

        • maxDurationMsecs integer

          Max duration in milliseconds

        • minDurationMsecs integer

          Min duration in milliseconds

        • totDurationMsecs integer

          Total duration in milliseconds
    • originalURL string

      The Original URL of the caller.

    • globalResult string
      Required

      All reports succeeded is "success", all reports failed is "failed", else is "partial".

      Can be one of: "success""partial""failed"

    • browserLikeOrigin boolean
      Required

      The flag indicating the request is likely coming from a client.

com.qlik.v1.report.collected

Example payload of the "Report processing data collected" event

{
  "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
  }
}

Cycle-based report generation triggered

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

object
  • id string
    Required

    Identifies the event.

    minLength = 1

  • time string

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

    minLength = 1, format = "date-time"

  • type string
    Required

    Unique identifier for the event type.

    Can be one of: "com.qlik.v1.report.triggered"

    default = "com.qlik.v1.report.triggered"

  • source string
    Required

    Identifies the context in which an event happened.

    minLength = 1, format = "uri-reference"

  • specversion string
    Required

    The version of the CloudEvents specification which the event uses.

    minLength = 1

  • datacontenttype string

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

    minLength = 1, default = "application/json"

  • userid string

    Unique identifier for the user triggering the event.

  • authtype string

    Representing the type of principal that triggered the occurrence.

  • tenantid string
    Required

    Unique identifier for the tenant related to the event.

  • authclaims string

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

  • data object
    Required

    The data payload for a report processing event.

    Show data properties
    • act object

      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.

      Show act properties
      • issuer string

        Identifier of the issuer of the acting party's identity.

      • subject string

        Identifier of the acting party (the sub claim of the act claim).

      • subtype string

        Type of the acting party, for example user or service.
    • tags array of strings

      Array of tags sent by requester client.

    • issuer string

      The issuer of the request from the jwt

    • reports object
      Required

      The summary information on the triggered request

      Show reports properties
      • meta object

        Report meta info

        Show meta properties
        • outputTtlSecs integer

          Seconds to live of the final result artifacts

        • exportDeadlineSecs integer

          The maximum interval in seconds, starting from the time the API request is received, within which a report must be produced
      • results array of objects
        Required

        Array of results that occurred during report generation.

        Show results properties
        • errors array of objects

          Array of errors that occurred during report generation.

          Show errors properties
          • code string
            Required

            The unique code for the error.

          • chartId string

            Chart id.

          • chartType string

            Chart type.
        • format string

          The output format

        • success boolean
          Required

          The flag indicating a successful report generation [true, false]

        • outputId string
          Required

          The outputId [Chart_image, Chart_pdf, chart_excel, Sheet_pdf, Multisheet_PDF].

        • sizeBytes integer

          output size in bytes

        • timeMsecs integer
          Required

          The time elapsed in milliseconds

        • dataExport object

          Excel export info

          Show dataExport properties
          • vizType string

            visualization type

          • cellCount integer

            cell data count

          • rowNumber integer

            number of data rows

          • columnNumber integer

            number of data columns
        • serverError boolean
          Required

          The flag indicating if there is a server/backend error
      • loadType string
        Required

        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 object
        Required

        The template of the request: template holds a single template, compositionTemplates holds the ordered list of templates when the request is a composition.

        Show templates properties
        • template object

          The object with information for templateType

          Show template properties
          • appId string
            Required

            The unique identifier of the app the request is related to.

          • objectId string
            Required

            The unique identifier of the app's object the report is related to.

          • templateType string
            Required

            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
        • compositionTemplates array of objects

          Array of templates defining a composition

          Show compositionTemplates properties
          • appId string
            Required

            The unique identifier of the app the request is related to.

          • objectId string
            Required

            The unique identifier of the app's object the report is related to.

          • templateType string
            Required

            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
      • templateType string
        Required

        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
    • subject string

      The subject of the request from the jwt

    • subtype string

      The subtype of the request from the jwt

    • traceId string
      Required

      telemetry trace ID

    • version string
      Required

      Version of the EventType, it uses semantic versioning.

    • clientId string

      The unique ID identifying the client

    • reportId string
      Required

      Unique identifier of the report. It is an opaque string, consumers must not parse it or rely on its format.

    • requestId string
      Required

      The unique ID identifying the request

    • consumption object
      Required

      Resource consumption of the report generation. All durations are expressed in milliseconds.

      Show consumption properties
      • level any
      • endTime string
        Required

        timestamp of when the response is ready.

        format = "date-time"

      • cellCount integer

        Total number of data cells exported.

      • startTime string
        Required

        timestamp of when the request arrives.

        format = "date-time"

      • objectCount integer
        Required

        exported object count

      • maxCellCount integer

        cell count of biggest data export

      • minCellCount integer

        cell count of the smallest data export

      • variableCount integer

        Number of variables applied to the report.

      • taskRetryCount integer

        Number of times tasks of the report were retried after a failure.

      • senseSheetCount integer
        Required

        Number of sheets in the request

      • dataDurationStat object

        Statistics of a set of timed operations. All durations are in milliseconds.

        Show dataDurationStat properties
        • failedCount integer

          The number of failed exports

        • sampleCount integer

          Total sample count

        • maxDurationMsecs integer

          Max duration in milliseconds

        • minDurationMsecs integer

          Min duration in milliseconds

        • totDurationMsecs integer

          Total duration in milliseconds
      • queuingDelayStat object

        Statistics of a set of timed operations. All durations are in milliseconds.

        Show queuingDelayStat properties
        • failedCount integer

          The number of failed exports

        • sampleCount integer

          Total sample count

        • maxDurationMsecs integer

          Max duration in milliseconds

        • minDurationMsecs integer

          Min duration in milliseconds

        • totDurationMsecs integer

          Total duration in milliseconds
      • taskDurationStat any
      • chartDurationStat any
      • tcsUploadTimeMsecs integer
        Required

        Total time in milliseconds spent uploading the generated report to the storage service.

      • exportDurationMsecs integer
        Required

        Total elapsed time in milliseconds from the arrival of the request to the completion of the report generation, including queuing time.

      • openAppDurationStat object

        Statistics of a set of timed operations. All durations are in milliseconds.

        Show openAppDurationStat properties
        • failedCount integer

          The number of failed exports

        • sampleCount integer

          Total sample count

        • maxDurationMsecs integer

          Max duration in milliseconds

        • minDurationMsecs integer

          Min duration in milliseconds

        • totDurationMsecs integer

          Total duration in milliseconds
      • renderedDurationStat object

        Statistics of a set of timed operations. All durations are in milliseconds.

        Show renderedDurationStat properties
        • failedCount integer

          The number of failed exports

        • sampleCount integer

          Total sample count

        • maxDurationMsecs integer

          Max duration in milliseconds

        • minDurationMsecs integer

          Min duration in milliseconds

        • totDurationMsecs integer

          Total duration in milliseconds
      • applyFilterDurationStat object

        Statistics of a set of timed operations. All durations are in milliseconds.

        Show applyFilterDurationStat properties
        • failedCount integer

          The number of failed exports

        • sampleCount integer

          Total sample count

        • maxDurationMsecs integer

          Max duration in milliseconds

        • minDurationMsecs integer

          Min duration in milliseconds

        • totDurationMsecs integer

          Total duration in milliseconds
      • compositionDurationMsecs integer

        Time in milliseconds spent composing the final output from the generated parts, for composition and template-based reports.

      • applyVariablesDurationStat object

        Statistics of a set of timed operations. All durations are in milliseconds.

        Show applyVariablesDurationStat properties
        • failedCount integer

          The number of failed exports

        • sampleCount integer

          Total sample count

        • maxDurationMsecs integer

          Max duration in milliseconds

        • minDurationMsecs integer

          Min duration in milliseconds

        • totDurationMsecs integer

          Total duration in milliseconds
    • originalURL string

      The Original URL of the caller.

    • globalResult string
      Required

      All reports succeeded is "success", all reports failed is "failed", else is "partial".

      Can be one of: "success""partial""failed"

    • browserLikeOrigin boolean
      Required

      The flag indicating the request is likely coming from a client.

com.qlik.v1.report.triggered

Example payload of the "Cycle-based report generation triggered" event

{
  "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
  }
}