---
source: https://qlik.dev/apis/event/reports/
last_updated: 2026-10-13T16:10:02+02:00
---

# Reports

## Table of Contents

### system-events.report

- [com.qlik.v1.report.collected](#comqlikv1reportcollected)
- [com.qlik.v1.report.triggered](#comqlikv1reporttriggered)

## Events published on the `system-events.report` channel

### com.qlik.v1.report.collected

**Title:** Reporting-service has collected a reports request

**Action:** `send`

**Visibility:** `public`

**Stability:** `stable`

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

**Payload**

| Name | Type | Required | Description |
| --- | --- | --- | --- |
| `id` | `string` | Yes | Identifies the event. Metadata: minLength = 1. |
| `time` | `string` | No | Timestamp of when the occurrence happened. Must adhere to RFC 3339. Metadata: minLength = 1, format = "date-time". |
| `type` | `string` | Yes | Unique identifier for the event type. Allowed values: com.qlik.v1.report.collected. Metadata: default = "com.qlik.v1.report.collected". |
| `source` | `string` | Yes | Identifies the context in which an event happened. Metadata: minLength = 1, format = "uri-reference". |
| `specversion` | `string` | Yes | The version of the CloudEvents specification which the event uses. Metadata: minLength = 1. |
| `datacontenttype` | `string` | No | Content type of the data value. Must adhere to RFC 2046 format. Metadata: minLength = 1, default = "application/json". |
| `host` | `string` | No | The hostname of the event producer for example pod name. |
| `userid` | `string` | No | Unique identifier for the user triggering the event. |
| `authtype` | `string` | No | Representing the type of principal that triggered the occurrence. |
| `originip` | `string` | No | 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` | Yes | Unique identifier for the tenant related to the event. |
| `authclaims` | `string` | No | A JSON string representing claims of the principal that triggered the event. |
| `tracestate` | `string` | No | A comma-delimited list of key-value pairs. |
| `traceparent` | `string` | No | Contains a version, trace ID, span ID, and trace options. |
| `toplevelresourceid` | `string` | No | The top level resource id. |
| `data` | `dataPayload` | Yes | The data payload for a report processing event. |

<details>
<summary>Properties of `data`</summary>

| Name | Type | Required | Description |
| --- | --- | --- | --- |
| `act` | `act` | No | The information from act header |
| `tags` | `tags[]` | No | Array of tags sent by requester client. |
| `issuer` | `string` | No | The issuer of the request from the jwt |
| `reports` | `reports` | Yes | The summary information on the triggered request |
| `subject` | `string` | No | The subject of the request from the jwt |
| `subtype` | `string` | No | The subtype of the request from the jwt |
| `traceId` | `string` | Yes | telemetry trace ID |
| `version` | `string` | Yes | Version of the EventType, it uses semantic versioning. |
| `clientId` | `string` | No | The unique ID identifying the client |
| `reportId` | `string` | Yes | The unique ID identifying the report |
| `requestId` | `string` | Yes | The unique ID identifying the request |
| `consumption` | `consumption` | Yes | Details about report processing |
| `originalURL` | `string` | No | The Original URL of the caller. |
| `globalResult` | `string` | Yes | All reports succeeded is "success", all reports failed is "failed", else is "partial". Allowed values: success \| partial \| failed. |
| `browserLikeOrigin` | `boolean` | Yes | The flag indicating the request is likely coming from a client. |

<details>
<summary>Properties of `act`</summary>

| Name | Type | Required | Description |
| --- | --- | --- | --- |
| `issuer` | `string` | No | the acting issuer of the request |
| `subject` | `string` | No | the acting subject of the request |
| `subtype` | `string` | No | the acting subtype of the request |

</details>

<details>
<summary>Properties of `reports`</summary>

| Name | Type | Required | Description |
| --- | --- | --- | --- |
| `meta` | `metaReport` | No | Report meta info |
| `results` | `results[]` | Yes | Array of results that occurred during report generation. |
| `loadType` | `string` | Yes | The load type assigned to the request for pool assignment |
| `templates` | `templates` | Yes | The templating parameter, it can be a single template or a composition of templates |
| `templateType` | `string` | Yes | 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 |

<details>
<summary>Properties of `meta`</summary>

_Properties truncated due to depth limit._

</details>

<details>
<summary>Properties of `results`</summary>

_Properties truncated due to depth limit._

</details>

<details>
<summary>Properties of `templates`</summary>

_Properties truncated due to depth limit._

</details>

</details>

<details>
<summary>Properties of `consumption`</summary>

| Name | Type | Required | Description |
| --- | --- | --- | --- |
| `level` | `levelStat` | No | Level stats |
| `endTime` | `string` | Yes | timestamp of when the response is ready. Metadata: format = "date-time". |
| `cellCount` | `integer` | No | cell count |
| `startTime` | `string` | Yes | timestamp of when the request arrives. Metadata: format = "date-time". |
| `objectCount` | `integer` | Yes | exported object count |
| `maxCellCount` | `integer` | No | cell count of biggest data export |
| `minCellCount` | `integer` | No | cell count of the smallest data export |
| `variableCount` | `integer` | No | Variable count |
| `taskRetryCount` | `integer` | No | Task retry count |
| `senseSheetCount` | `integer` | Yes | Number of sheets in the request |
| `dataDurationStat` | `durationStat` | No | Details about report processing |
| `queuingDelayStat` | `durationStat` | No | Details about report processing |
| `taskDurationStat` | `taskDurationStat` | No | Type duration Map |
| `chartDurationStat` | `chartDurationStat` | No | Type duration Map |
| `tcsUploadTimeMsecs` | `integer` | Yes | TCS upload time |
| `exportDurationMsecs` | `integer` | Yes | export duration in milliseconds |
| `openAppDurationStat` | `durationStat` | No | Details about report processing |
| `renderedDurationStat` | `durationStat` | No | Details about report processing |
| `applyFilterDurationStat` | `durationStat` | No | Details about report processing |
| `compositionDurationMsecs` | `integer` | No | composition duration in milliseconds |
| `applyVariablesDurationStat` | `durationStat` | No | Details about report processing |

<details>
<summary>Properties of `level`</summary>

_Properties truncated due to depth limit._

</details>

<details>
<summary>Properties of `dataDurationStat`</summary>

_Properties truncated due to depth limit._

</details>

<details>
<summary>Properties of `queuingDelayStat`</summary>

_Properties truncated due to depth limit._

</details>

<details>
<summary>Properties of `openAppDurationStat`</summary>

_Properties truncated due to depth limit._

</details>

<details>
<summary>Properties of `renderedDurationStat`</summary>

_Properties truncated due to depth limit._

</details>

<details>
<summary>Properties of `applyFilterDurationStat`</summary>

_Properties truncated due to depth limit._

</details>

<details>
<summary>Properties of `applyVariablesDurationStat`</summary>

_Properties truncated due to depth limit._

</details>

</details>

</details>


**Example**

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


### com.qlik.v1.report.triggered

**Title:** Reporting-service has triggered a reports request

**Action:** `send`

**Visibility:** `public`

**Stability:** `stable`

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

**Payload**

| Name | Type | Required | Description |
| --- | --- | --- | --- |
| `id` | `string` | Yes | Identifies the event. Metadata: minLength = 1. |
| `time` | `string` | No | Timestamp of when the occurrence happened. Must adhere to RFC 3339. Metadata: minLength = 1, format = "date-time". |
| `type` | `string` | Yes | Unique identifier for the event type. Allowed values: com.qlik.v1.report.triggered. Metadata: default = "com.qlik.v1.report.triggered". |
| `source` | `string` | Yes | Identifies the context in which an event happened. Metadata: minLength = 1, format = "uri-reference". |
| `specversion` | `string` | Yes | The version of the CloudEvents specification which the event uses. Metadata: minLength = 1. |
| `datacontenttype` | `string` | No | Content type of the data value. Must adhere to RFC 2046 format. Metadata: minLength = 1, default = "application/json". |
| `host` | `string` | No | The hostname of the event producer for example pod name. |
| `userid` | `string` | No | Unique identifier for the user triggering the event. |
| `authtype` | `string` | No | Representing the type of principal that triggered the occurrence. |
| `originip` | `string` | No | 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` | Yes | Unique identifier for the tenant related to the event. |
| `authclaims` | `string` | No | A JSON string representing claims of the principal that triggered the event. |
| `tracestate` | `string` | No | A comma-delimited list of key-value pairs. |
| `traceparent` | `string` | No | Contains a version, trace ID, span ID, and trace options. |
| `toplevelresourceid` | `string` | No | The top level resource id. |
| `data` | `dataPayload` | Yes | The data payload for a report processing event. |

<details>
<summary>Properties of `data`</summary>

| Name | Type | Required | Description |
| --- | --- | --- | --- |
| `act` | `act` | No | The information from act header |
| `tags` | `tags[]` | No | Array of tags sent by requester client. |
| `issuer` | `string` | No | The issuer of the request from the jwt |
| `reports` | `reports` | Yes | The summary information on the triggered request |
| `subject` | `string` | No | The subject of the request from the jwt |
| `subtype` | `string` | No | The subtype of the request from the jwt |
| `traceId` | `string` | Yes | telemetry trace ID |
| `version` | `string` | Yes | Version of the EventType, it uses semantic versioning. |
| `clientId` | `string` | No | The unique ID identifying the client |
| `reportId` | `string` | Yes | The unique ID identifying the report |
| `requestId` | `string` | Yes | The unique ID identifying the request |
| `consumption` | `consumption` | Yes | Details about report processing |
| `originalURL` | `string` | No | The Original URL of the caller. |
| `globalResult` | `string` | Yes | All reports succeeded is "success", all reports failed is "failed", else is "partial". Allowed values: success \| partial \| failed. |
| `browserLikeOrigin` | `boolean` | Yes | The flag indicating the request is likely coming from a client. |

<details>
<summary>Properties of `act`</summary>

| Name | Type | Required | Description |
| --- | --- | --- | --- |
| `issuer` | `string` | No | the acting issuer of the request |
| `subject` | `string` | No | the acting subject of the request |
| `subtype` | `string` | No | the acting subtype of the request |

</details>

<details>
<summary>Properties of `reports`</summary>

| Name | Type | Required | Description |
| --- | --- | --- | --- |
| `meta` | `metaReport` | No | Report meta info |
| `results` | `results[]` | Yes | Array of results that occurred during report generation. |
| `loadType` | `string` | Yes | The load type assigned to the request for pool assignment |
| `templates` | `templates` | Yes | The templating parameter, it can be a single template or a composition of templates |
| `templateType` | `string` | Yes | 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 |

<details>
<summary>Properties of `meta`</summary>

_Properties truncated due to depth limit._

</details>

<details>
<summary>Properties of `results`</summary>

_Properties truncated due to depth limit._

</details>

<details>
<summary>Properties of `templates`</summary>

_Properties truncated due to depth limit._

</details>

</details>

<details>
<summary>Properties of `consumption`</summary>

| Name | Type | Required | Description |
| --- | --- | --- | --- |
| `level` | `levelStat` | No | Level stats |
| `endTime` | `string` | Yes | timestamp of when the response is ready. Metadata: format = "date-time". |
| `cellCount` | `integer` | No | cell count |
| `startTime` | `string` | Yes | timestamp of when the request arrives. Metadata: format = "date-time". |
| `objectCount` | `integer` | Yes | exported object count |
| `maxCellCount` | `integer` | No | cell count of biggest data export |
| `minCellCount` | `integer` | No | cell count of the smallest data export |
| `variableCount` | `integer` | No | Variable count |
| `taskRetryCount` | `integer` | No | Task retry count |
| `senseSheetCount` | `integer` | Yes | Number of sheets in the request |
| `dataDurationStat` | `durationStat` | No | Details about report processing |
| `queuingDelayStat` | `durationStat` | No | Details about report processing |
| `taskDurationStat` | `taskDurationStat` | No | Type duration Map |
| `chartDurationStat` | `chartDurationStat` | No | Type duration Map |
| `tcsUploadTimeMsecs` | `integer` | Yes | TCS upload time |
| `exportDurationMsecs` | `integer` | Yes | export duration in milliseconds |
| `openAppDurationStat` | `durationStat` | No | Details about report processing |
| `renderedDurationStat` | `durationStat` | No | Details about report processing |
| `applyFilterDurationStat` | `durationStat` | No | Details about report processing |
| `compositionDurationMsecs` | `integer` | No | composition duration in milliseconds |
| `applyVariablesDurationStat` | `durationStat` | No | Details about report processing |

<details>
<summary>Properties of `level`</summary>

_Properties truncated due to depth limit._

</details>

<details>
<summary>Properties of `dataDurationStat`</summary>

_Properties truncated due to depth limit._

</details>

<details>
<summary>Properties of `queuingDelayStat`</summary>

_Properties truncated due to depth limit._

</details>

<details>
<summary>Properties of `openAppDurationStat`</summary>

_Properties truncated due to depth limit._

</details>

<details>
<summary>Properties of `renderedDurationStat`</summary>

_Properties truncated due to depth limit._

</details>

<details>
<summary>Properties of `applyFilterDurationStat`</summary>

_Properties truncated due to depth limit._

</details>

<details>
<summary>Properties of `applyVariablesDurationStat`</summary>

_Properties truncated due to depth limit._

</details>

</details>

</details>


**Example**

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


## Schemas

### act

The information from act header

**Type:** `object`

**Properties**

| Name | Type | Required | Description |
| --- | --- | --- | --- |
| `issuer` | `string` | No | the acting issuer of the request |
| `subject` | `string` | No | the acting subject of the request |
| `subtype` | `string` | No | the acting subtype of the request |



### chartDurationStat

Type duration Map

**Type:** `object`

**Properties**

| Name | Type | Required | Description |
| --- | --- | --- | --- |
| `taskDurationStat` | `object` | No | Type duration Map |



### cloudEventsContextAttributes

CloudEvents Specification JSON Schema

**Type:** `object`

**Properties**

| Name | Type | Required | Description |
| --- | --- | --- | --- |
| `id` | `string` | Yes | Identifies the event. Metadata: minLength = 1. |
| `time` | `string` | No | Timestamp of when the occurrence happened. Must adhere to RFC 3339. Metadata: minLength = 1, format = "date-time". |
| `type` | `string` | Yes | Describes the type of event related to the originating occurrence. Metadata: minLength = 1. |
| `source` | `string` | Yes | Identifies the context in which an event happened. Metadata: minLength = 1, format = "uri-reference". |
| `specversion` | `string` | Yes | The version of the CloudEvents specification which the event uses. Metadata: minLength = 1. |
| `datacontenttype` | `string` | No | Content type of the data value. Must adhere to RFC 2046 format. Metadata: minLength = 1, default = "application/json". |



### cloudEventsQlikExtensionsAttributes

**Type:** `object`

**Properties**

| Name | Type | Required | Description |
| --- | --- | --- | --- |
| `host` | `string` | No | The hostname of the event producer for example pod name. |
| `userid` | `string` | No | Unique identifier for the user triggering the event. |
| `authtype` | `string` | No | Representing the type of principal that triggered the occurrence. |
| `originip` | `string` | No | 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` | Yes | Unique identifier for the tenant related to the event. |
| `authclaims` | `string` | No | A JSON string representing claims of the principal that triggered the event. |
| `tracestate` | `string` | No | A comma-delimited list of key-value pairs. |
| `traceparent` | `string` | No | Contains a version, trace ID, span ID, and trace options. |
| `toplevelresourceid` | `string` | No | The top level resource id. |



### compositionTemplates

Array of templates defining a composition

**Type:** `object[]`

**Properties**

| Name | Type | Required | Description |
| --- | --- | --- | --- |
| `appId` | `string` | Yes | The unique identifier of the app the request is related to. |
| `objectId` | `string` | Yes | The unique identifier of the app's object the report is related to. |
| `templateType` | `string` | Yes | 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 |



### consumption

Details about report processing

**Type:** `object`

**Properties**

| Name | Type | Required | Description |
| --- | --- | --- | --- |
| `level` | `levelStat` | No | Level stats |
| `endTime` | `string` | Yes | timestamp of when the response is ready. Metadata: format = "date-time". |
| `cellCount` | `integer` | No | cell count |
| `startTime` | `string` | Yes | timestamp of when the request arrives. Metadata: format = "date-time". |
| `objectCount` | `integer` | Yes | exported object count |
| `maxCellCount` | `integer` | No | cell count of biggest data export |
| `minCellCount` | `integer` | No | cell count of the smallest data export |
| `variableCount` | `integer` | No | Variable count |
| `taskRetryCount` | `integer` | No | Task retry count |
| `senseSheetCount` | `integer` | Yes | Number of sheets in the request |
| `dataDurationStat` | `durationStat` | No | Details about report processing |
| `queuingDelayStat` | `durationStat` | No | Details about report processing |
| `taskDurationStat` | `taskDurationStat` | No | Type duration Map |
| `chartDurationStat` | `chartDurationStat` | No | Type duration Map |
| `tcsUploadTimeMsecs` | `integer` | Yes | TCS upload time |
| `exportDurationMsecs` | `integer` | Yes | export duration in milliseconds |
| `openAppDurationStat` | `durationStat` | No | Details about report processing |
| `renderedDurationStat` | `durationStat` | No | Details about report processing |
| `applyFilterDurationStat` | `durationStat` | No | Details about report processing |
| `compositionDurationMsecs` | `integer` | No | composition duration in milliseconds |
| `applyVariablesDurationStat` | `durationStat` | No | Details about report processing |

<details>
<summary>Properties of `level`</summary>

| Name | Type | Required | Description |
| --- | --- | --- | --- |
| `levelCount` | `integer` | No | Level count |
| `maxIteration` | `integer` | No | Max iterations |
| `totIteration` | `integer` | No | Total iterations |
| `maxNestedLevel` | `integer` | No | Max nested level |

</details>

<details>
<summary>Properties of `dataDurationStat`</summary>

| Name | Type | Required | Description |
| --- | --- | --- | --- |
| `failedCount` | `integer` | No | The number of failed exports |
| `sampleCount` | `integer` | No | Total sample count |
| `maxDurationMsecs` | `integer` | No | Max duration in milliseconds |
| `minDurationMsecs` | `integer` | No | Min duration in milliseconds |
| `totDurationMsecs` | `integer` | No | Total duration in milliseconds |

</details>

<details>
<summary>Properties of `queuingDelayStat`</summary>

| Name | Type | Required | Description |
| --- | --- | --- | --- |
| `failedCount` | `integer` | No | The number of failed exports |
| `sampleCount` | `integer` | No | Total sample count |
| `maxDurationMsecs` | `integer` | No | Max duration in milliseconds |
| `minDurationMsecs` | `integer` | No | Min duration in milliseconds |
| `totDurationMsecs` | `integer` | No | Total duration in milliseconds |

</details>

<details>
<summary>Properties of `openAppDurationStat`</summary>

| Name | Type | Required | Description |
| --- | --- | --- | --- |
| `failedCount` | `integer` | No | The number of failed exports |
| `sampleCount` | `integer` | No | Total sample count |
| `maxDurationMsecs` | `integer` | No | Max duration in milliseconds |
| `minDurationMsecs` | `integer` | No | Min duration in milliseconds |
| `totDurationMsecs` | `integer` | No | Total duration in milliseconds |

</details>

<details>
<summary>Properties of `renderedDurationStat`</summary>

| Name | Type | Required | Description |
| --- | --- | --- | --- |
| `failedCount` | `integer` | No | The number of failed exports |
| `sampleCount` | `integer` | No | Total sample count |
| `maxDurationMsecs` | `integer` | No | Max duration in milliseconds |
| `minDurationMsecs` | `integer` | No | Min duration in milliseconds |
| `totDurationMsecs` | `integer` | No | Total duration in milliseconds |

</details>

<details>
<summary>Properties of `applyFilterDurationStat`</summary>

| Name | Type | Required | Description |
| --- | --- | --- | --- |
| `failedCount` | `integer` | No | The number of failed exports |
| `sampleCount` | `integer` | No | Total sample count |
| `maxDurationMsecs` | `integer` | No | Max duration in milliseconds |
| `minDurationMsecs` | `integer` | No | Min duration in milliseconds |
| `totDurationMsecs` | `integer` | No | Total duration in milliseconds |

</details>

<details>
<summary>Properties of `applyVariablesDurationStat`</summary>

| Name | Type | Required | Description |
| --- | --- | --- | --- |
| `failedCount` | `integer` | No | The number of failed exports |
| `sampleCount` | `integer` | No | Total sample count |
| `maxDurationMsecs` | `integer` | No | Max duration in milliseconds |
| `minDurationMsecs` | `integer` | No | Min duration in milliseconds |
| `totDurationMsecs` | `integer` | No | Total duration in milliseconds |

</details>



### dataExport

Excel export info

**Type:** `object`

**Properties**

| Name | Type | Required | Description |
| --- | --- | --- | --- |
| `vizType` | `string` | No | visualization type |
| `cellCount` | `integer` | No | cell data count |
| `rowNumber` | `integer` | No | number of data rows |
| `columnNumber` | `integer` | No | number of data columns |



### dataPayload

The data payload for a report processing event.

**Type:** `object`

**Properties**

| Name | Type | Required | Description |
| --- | --- | --- | --- |
| `act` | `act` | No | The information from act header |
| `tags` | `tags[]` | No | Array of tags sent by requester client. |
| `issuer` | `string` | No | The issuer of the request from the jwt |
| `reports` | `reports` | Yes | The summary information on the triggered request |
| `subject` | `string` | No | The subject of the request from the jwt |
| `subtype` | `string` | No | The subtype of the request from the jwt |
| `traceId` | `string` | Yes | telemetry trace ID |
| `version` | `string` | Yes | Version of the EventType, it uses semantic versioning. |
| `clientId` | `string` | No | The unique ID identifying the client |
| `reportId` | `string` | Yes | The unique ID identifying the report |
| `requestId` | `string` | Yes | The unique ID identifying the request |
| `consumption` | `consumption` | Yes | Details about report processing |
| `originalURL` | `string` | No | The Original URL of the caller. |
| `globalResult` | `string` | Yes | All reports succeeded is "success", all reports failed is "failed", else is "partial". Allowed values: success \| partial \| failed. |
| `browserLikeOrigin` | `boolean` | Yes | The flag indicating the request is likely coming from a client. |

<details>
<summary>Properties of `act`</summary>

| Name | Type | Required | Description |
| --- | --- | --- | --- |
| `issuer` | `string` | No | the acting issuer of the request |
| `subject` | `string` | No | the acting subject of the request |
| `subtype` | `string` | No | the acting subtype of the request |

</details>

<details>
<summary>Properties of `reports`</summary>

| Name | Type | Required | Description |
| --- | --- | --- | --- |
| `meta` | `metaReport` | No | Report meta info |
| `results` | `results[]` | Yes | Array of results that occurred during report generation. |
| `loadType` | `string` | Yes | The load type assigned to the request for pool assignment |
| `templates` | `templates` | Yes | The templating parameter, it can be a single template or a composition of templates |
| `templateType` | `string` | Yes | 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 |

<details>
<summary>Properties of `meta`</summary>

| Name | Type | Required | Description |
| --- | --- | --- | --- |
| `outputTtlSecs` | `integer` | No | Seconds to live of the final result artifacts |
| `exportDeadlineSecs` | `integer` | No | The maximum interval in seconds, starting from the time the API request is received, within which a report must be produced |

</details>

<details>
<summary>Properties of `results`</summary>

| Name | Type | Required | Description |
| --- | --- | --- | --- |
| `errors` | `errors[]` | No | Array of errors that occurred during report generation. |
| `format` | `string` | No | The output format |
| `success` | `boolean` | Yes | The flag indicating a successful report generation [true, false] |
| `outputId` | `string` | Yes | The outputId [Chart_image, Chart_pdf, chart_excel, Sheet_pdf, Multisheet_PDF]. |
| `sizeBytes` | `integer` | No | output size in bytes |
| `timeMsecs` | `integer` | Yes | The time elapsed in milliseconds |
| `dataExport` | `dataExport` | No | Excel export info |
| `serverError` | `boolean` | Yes | The flag indicating if there is a server/backend error |

<details>
<summary>Properties of `errors`</summary>

_Properties truncated due to depth limit._

</details>

<details>
<summary>Properties of `dataExport`</summary>

_Properties truncated due to depth limit._

</details>

</details>

<details>
<summary>Properties of `templates`</summary>

| Name | Type | Required | Description |
| --- | --- | --- | --- |
| `template` | `template` | No | The object with information for templateType |
| `compositionTemplates` | `compositionTemplates[]` | No | Array of templates defining a composition |

<details>
<summary>Properties of `template`</summary>

_Properties truncated due to depth limit._

</details>

<details>
<summary>Properties of `compositionTemplates`</summary>

_Properties truncated due to depth limit._

</details>

</details>

</details>

<details>
<summary>Properties of `consumption`</summary>

| Name | Type | Required | Description |
| --- | --- | --- | --- |
| `level` | `levelStat` | No | Level stats |
| `endTime` | `string` | Yes | timestamp of when the response is ready. Metadata: format = "date-time". |
| `cellCount` | `integer` | No | cell count |
| `startTime` | `string` | Yes | timestamp of when the request arrives. Metadata: format = "date-time". |
| `objectCount` | `integer` | Yes | exported object count |
| `maxCellCount` | `integer` | No | cell count of biggest data export |
| `minCellCount` | `integer` | No | cell count of the smallest data export |
| `variableCount` | `integer` | No | Variable count |
| `taskRetryCount` | `integer` | No | Task retry count |
| `senseSheetCount` | `integer` | Yes | Number of sheets in the request |
| `dataDurationStat` | `durationStat` | No | Details about report processing |
| `queuingDelayStat` | `durationStat` | No | Details about report processing |
| `taskDurationStat` | `taskDurationStat` | No | Type duration Map |
| `chartDurationStat` | `chartDurationStat` | No | Type duration Map |
| `tcsUploadTimeMsecs` | `integer` | Yes | TCS upload time |
| `exportDurationMsecs` | `integer` | Yes | export duration in milliseconds |
| `openAppDurationStat` | `durationStat` | No | Details about report processing |
| `renderedDurationStat` | `durationStat` | No | Details about report processing |
| `applyFilterDurationStat` | `durationStat` | No | Details about report processing |
| `compositionDurationMsecs` | `integer` | No | composition duration in milliseconds |
| `applyVariablesDurationStat` | `durationStat` | No | Details about report processing |

<details>
<summary>Properties of `level`</summary>

| Name | Type | Required | Description |
| --- | --- | --- | --- |
| `levelCount` | `integer` | No | Level count |
| `maxIteration` | `integer` | No | Max iterations |
| `totIteration` | `integer` | No | Total iterations |
| `maxNestedLevel` | `integer` | No | Max nested level |

</details>

<details>
<summary>Properties of `dataDurationStat`</summary>

| Name | Type | Required | Description |
| --- | --- | --- | --- |
| `failedCount` | `integer` | No | The number of failed exports |
| `sampleCount` | `integer` | No | Total sample count |
| `maxDurationMsecs` | `integer` | No | Max duration in milliseconds |
| `minDurationMsecs` | `integer` | No | Min duration in milliseconds |
| `totDurationMsecs` | `integer` | No | Total duration in milliseconds |

</details>

<details>
<summary>Properties of `queuingDelayStat`</summary>

| Name | Type | Required | Description |
| --- | --- | --- | --- |
| `failedCount` | `integer` | No | The number of failed exports |
| `sampleCount` | `integer` | No | Total sample count |
| `maxDurationMsecs` | `integer` | No | Max duration in milliseconds |
| `minDurationMsecs` | `integer` | No | Min duration in milliseconds |
| `totDurationMsecs` | `integer` | No | Total duration in milliseconds |

</details>

<details>
<summary>Properties of `openAppDurationStat`</summary>

| Name | Type | Required | Description |
| --- | --- | --- | --- |
| `failedCount` | `integer` | No | The number of failed exports |
| `sampleCount` | `integer` | No | Total sample count |
| `maxDurationMsecs` | `integer` | No | Max duration in milliseconds |
| `minDurationMsecs` | `integer` | No | Min duration in milliseconds |
| `totDurationMsecs` | `integer` | No | Total duration in milliseconds |

</details>

<details>
<summary>Properties of `renderedDurationStat`</summary>

| Name | Type | Required | Description |
| --- | --- | --- | --- |
| `failedCount` | `integer` | No | The number of failed exports |
| `sampleCount` | `integer` | No | Total sample count |
| `maxDurationMsecs` | `integer` | No | Max duration in milliseconds |
| `minDurationMsecs` | `integer` | No | Min duration in milliseconds |
| `totDurationMsecs` | `integer` | No | Total duration in milliseconds |

</details>

<details>
<summary>Properties of `applyFilterDurationStat`</summary>

| Name | Type | Required | Description |
| --- | --- | --- | --- |
| `failedCount` | `integer` | No | The number of failed exports |
| `sampleCount` | `integer` | No | Total sample count |
| `maxDurationMsecs` | `integer` | No | Max duration in milliseconds |
| `minDurationMsecs` | `integer` | No | Min duration in milliseconds |
| `totDurationMsecs` | `integer` | No | Total duration in milliseconds |

</details>

<details>
<summary>Properties of `applyVariablesDurationStat`</summary>

| Name | Type | Required | Description |
| --- | --- | --- | --- |
| `failedCount` | `integer` | No | The number of failed exports |
| `sampleCount` | `integer` | No | Total sample count |
| `maxDurationMsecs` | `integer` | No | Max duration in milliseconds |
| `minDurationMsecs` | `integer` | No | Min duration in milliseconds |
| `totDurationMsecs` | `integer` | No | Total duration in milliseconds |

</details>

</details>



### durationStat

Details about report processing

**Type:** `object`

**Properties**

| Name | Type | Required | Description |
| --- | --- | --- | --- |
| `failedCount` | `integer` | No | The number of failed exports |
| `sampleCount` | `integer` | No | Total sample count |
| `maxDurationMsecs` | `integer` | No | Max duration in milliseconds |
| `minDurationMsecs` | `integer` | No | Min duration in milliseconds |
| `totDurationMsecs` | `integer` | No | Total duration in milliseconds |



### error

Error occurred during report generation.

**Type:** `object`

**Properties**

| Name | Type | Required | Description |
| --- | --- | --- | --- |
| `code` | `string` | Yes | The unique code for the error. |
| `chartId` | `string` | No | Chart id. |
| `chartType` | `string` | No | Chart type. |



### errors

Array of errors that occurred during report generation.

**Type:** `object[]`

**Properties**

| Name | Type | Required | Description |
| --- | --- | --- | --- |
| `code` | `string` | Yes | The unique code for the error. |
| `chartId` | `string` | No | Chart id. |
| `chartType` | `string` | No | Chart type. |



### levelStat

Level stats

**Type:** `object`

**Properties**

| Name | Type | Required | Description |
| --- | --- | --- | --- |
| `levelCount` | `integer` | No | Level count |
| `maxIteration` | `integer` | No | Max iterations |
| `totIteration` | `integer` | No | Total iterations |
| `maxNestedLevel` | `integer` | No | Max nested level |



### metaReport

Report meta info

**Type:** `object`

**Properties**

| Name | Type | Required | Description |
| --- | --- | --- | --- |
| `outputTtlSecs` | `integer` | No | Seconds to live of the final result artifacts |
| `exportDeadlineSecs` | `integer` | No | The maximum interval in seconds, starting from the time the API request is received, within which a report must be produced |



### reports

The summary information on the triggered request

**Type:** `object`

**Properties**

| Name | Type | Required | Description |
| --- | --- | --- | --- |
| `meta` | `metaReport` | No | Report meta info |
| `results` | `results[]` | Yes | Array of results that occurred during report generation. |
| `loadType` | `string` | Yes | The load type assigned to the request for pool assignment |
| `templates` | `templates` | Yes | The templating parameter, it can be a single template or a composition of templates |
| `templateType` | `string` | Yes | 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 |

<details>
<summary>Properties of `meta`</summary>

| Name | Type | Required | Description |
| --- | --- | --- | --- |
| `outputTtlSecs` | `integer` | No | Seconds to live of the final result artifacts |
| `exportDeadlineSecs` | `integer` | No | The maximum interval in seconds, starting from the time the API request is received, within which a report must be produced |

</details>

<details>
<summary>Properties of `results`</summary>

| Name | Type | Required | Description |
| --- | --- | --- | --- |
| `errors` | `errors[]` | No | Array of errors that occurred during report generation. |
| `format` | `string` | No | The output format |
| `success` | `boolean` | Yes | The flag indicating a successful report generation [true, false] |
| `outputId` | `string` | Yes | The outputId [Chart_image, Chart_pdf, chart_excel, Sheet_pdf, Multisheet_PDF]. |
| `sizeBytes` | `integer` | No | output size in bytes |
| `timeMsecs` | `integer` | Yes | The time elapsed in milliseconds |
| `dataExport` | `dataExport` | No | Excel export info |
| `serverError` | `boolean` | Yes | The flag indicating if there is a server/backend error |

<details>
<summary>Properties of `errors`</summary>

| Name | Type | Required | Description |
| --- | --- | --- | --- |
| `code` | `string` | Yes | The unique code for the error. |
| `chartId` | `string` | No | Chart id. |
| `chartType` | `string` | No | Chart type. |

</details>

<details>
<summary>Properties of `dataExport`</summary>

| Name | Type | Required | Description |
| --- | --- | --- | --- |
| `vizType` | `string` | No | visualization type |
| `cellCount` | `integer` | No | cell data count |
| `rowNumber` | `integer` | No | number of data rows |
| `columnNumber` | `integer` | No | number of data columns |

</details>

</details>

<details>
<summary>Properties of `templates`</summary>

| Name | Type | Required | Description |
| --- | --- | --- | --- |
| `template` | `template` | No | The object with information for templateType |
| `compositionTemplates` | `compositionTemplates[]` | No | Array of templates defining a composition |

<details>
<summary>Properties of `template`</summary>

| Name | Type | Required | Description |
| --- | --- | --- | --- |
| `appId` | `string` | Yes | The unique identifier of the app the request is related to. |
| `objectId` | `string` | Yes | The unique identifier of the app's object the report is related to. |
| `templateType` | `string` | Yes | 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 |

</details>

<details>
<summary>Properties of `compositionTemplates`</summary>

| Name | Type | Required | Description |
| --- | --- | --- | --- |
| `appId` | `string` | Yes | The unique identifier of the app the request is related to. |
| `objectId` | `string` | Yes | The unique identifier of the app's object the report is related to. |
| `templateType` | `string` | Yes | 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 |

</details>

</details>



### result

The object with information on report generation result.

**Type:** `object`

**Properties**

| Name | Type | Required | Description |
| --- | --- | --- | --- |
| `errors` | `errors[]` | No | Array of errors that occurred during report generation. |
| `format` | `string` | No | The output format |
| `success` | `boolean` | Yes | The flag indicating a successful report generation [true, false] |
| `outputId` | `string` | Yes | The outputId [Chart_image, Chart_pdf, chart_excel, Sheet_pdf, Multisheet_PDF]. |
| `sizeBytes` | `integer` | No | output size in bytes |
| `timeMsecs` | `integer` | Yes | The time elapsed in milliseconds |
| `dataExport` | `dataExport` | No | Excel export info |
| `serverError` | `boolean` | Yes | The flag indicating if there is a server/backend error |

<details>
<summary>Properties of `errors`</summary>

| Name | Type | Required | Description |
| --- | --- | --- | --- |
| `code` | `string` | Yes | The unique code for the error. |
| `chartId` | `string` | No | Chart id. |
| `chartType` | `string` | No | Chart type. |

</details>

<details>
<summary>Properties of `dataExport`</summary>

| Name | Type | Required | Description |
| --- | --- | --- | --- |
| `vizType` | `string` | No | visualization type |
| `cellCount` | `integer` | No | cell data count |
| `rowNumber` | `integer` | No | number of data rows |
| `columnNumber` | `integer` | No | number of data columns |

</details>



### results

Array of results that occurred during report generation.

**Type:** `object[]`

**Properties**

| Name | Type | Required | Description |
| --- | --- | --- | --- |
| `errors` | `errors[]` | No | Array of errors that occurred during report generation. |
| `format` | `string` | No | The output format |
| `success` | `boolean` | Yes | The flag indicating a successful report generation [true, false] |
| `outputId` | `string` | Yes | The outputId [Chart_image, Chart_pdf, chart_excel, Sheet_pdf, Multisheet_PDF]. |
| `sizeBytes` | `integer` | No | output size in bytes |
| `timeMsecs` | `integer` | Yes | The time elapsed in milliseconds |
| `dataExport` | `dataExport` | No | Excel export info |
| `serverError` | `boolean` | Yes | The flag indicating if there is a server/backend error |

<details>
<summary>Properties of `errors`</summary>

| Name | Type | Required | Description |
| --- | --- | --- | --- |
| `code` | `string` | Yes | The unique code for the error. |
| `chartId` | `string` | No | Chart id. |
| `chartType` | `string` | No | Chart type. |

</details>

<details>
<summary>Properties of `dataExport`</summary>

| Name | Type | Required | Description |
| --- | --- | --- | --- |
| `vizType` | `string` | No | visualization type |
| `cellCount` | `integer` | No | cell data count |
| `rowNumber` | `integer` | No | number of data rows |
| `columnNumber` | `integer` | No | number of data columns |

</details>



### tag

A tag sent by a client. It is a string with the format "feature.subfeature". For more information please look at the document docs/meta-tags.md in the reporting-service repository.

**Type:** `string`

**Properties**

| Name | Type | Required | Description |
| --- | --- | --- | --- |
| `tag` | `string` | No | A tag sent by a client. It is a string with the format "feature.subfeature". For more information please look at the document docs/meta-tags.md in the reporting-service repository. |



### tags

Array of tags sent by requester client.

**Type:** `string[]`

**Properties**

| Name | Type | Required | Description |
| --- | --- | --- | --- |
| `tags` | `string[]` | No | Array of tags sent by requester client. |



### taskDurationStat

Type duration Map

**Type:** `object`

**Properties**

| Name | Type | Required | Description |
| --- | --- | --- | --- |
| `taskDurationStat` | `object` | No | Type duration Map |



### template

The object with information for templateType

**Type:** `object`

**Properties**

| Name | Type | Required | Description |
| --- | --- | --- | --- |
| `appId` | `string` | Yes | The unique identifier of the app the request is related to. |
| `objectId` | `string` | Yes | The unique identifier of the app's object the report is related to. |
| `templateType` | `string` | Yes | 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 |



### templates

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

**Type:** `object`

**Properties**

| Name | Type | Required | Description |
| --- | --- | --- | --- |
| `template` | `template` | No | The object with information for templateType |
| `compositionTemplates` | `compositionTemplates[]` | No | Array of templates defining a composition |

<details>
<summary>Properties of `template`</summary>

| Name | Type | Required | Description |
| --- | --- | --- | --- |
| `appId` | `string` | Yes | The unique identifier of the app the request is related to. |
| `objectId` | `string` | Yes | The unique identifier of the app's object the report is related to. |
| `templateType` | `string` | Yes | 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 |

</details>

<details>
<summary>Properties of `compositionTemplates`</summary>

| Name | Type | Required | Description |
| --- | --- | --- | --- |
| `appId` | `string` | Yes | The unique identifier of the app the request is related to. |
| `objectId` | `string` | Yes | The unique identifier of the app's object the report is related to. |
| `templateType` | `string` | Yes | 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 |

</details>