{
  "asyncapi": "3.0.0",
  "info": {
    "title": "analytics",
    "version": ""
  },
  "channels": {
    "uiEvents": {
      "address": "ui-events",
      "messages": {
        "analyticsAnalyticsAppClientDeprecatedChartsOpened": {
          "$ref": "#/components/messages/ui-events.analyticsAnalyticsAppClientDeprecatedChartsOpened"
        },
        "analyticsAnalyticsAppClientSheetViewOpened": {
          "$ref": "#/components/messages/ui-events.analyticsAnalyticsAppClientSheetViewOpened"
        }
      }
    }
  },
  "operations": {
    "analyticsAnalyticsAppClientDeprecatedChartsOpened.publish": {
      "action": "send",
      "channel": {
        "$ref": "#/channels/uiEvents"
      },
      "messages": [
        {
          "$ref": "#/channels/uiEvents/messages/analyticsAnalyticsAppClientDeprecatedChartsOpened"
        }
      ]
    },
    "analyticsAnalyticsAppClientSheetViewOpened.publish": {
      "action": "send",
      "channel": {
        "$ref": "#/channels/uiEvents"
      },
      "messages": [
        {
          "$ref": "#/channels/uiEvents/messages/analyticsAnalyticsAppClientSheetViewOpened"
        }
      ]
    }
  },
  "components": {
    "messages": {
      "ui-events.analyticsAnalyticsAppClientDeprecatedChartsOpened": {
        "name": "com.qlik.v1.analytics.analytics-app-client.deprecated-charts.opened",
        "tags": [
          {
            "name": "analytics-app-client"
          }
        ],
        "title": "Deprecated charts opened in sheet",
        "payload": {
          "type": "object",
          "allOf": [
            {
              "$ref": "#/components/schemas/eventBase"
            },
            {
              "type": "object",
              "properties": {
                "data": {
                  "type": "object",
                  "properties": {
                    "appId": {
                      "type": "string",
                      "format": "uuid",
                      "description": "Identifier of the app related to this event."
                    },
                    "charts": {
                      "type": "array",
                      "items": {
                        "type": "object",
                        "properties": {
                          "chartId": {
                            "type": "string",
                            "format": "uuid",
                            "description": "Identifier of the chart."
                          },
                          "chartType": {
                            "type": "string",
                            "example": "bar",
                            "description": "Type of the chart."
                          },
                          "chartTitle": {
                            "type": "string",
                            "description": "Title of the chart."
                          },
                          "inContainer": {
                            "type": "boolean",
                            "description": "Indicates whether the chart is inside a container or not."
                          }
                        }
                      },
                      "description": "List of charts"
                    },
                    "ownerId": {
                      "type": "string",
                      "format": "uuid",
                      "description": "ID of the user currently owning the related resource."
                    },
                    "sheetId": {
                      "type": "string",
                      "format": "uuid",
                      "description": "Identifier of the sheet related to this event."
                    },
                    "sheetTitle": {
                      "type": "string",
                      "example": "My Sheet",
                      "description": "If set, the evaluated sheet title expression, else the sheet title."
                    },
                    "sheetApproved": {
                      "type": "boolean",
                      "description": "Indicates whether the sheet has been approved or not."
                    },
                    "sheetPublished": {
                      "type": "boolean",
                      "description": "Indicates whether the sheet has been published or not."
                    }
                  }
                }
              }
            }
          ]
        },
        "description": "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.",
        "x-qlik-deprecated": false,
        "x-qlik-stability": "stable",
        "x-qlik-visibility": "public"
      },
      "ui-events.analyticsAnalyticsAppClientSheetViewOpened": {
        "name": "com.qlik.v1.analytics.analytics-app-client.sheet-view.opened",
        "tags": [
          {
            "name": "analytics-app-client"
          }
        ],
        "title": "Sense Sheet View Opened",
        "payload": {
          "type": "object",
          "allOf": [
            {
              "$ref": "#/components/schemas/eventBase"
            },
            {
              "type": "object",
              "properties": {
                "data": {
                  "type": "object",
                  "properties": {
                    "appId": {
                      "type": "string",
                      "format": "uuid",
                      "description": "Identifier of the app related to this event."
                    },
                    "sheetId": {
                      "type": "string",
                      "format": "uuid",
                      "description": "Identifier of the sheet related to this event."
                    },
                    "sheetState": {
                      "enum": [
                        "analysis",
                        "edit",
                        "simpleEdit"
                      ],
                      "type": "string",
                      "description": "The mode in which the sheet was opened, either `analysis` (view mode), `edit` (advanced edit mode), or `simpleEdit` (simplified edit mode)."
                    },
                    "sheetTitle": {
                      "type": "string",
                      "example": "My Sheet",
                      "description": "If set, the evaluated sheet title expression, else the sheet title."
                    }
                  }
                }
              }
            }
          ]
        },
        "description": "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).",
        "x-qlik-deprecated": false,
        "x-qlik-stability": "stable",
        "x-qlik-visibility": "public"
      }
    },
    "schemas": {
      "eventBase": {
        "type": "object",
        "required": [
          "id",
          "source",
          "specversion",
          "type",
          "time",
          "tenantid",
          "userid"
        ],
        "properties": {
          "id": {
            "type": "string",
            "format": "uuid",
            "example": "60143626-36a8-4661-9afe-8080a01d89e7",
            "description": "Unique identifier for the event."
          },
          "time": {
            "type": "string",
            "format": "date-time",
            "example": "2018-10-30T07:06:22Z",
            "description": "Timestamp of when the event happened."
          },
          "type": {
            "type": "string",
            "description": "The type of the event."
          },
          "source": {
            "type": "string",
            "description": "The source of the event."
          },
          "specversion": {
            "enum": [
              "1.0"
            ],
            "type": "string",
            "description": "The event is compatible with the CloudEvents specification v1.0.2."
          }
        }
      }
    }
  }
}