Reports

Download AsyncAPI spec

Reporting-service has collected a reports request

Reporting service event on reports request accepted and queued for processing according to the load type.

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"

  • host string

    The hostname of the event producer for example pod name.

  • userid string

    Unique identifier for the user triggering the event.

  • authtype string

    Representing the type of principal that triggered the occurrence.

  • originip string

    The origin host (hostname or IP address, optionally including a port) of the request that triggered the event, derived from the request's host.

  • 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.

  • tracestate string

    A comma-delimited list of key-value pairs.

  • traceparent string

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

  • toplevelresourceid string

    The top level resource id.

  • data object
    Required

    The data payload for a report processing event.

    Show data properties
    • act object

      The information from act header

      Show act properties
      • issuer string

        the acting issuer of the request

      • subject string

        the acting subject of the request

      • subtype string

        the acting subtype of the request
    • 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

        The load type assigned to the request for pool assignment

      • templates object
        Required

        The templating parameter, it can be a single template or a composition of templates

        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

      The unique ID identifying the report

    • requestId string
      Required

      The unique ID identifying the request

    • consumption object
      Required

      Details about report processing

      Show consumption properties
      • level object

        Level stats

        Show level properties
        • levelCount integer

          Level count

        • maxIteration integer

          Max iterations

        • totIteration integer

          Total iterations

        • maxNestedLevel integer

          Max nested level
      • endTime string
        Required

        timestamp of when the response is ready.

        format = "date-time"

      • cellCount integer

        cell count

      • 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

        Variable count

      • taskRetryCount integer

        Task retry count

      • senseSheetCount integer
        Required

        Number of sheets in the request

      • dataDurationStat object

        Details about report processing

        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

        Details about report processing

        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 object

        Type duration Map

        Show additional optional properties
        • object object

          Details about report processing

          Show object 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
      • chartDurationStat object

        Type duration Map

        Show additional optional properties
        • object object

          Details about report processing

          Show object 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
      • tcsUploadTimeMsecs integer
        Required

        TCS upload time

      • exportDurationMsecs integer
        Required

        export duration in milliseconds

      • openAppDurationStat object

        Details about report processing

        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

        Details about report processing

        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

        Details about report processing

        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

        composition duration in milliseconds

      • applyVariablesDurationStat object

        Details about report processing

        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 "Reporting-service has collected a reports request" 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",
  "host": "reporting-service-7d9f8c6b9c-abcde",
  "userid": "VZhiEfgW2bLd7HgR-jjzAh6VnicipweT",
  "authtype": "user",
  "originip": "203.0.113.42",
  "tenantid": "VZhiEfgW2bLd7HgR-jjzAh6VnicipweT",
  "authclaims": "{\"sub\":\"VZhiEfgW2bLd7HgR-jjzAh6VnicipweT\"}",
  "tracestate": "congo=t61rcWkgMzE",
  "traceparent": "00-0af7651916cd43dd8448eb211c80319c-b7ad6b7169203331-01",
  "toplevelresourceid": "ba2af9e6-0489-49a9-ae4d-8bf4a187f3c5",
  "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.0.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
  }
}

Reporting-service has triggered a reports request

Reporting service event on reports request triggered for cycle-based report generation.

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"

  • host string

    The hostname of the event producer for example pod name.

  • userid string

    Unique identifier for the user triggering the event.

  • authtype string

    Representing the type of principal that triggered the occurrence.

  • originip string

    The origin host (hostname or IP address, optionally including a port) of the request that triggered the event, derived from the request's host.

  • 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.

  • tracestate string

    A comma-delimited list of key-value pairs.

  • traceparent string

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

  • toplevelresourceid string

    The top level resource id.

  • data object
    Required

    The data payload for a report processing event.

    Show data properties
    • act object

      The information from act header

      Show act properties
      • issuer string

        the acting issuer of the request

      • subject string

        the acting subject of the request

      • subtype string

        the acting subtype of the request
    • 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

        The load type assigned to the request for pool assignment

      • templates object
        Required

        The templating parameter, it can be a single template or a composition of templates

        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

      The unique ID identifying the report

    • requestId string
      Required

      The unique ID identifying the request

    • consumption object
      Required

      Details about report processing

      Show consumption properties
      • level object

        Level stats

        Show level properties
        • levelCount integer

          Level count

        • maxIteration integer

          Max iterations

        • totIteration integer

          Total iterations

        • maxNestedLevel integer

          Max nested level
      • endTime string
        Required

        timestamp of when the response is ready.

        format = "date-time"

      • cellCount integer

        cell count

      • 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

        Variable count

      • taskRetryCount integer

        Task retry count

      • senseSheetCount integer
        Required

        Number of sheets in the request

      • dataDurationStat object

        Details about report processing

        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

        Details about report processing

        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 object

        Type duration Map

        Show additional optional properties
        • object object

          Details about report processing

          Show object 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
      • chartDurationStat object

        Type duration Map

        Show additional optional properties
        • object object

          Details about report processing

          Show object 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
      • tcsUploadTimeMsecs integer
        Required

        TCS upload time

      • exportDurationMsecs integer
        Required

        export duration in milliseconds

      • openAppDurationStat object

        Details about report processing

        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

        Details about report processing

        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

        Details about report processing

        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

        composition duration in milliseconds

      • applyVariablesDurationStat object

        Details about report processing

        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 "Reporting-service has triggered a reports request" 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",
  "host": "reporting-service-7d9f8c6b9c-abcde",
  "userid": "VZhiEfgW2bLd7HgR-jjzAh6VnicipweT",
  "authtype": "user",
  "originip": "203.0.113.42",
  "tenantid": "VZhiEfgW2bLd7HgR-jjzAh6VnicipweT",
  "authclaims": "{\"sub\":\"VZhiEfgW2bLd7HgR-jjzAh6VnicipweT\"}",
  "tracestate": "congo=t61rcWkgMzE",
  "traceparent": "00-0af7651916cd43dd8448eb211c80319c-b7ad6b7169203331-01",
  "toplevelresourceid": "ba2af9e6-0489-49a9-ae4d-8bf4a187f3c5",
  "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.0.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
  }
}