Analytics

Qlik Sense events

Emitted when a client (browser) detects one or more deprecated chart types as a user opens or navigates to a sheet in the native experience or via qlik-embed with the classic/app UI. It is not emitted when switching sheet modes (for example, View to Edit) or from non-sheet UIs such as Stories or Reporting.

Payload

object

id string

Required

Unique identifier for the event.

format = "uuid"
time string

Required

Timestamp of when the event happened.

format = "date-time"
type string

Required

The type of the event.
source string

Required

default = "com.qlik/analytics"
specversion string

Required

The event is compatible with the CloudEvents specification v1.0.2.

Can be one of: "1.0"
data object
Show data properties
- appId string
  
  Identifier of the app related to this event.
  
  format = "uuid"
- charts array of objects
  
  List of charts
  
  Show charts properties
  
  chartId string
  
  Identifier of the chart.
  
  format = "uuid"
  
  chartType string
  
  Type of the chart.
  
  chartTitle string
  
  Title of the chart.
  
  inContainer boolean
  
  Indicates whether the chart is inside a container or not.
- ownerId string
  
  ID of the user currently owning the related resource.
  
  format = "uuid"
- sheetId string
  
  Identifier of the sheet related to this event.
  
  format = "uuid"
- sheetTitle string
  
  If set, the evaluated sheet title expression, else the sheet title.
- sheetApproved boolean
  
  Indicates whether the sheet has been approved or not.
- sheetPublished boolean
  
  Indicates whether the sheet has been published or not.

com.qlik.v1.analytics.analytics-app-client.deprecated-charts.opened

Example payload of the "Deprecated charts opened in sheet" event

{
  "id": "60143626-36a8-4661-9afe-8080a01d89e7",
  "time": "2018-10-30T07:06:22Z",
  "type": "string",
  "source": "com.qlik/analytics",
  "specversion": "1.0",
  "data": {
    "appId": "c35f4b70-3ce4-4a30-b62b-2aef16943bc4",
    "charts": [
      {
        "chartId": "c35f4b70-3ce4-4a30-b62b-2aef16943bc4",
        "chartType": "bar",
        "chartTitle": "string",
        "inContainer": true
      }
    ],
    "ownerId": "c35f4b70-3ce4-4a30-b62b-2aef16943bc4",
    "sheetId": "c35f4b70-3ce4-4a30-b62b-2aef16943bc4",
    "sheetTitle": "My Sheet",
    "sheetApproved": true,
    "sheetPublished": true
  }
}

Triggered by a client (browser) each time a sheet change event is recorded, when in the native experience or when using qlik-embed with the classic/app UI. Will not be emitted when changing between sheet modes (for example, going from View to Edit), or in non-sheet UIs (such as Stories, Reporting, etc).

Payload

object

id string

Required

Unique identifier for the event.

format = "uuid"
time string

Required

Timestamp of when the event happened.

format = "date-time"
type string

Required

The type of the event.
source string

Required

default = "com.qlik/analytics"
specversion string

Required

The event is compatible with the CloudEvents specification v1.0.2.

Can be one of: "1.0"
data object
Show data properties
- appId string
  
  Identifier of the app related to this event.
  
  format = "uuid"
- sheetId string
  
  Identifier of the sheet related to this event.
  
  format = "uuid"
- sheetState string
  
  The mode in which the sheet was opened, either analysis (view mode), edit (advanced edit mode), or simpleEdit (simplified edit mode).
  
  Can be one of: "analysis""edit""simpleEdit"
- sheetTitle string
  
  If set, the evaluated sheet title expression, else the sheet title.

com.qlik.v1.analytics.analytics-app-client.sheet-view.opened

Example payload of the "Sense Sheet View Opened" event

{
  "id": "60143626-36a8-4661-9afe-8080a01d89e7",
  "time": "2018-10-30T07:06:22Z",
  "type": "string",
  "source": "com.qlik/analytics",
  "specversion": "1.0",
  "data": {
    "appId": "c35f4b70-3ce4-4a30-b62b-2aef16943bc4",
    "sheetId": "c35f4b70-3ce4-4a30-b62b-2aef16943bc4",
    "sheetState": "analysis",
    "sheetTitle": "My Sheet"
  }
}