---
id: analytics-platform.ChartCreated
name: ChartCreated
version: 1.0.0
summary: "Indicates that a user has created a chart in Superset"
producers:
- analytics-platform
consumers: []
schemaPath: 'schema.json'
---
# ChartCreated
Indicates that a user has created a chart in Superset
## Base Schema
All analytics events are based on the **TrackEvent** schema which provides common properties like `messageId`, `userId`, `context`, timestamps, and more.
**Base Schema Reference**: [analytics-track.yaml](https://event-catalog.prod.otc.fts.d-3.de/schemas/analytics-track.yaml)
## Event-Specific Properties
This schema shows only the event-specific properties that extend the base TrackEvent schema:
## Raw Schema:schema.json
{
"title": "Event-Specific Properties",
"type": "object",
"description": "Properties specific to this event type (extends BaseEvent)",
"extends": "https://eventcatalog.event-catalog.int.otc.fts.d-3.de/schemas/analytics-track.yaml#/TrackEvent",
"eventType": "ChartCreated",
"properties": {},
"note": "This event uses only BaseEvent properties with no additional event-specific properties",
"components": {
"schemas": {
"ChartCreatedPayload": {
"allOf": [
{
"$ref": "https://eventcatalog.event-catalog.int.otc.fts.d-3.de/schemas/analytics-track.yaml#/TrackEvent"
},
{
"properties": {
"event": {
"const": "ChartCreated"
}
},
"title": "Specific event properties",
"type": "object"
}
]
},
"ChartDataLoadedPayload": {
"allOf": [
{
"$ref": "https://eventcatalog.event-catalog.int.otc.fts.d-3.de/schemas/analytics-track.yaml#/TrackEvent"
},
{
"properties": {
"event": {
"const": "ChartDataLoaded"
},
"properties": {
"properties": {
"chartId": {
"description": "Unique identifier of the chart in Superset.",
"example": 42,
"format": "int64",
"type": "integer"
},
"dashboardId": {
"description": "Unique identifier of the dashboard in Superset.",
"example": 7,
"format": "int64",
"type": "integer"
},
"vizType": {
"description": "Type of visualization (e.g., bar, line, pie) used in the chart.",
"example": "table",
"type": "string"
}
},
"type": "object"
}
},
"title": "Specific event properties",
"type": "object"
}
]
},
"ChartDeletedPayload": {
"allOf": [
{
"$ref": "https://eventcatalog.event-catalog.int.otc.fts.d-3.de/schemas/analytics-track.yaml#/TrackEvent"
},
{
"properties": {
"event": {
"const": "ChartDeleted"
},
"properties": {
"properties": {
"chartId": {
"description": "Unique identifier of the chart in Superset.",
"example": 42,
"format": "int64",
"type": "integer"
}
},
"type": "object"
}
},
"title": "Specific event properties",
"type": "object"
}
]
},
"ChartFavoritedPayload": {
"allOf": [
{
"$ref": "https://eventcatalog.event-catalog.int.otc.fts.d-3.de/schemas/analytics-track.yaml#/TrackEvent"
},
{
"properties": {
"event": {
"const": "ChartFavorited"
},
"properties": {
"properties": {
"chartId": {
"description": "Unique identifier of the chart in Superset.",
"example": 333,
"format": "int64",
"type": "integer"
}
},
"type": "object"
}
},
"title": "Specific event properties",
"type": "object"
}
]
},
"ChartUnfavoritedPayload": {
"allOf": [
{
"$ref": "https://eventcatalog.event-catalog.int.otc.fts.d-3.de/schemas/analytics-track.yaml#/TrackEvent"
},
{
"properties": {
"event": {
"const": "ChartUnfavorited"
},
"properties": {
"properties": {
"chartId": {
"description": "Unique identifier of the chart in Superset.",
"example": 42,
"format": "int64",
"type": "integer"
}
},
"type": "object"
}
},
"title": "Specific event properties",
"type": "object"
}
]
},
"ChartUpdatedPayload": {
"allOf": [
{
"$ref": "https://eventcatalog.event-catalog.int.otc.fts.d-3.de/schemas/analytics-track.yaml#/TrackEvent"
},
{
"properties": {
"event": {
"const": "ChartUpdated"
},
"properties": {
"properties": {
"chartId": {
"description": "Unique identifier of the chart in Superset.",
"example": 42,
"format": "int64",
"type": "integer"
}
},
"type": "object"
}
},
"title": "Specific event properties",
"type": "object"
}
]
},
"DashboardCreatedPayload": {
"allOf": [
{
"$ref": "https://eventcatalog.event-catalog.int.otc.fts.d-3.de/schemas/analytics-track.yaml#/TrackEvent"
},
{
"properties": {
"event": {
"const": "DashboardCreated"
},
"properties": {
"properties": {
"dashboardId": {
"description": "Unique identifier of the dashboard in Superset.",
"example": 7,
"format": "int64",
"type": "integer"
}
},
"type": "object"
}
},
"title": "Specific event properties",
"type": "object"
}
]
},
"DashboardDeletedPayload": {
"allOf": [
{
"$ref": "https://eventcatalog.event-catalog.int.otc.fts.d-3.de/schemas/analytics-track.yaml#/TrackEvent"
},
{
"properties": {
"event": {
"const": "DashboardDeleted"
},
"properties": {
"properties": {
"dashboardId": {
"description": "Unique identifier of the dashboard in Superset.",
"example": 7,
"format": "int64",
"type": "integer"
}
},
"type": "object"
}
},
"title": "Specific event properties",
"type": "object"
}
]
},
"DashboardFavoritedPayload": {
"allOf": [
{
"$ref": "https://eventcatalog.event-catalog.int.otc.fts.d-3.de/schemas/analytics-track.yaml#/TrackEvent"
},
{
"properties": {
"event": {
"const": "DashboardFavorited"
},
"properties": {
"properties": {
"dashboardId": {
"description": "Unique identifier of the dashboard in Superset.",
"example": 7,
"format": "int64",
"type": "integer"
}
},
"type": "object"
}
},
"title": "Specific event properties",
"type": "object"
}
]
},
"DashboardUnfavoritedPayload": {
"allOf": [
{
"$ref": "https://eventcatalog.event-catalog.int.otc.fts.d-3.de/schemas/analytics-track.yaml#/TrackEvent"
},
{
"properties": {
"event": {
"const": "DashboardUnfavorited"
},
"properties": {
"properties": {
"dashboardId": {
"description": "Unique identifier of the dashboard in Superset.",
"example": 7,
"format": "int64",
"type": "integer"
}
},
"type": "object"
}
},
"title": "Specific event properties",
"type": "object"
}
]
},
"DashboardUpdatedPayload": {
"allOf": [
{
"$ref": "https://eventcatalog.event-catalog.int.otc.fts.d-3.de/schemas/analytics-track.yaml#/TrackEvent"
},
{
"properties": {
"event": {
"const": "DashboardUpdated"
},
"properties": {
"properties": {
"dashboardId": {
"description": "Unique identifier of the dashboard in Superset.",
"example": 7,
"format": "int64",
"type": "integer"
}
},
"type": "object"
}
},
"title": "Specific event properties",
"type": "object"
}
]
},
"DashboardViewedPayload": {
"allOf": [
{
"$ref": "https://eventcatalog.event-catalog.int.otc.fts.d-3.de/schemas/analytics-track.yaml#/TrackEvent"
},
{
"properties": {
"event": {
"const": "DashboardViewed"
},
"properties": {
"properties": {
"dashboardId": {
"description": "Unique identifier of the dashboard in Superset.",
"example": 7,
"format": "int64",
"type": "integer"
}
},
"type": "object"
}
},
"title": "Specific event properties",
"type": "object"
}
]
},
"DatasetCreatedPayload": {
"allOf": [
{
"$ref": "https://eventcatalog.event-catalog.int.otc.fts.d-3.de/schemas/analytics-track.yaml#/TrackEvent"
},
{
"properties": {
"event": {
"const": "DatasetCreated"
}
},
"title": "Specific event properties",
"type": "object"
}
]
},
"DatasetDeletedPayload": {
"allOf": [
{
"$ref": "https://eventcatalog.event-catalog.int.otc.fts.d-3.de/schemas/analytics-track.yaml#/TrackEvent"
},
{
"properties": {
"event": {
"const": "DatasetDeleted"
}
},
"title": "Specific event properties",
"type": "object"
}
]
},
"SavedQueryCreatedPayload": {
"allOf": [
{
"$ref": "https://eventcatalog.event-catalog.int.otc.fts.d-3.de/schemas/analytics-track.yaml#/TrackEvent"
},
{
"properties": {
"event": {
"const": "SavedQueryCreated"
}
},
"title": "Specific event properties",
"type": "object"
}
]
},
"SqlLabQueryExecutionFailedPayload": {
"allOf": [
{
"$ref": "https://eventcatalog.event-catalog.int.otc.fts.d-3.de/schemas/analytics-track.yaml#/TrackEvent"
},
{
"properties": {
"event": {
"const": "SqlLabQueryExecutionFailed"
}
},
"title": "Specific event properties",
"type": "object"
}
]
},
"SqlLabQueryExecutionSucceededPayload": {
"allOf": [
{
"$ref": "https://eventcatalog.event-catalog.int.otc.fts.d-3.de/schemas/analytics-track.yaml#/TrackEvent"
},
{
"properties": {
"event": {
"const": "SqlLabQueryExecutionSucceeded"
},
"properties": {
"properties": {
"dashboardId": {
"description": "Unique identifier of the dashboard in Superset.",
"example": 12,
"format": "int64",
"type": "integer"
}
},
"type": "object"
}
},
"title": "Specific event properties",
"type": "object"
}
]
}
}
}
}
---
id: analytics-platform.ChartDataLoaded
name: ChartDataLoaded
version: 1.0.0
summary: "Indicates that the data for a chart has been loaded"
producers:
- analytics-platform
consumers: []
schemaPath: 'schema.json'
---
# ChartDataLoaded
Indicates that the data for a chart has been loaded
## Base Schema
All analytics events are based on the **TrackEvent** schema which provides common properties like `messageId`, `userId`, `context`, timestamps, and more.
**Base Schema Reference**: [analytics-track.yaml](https://event-catalog.prod.otc.fts.d-3.de/schemas/analytics-track.yaml)
## Event-Specific Properties
This schema shows only the event-specific properties that extend the base TrackEvent schema:
## Raw Schema:schema.json
{
"title": "Event-Specific Properties",
"type": "object",
"description": "Properties specific to this event type (extends BaseEvent)",
"extends": "https://eventcatalog.event-catalog.int.otc.fts.d-3.de/schemas/analytics-track.yaml#/TrackEvent",
"eventType": "ChartDataLoaded",
"properties": {
"chartId": {
"description": "Unique identifier of the chart in Superset.",
"example": 42,
"format": "int64",
"type": "integer"
},
"vizType": {
"description": "Type of visualization (e.g., bar, line, pie) used in the chart.",
"example": "table",
"type": "string"
},
"dashboardId": {
"description": "Unique identifier of the dashboard in Superset.",
"example": 7,
"format": "int64",
"type": "integer"
}
},
"components": {
"schemas": {
"ChartCreatedPayload": {
"allOf": [
{
"$ref": "https://eventcatalog.event-catalog.int.otc.fts.d-3.de/schemas/analytics-track.yaml#/TrackEvent"
},
{
"properties": {
"event": {
"const": "ChartCreated"
}
},
"title": "Specific event properties",
"type": "object"
}
]
},
"ChartDataLoadedPayload": {
"allOf": [
{
"$ref": "https://eventcatalog.event-catalog.int.otc.fts.d-3.de/schemas/analytics-track.yaml#/TrackEvent"
},
{
"properties": {
"event": {
"const": "ChartDataLoaded"
},
"properties": {
"properties": {
"chartId": {
"description": "Unique identifier of the chart in Superset.",
"example": 42,
"format": "int64",
"type": "integer"
},
"dashboardId": {
"description": "Unique identifier of the dashboard in Superset.",
"example": 7,
"format": "int64",
"type": "integer"
},
"vizType": {
"description": "Type of visualization (e.g., bar, line, pie) used in the chart.",
"example": "table",
"type": "string"
}
},
"type": "object"
}
},
"title": "Specific event properties",
"type": "object"
}
]
},
"ChartDeletedPayload": {
"allOf": [
{
"$ref": "https://eventcatalog.event-catalog.int.otc.fts.d-3.de/schemas/analytics-track.yaml#/TrackEvent"
},
{
"properties": {
"event": {
"const": "ChartDeleted"
},
"properties": {
"properties": {
"chartId": {
"description": "Unique identifier of the chart in Superset.",
"example": 42,
"format": "int64",
"type": "integer"
}
},
"type": "object"
}
},
"title": "Specific event properties",
"type": "object"
}
]
},
"ChartFavoritedPayload": {
"allOf": [
{
"$ref": "https://eventcatalog.event-catalog.int.otc.fts.d-3.de/schemas/analytics-track.yaml#/TrackEvent"
},
{
"properties": {
"event": {
"const": "ChartFavorited"
},
"properties": {
"properties": {
"chartId": {
"description": "Unique identifier of the chart in Superset.",
"example": 333,
"format": "int64",
"type": "integer"
}
},
"type": "object"
}
},
"title": "Specific event properties",
"type": "object"
}
]
},
"ChartUnfavoritedPayload": {
"allOf": [
{
"$ref": "https://eventcatalog.event-catalog.int.otc.fts.d-3.de/schemas/analytics-track.yaml#/TrackEvent"
},
{
"properties": {
"event": {
"const": "ChartUnfavorited"
},
"properties": {
"properties": {
"chartId": {
"description": "Unique identifier of the chart in Superset.",
"example": 42,
"format": "int64",
"type": "integer"
}
},
"type": "object"
}
},
"title": "Specific event properties",
"type": "object"
}
]
},
"ChartUpdatedPayload": {
"allOf": [
{
"$ref": "https://eventcatalog.event-catalog.int.otc.fts.d-3.de/schemas/analytics-track.yaml#/TrackEvent"
},
{
"properties": {
"event": {
"const": "ChartUpdated"
},
"properties": {
"properties": {
"chartId": {
"description": "Unique identifier of the chart in Superset.",
"example": 42,
"format": "int64",
"type": "integer"
}
},
"type": "object"
}
},
"title": "Specific event properties",
"type": "object"
}
]
},
"DashboardCreatedPayload": {
"allOf": [
{
"$ref": "https://eventcatalog.event-catalog.int.otc.fts.d-3.de/schemas/analytics-track.yaml#/TrackEvent"
},
{
"properties": {
"event": {
"const": "DashboardCreated"
},
"properties": {
"properties": {
"dashboardId": {
"description": "Unique identifier of the dashboard in Superset.",
"example": 7,
"format": "int64",
"type": "integer"
}
},
"type": "object"
}
},
"title": "Specific event properties",
"type": "object"
}
]
},
"DashboardDeletedPayload": {
"allOf": [
{
"$ref": "https://eventcatalog.event-catalog.int.otc.fts.d-3.de/schemas/analytics-track.yaml#/TrackEvent"
},
{
"properties": {
"event": {
"const": "DashboardDeleted"
},
"properties": {
"properties": {
"dashboardId": {
"description": "Unique identifier of the dashboard in Superset.",
"example": 7,
"format": "int64",
"type": "integer"
}
},
"type": "object"
}
},
"title": "Specific event properties",
"type": "object"
}
]
},
"DashboardFavoritedPayload": {
"allOf": [
{
"$ref": "https://eventcatalog.event-catalog.int.otc.fts.d-3.de/schemas/analytics-track.yaml#/TrackEvent"
},
{
"properties": {
"event": {
"const": "DashboardFavorited"
},
"properties": {
"properties": {
"dashboardId": {
"description": "Unique identifier of the dashboard in Superset.",
"example": 7,
"format": "int64",
"type": "integer"
}
},
"type": "object"
}
},
"title": "Specific event properties",
"type": "object"
}
]
},
"DashboardUnfavoritedPayload": {
"allOf": [
{
"$ref": "https://eventcatalog.event-catalog.int.otc.fts.d-3.de/schemas/analytics-track.yaml#/TrackEvent"
},
{
"properties": {
"event": {
"const": "DashboardUnfavorited"
},
"properties": {
"properties": {
"dashboardId": {
"description": "Unique identifier of the dashboard in Superset.",
"example": 7,
"format": "int64",
"type": "integer"
}
},
"type": "object"
}
},
"title": "Specific event properties",
"type": "object"
}
]
},
"DashboardUpdatedPayload": {
"allOf": [
{
"$ref": "https://eventcatalog.event-catalog.int.otc.fts.d-3.de/schemas/analytics-track.yaml#/TrackEvent"
},
{
"properties": {
"event": {
"const": "DashboardUpdated"
},
"properties": {
"properties": {
"dashboardId": {
"description": "Unique identifier of the dashboard in Superset.",
"example": 7,
"format": "int64",
"type": "integer"
}
},
"type": "object"
}
},
"title": "Specific event properties",
"type": "object"
}
]
},
"DashboardViewedPayload": {
"allOf": [
{
"$ref": "https://eventcatalog.event-catalog.int.otc.fts.d-3.de/schemas/analytics-track.yaml#/TrackEvent"
},
{
"properties": {
"event": {
"const": "DashboardViewed"
},
"properties": {
"properties": {
"dashboardId": {
"description": "Unique identifier of the dashboard in Superset.",
"example": 7,
"format": "int64",
"type": "integer"
}
},
"type": "object"
}
},
"title": "Specific event properties",
"type": "object"
}
]
},
"DatasetCreatedPayload": {
"allOf": [
{
"$ref": "https://eventcatalog.event-catalog.int.otc.fts.d-3.de/schemas/analytics-track.yaml#/TrackEvent"
},
{
"properties": {
"event": {
"const": "DatasetCreated"
}
},
"title": "Specific event properties",
"type": "object"
}
]
},
"DatasetDeletedPayload": {
"allOf": [
{
"$ref": "https://eventcatalog.event-catalog.int.otc.fts.d-3.de/schemas/analytics-track.yaml#/TrackEvent"
},
{
"properties": {
"event": {
"const": "DatasetDeleted"
}
},
"title": "Specific event properties",
"type": "object"
}
]
},
"SavedQueryCreatedPayload": {
"allOf": [
{
"$ref": "https://eventcatalog.event-catalog.int.otc.fts.d-3.de/schemas/analytics-track.yaml#/TrackEvent"
},
{
"properties": {
"event": {
"const": "SavedQueryCreated"
}
},
"title": "Specific event properties",
"type": "object"
}
]
},
"SqlLabQueryExecutionFailedPayload": {
"allOf": [
{
"$ref": "https://eventcatalog.event-catalog.int.otc.fts.d-3.de/schemas/analytics-track.yaml#/TrackEvent"
},
{
"properties": {
"event": {
"const": "SqlLabQueryExecutionFailed"
}
},
"title": "Specific event properties",
"type": "object"
}
]
},
"SqlLabQueryExecutionSucceededPayload": {
"allOf": [
{
"$ref": "https://eventcatalog.event-catalog.int.otc.fts.d-3.de/schemas/analytics-track.yaml#/TrackEvent"
},
{
"properties": {
"event": {
"const": "SqlLabQueryExecutionSucceeded"
},
"properties": {
"properties": {
"dashboardId": {
"description": "Unique identifier of the dashboard in Superset.",
"example": 12,
"format": "int64",
"type": "integer"
}
},
"type": "object"
}
},
"title": "Specific event properties",
"type": "object"
}
]
}
}
}
}
---
id: analytics-platform.ChartDeleted
name: ChartDeleted
version: 1.0.0
summary: "Indicates that a user has deleted a chart in Superset"
producers:
- analytics-platform
consumers: []
schemaPath: 'schema.json'
---
# ChartDeleted
Indicates that a user has deleted a chart in Superset
## Base Schema
All analytics events are based on the **TrackEvent** schema which provides common properties like `messageId`, `userId`, `context`, timestamps, and more.
**Base Schema Reference**: [analytics-track.yaml](https://event-catalog.prod.otc.fts.d-3.de/schemas/analytics-track.yaml)
## Event-Specific Properties
This schema shows only the event-specific properties that extend the base TrackEvent schema:
## Raw Schema:schema.json
{
"title": "Event-Specific Properties",
"type": "object",
"description": "Properties specific to this event type (extends BaseEvent)",
"extends": "https://eventcatalog.event-catalog.int.otc.fts.d-3.de/schemas/analytics-track.yaml#/TrackEvent",
"eventType": "ChartDeleted",
"properties": {
"chartId": {
"description": "Unique identifier of the chart in Superset.",
"example": 42,
"format": "int64",
"type": "integer"
}
},
"components": {
"schemas": {
"ChartCreatedPayload": {
"allOf": [
{
"$ref": "https://eventcatalog.event-catalog.int.otc.fts.d-3.de/schemas/analytics-track.yaml#/TrackEvent"
},
{
"properties": {
"event": {
"const": "ChartCreated"
}
},
"title": "Specific event properties",
"type": "object"
}
]
},
"ChartDataLoadedPayload": {
"allOf": [
{
"$ref": "https://eventcatalog.event-catalog.int.otc.fts.d-3.de/schemas/analytics-track.yaml#/TrackEvent"
},
{
"properties": {
"event": {
"const": "ChartDataLoaded"
},
"properties": {
"properties": {
"chartId": {
"description": "Unique identifier of the chart in Superset.",
"example": 42,
"format": "int64",
"type": "integer"
},
"dashboardId": {
"description": "Unique identifier of the dashboard in Superset.",
"example": 7,
"format": "int64",
"type": "integer"
},
"vizType": {
"description": "Type of visualization (e.g., bar, line, pie) used in the chart.",
"example": "table",
"type": "string"
}
},
"type": "object"
}
},
"title": "Specific event properties",
"type": "object"
}
]
},
"ChartDeletedPayload": {
"allOf": [
{
"$ref": "https://eventcatalog.event-catalog.int.otc.fts.d-3.de/schemas/analytics-track.yaml#/TrackEvent"
},
{
"properties": {
"event": {
"const": "ChartDeleted"
},
"properties": {
"properties": {
"chartId": {
"description": "Unique identifier of the chart in Superset.",
"example": 42,
"format": "int64",
"type": "integer"
}
},
"type": "object"
}
},
"title": "Specific event properties",
"type": "object"
}
]
},
"ChartFavoritedPayload": {
"allOf": [
{
"$ref": "https://eventcatalog.event-catalog.int.otc.fts.d-3.de/schemas/analytics-track.yaml#/TrackEvent"
},
{
"properties": {
"event": {
"const": "ChartFavorited"
},
"properties": {
"properties": {
"chartId": {
"description": "Unique identifier of the chart in Superset.",
"example": 333,
"format": "int64",
"type": "integer"
}
},
"type": "object"
}
},
"title": "Specific event properties",
"type": "object"
}
]
},
"ChartUnfavoritedPayload": {
"allOf": [
{
"$ref": "https://eventcatalog.event-catalog.int.otc.fts.d-3.de/schemas/analytics-track.yaml#/TrackEvent"
},
{
"properties": {
"event": {
"const": "ChartUnfavorited"
},
"properties": {
"properties": {
"chartId": {
"description": "Unique identifier of the chart in Superset.",
"example": 42,
"format": "int64",
"type": "integer"
}
},
"type": "object"
}
},
"title": "Specific event properties",
"type": "object"
}
]
},
"ChartUpdatedPayload": {
"allOf": [
{
"$ref": "https://eventcatalog.event-catalog.int.otc.fts.d-3.de/schemas/analytics-track.yaml#/TrackEvent"
},
{
"properties": {
"event": {
"const": "ChartUpdated"
},
"properties": {
"properties": {
"chartId": {
"description": "Unique identifier of the chart in Superset.",
"example": 42,
"format": "int64",
"type": "integer"
}
},
"type": "object"
}
},
"title": "Specific event properties",
"type": "object"
}
]
},
"DashboardCreatedPayload": {
"allOf": [
{
"$ref": "https://eventcatalog.event-catalog.int.otc.fts.d-3.de/schemas/analytics-track.yaml#/TrackEvent"
},
{
"properties": {
"event": {
"const": "DashboardCreated"
},
"properties": {
"properties": {
"dashboardId": {
"description": "Unique identifier of the dashboard in Superset.",
"example": 7,
"format": "int64",
"type": "integer"
}
},
"type": "object"
}
},
"title": "Specific event properties",
"type": "object"
}
]
},
"DashboardDeletedPayload": {
"allOf": [
{
"$ref": "https://eventcatalog.event-catalog.int.otc.fts.d-3.de/schemas/analytics-track.yaml#/TrackEvent"
},
{
"properties": {
"event": {
"const": "DashboardDeleted"
},
"properties": {
"properties": {
"dashboardId": {
"description": "Unique identifier of the dashboard in Superset.",
"example": 7,
"format": "int64",
"type": "integer"
}
},
"type": "object"
}
},
"title": "Specific event properties",
"type": "object"
}
]
},
"DashboardFavoritedPayload": {
"allOf": [
{
"$ref": "https://eventcatalog.event-catalog.int.otc.fts.d-3.de/schemas/analytics-track.yaml#/TrackEvent"
},
{
"properties": {
"event": {
"const": "DashboardFavorited"
},
"properties": {
"properties": {
"dashboardId": {
"description": "Unique identifier of the dashboard in Superset.",
"example": 7,
"format": "int64",
"type": "integer"
}
},
"type": "object"
}
},
"title": "Specific event properties",
"type": "object"
}
]
},
"DashboardUnfavoritedPayload": {
"allOf": [
{
"$ref": "https://eventcatalog.event-catalog.int.otc.fts.d-3.de/schemas/analytics-track.yaml#/TrackEvent"
},
{
"properties": {
"event": {
"const": "DashboardUnfavorited"
},
"properties": {
"properties": {
"dashboardId": {
"description": "Unique identifier of the dashboard in Superset.",
"example": 7,
"format": "int64",
"type": "integer"
}
},
"type": "object"
}
},
"title": "Specific event properties",
"type": "object"
}
]
},
"DashboardUpdatedPayload": {
"allOf": [
{
"$ref": "https://eventcatalog.event-catalog.int.otc.fts.d-3.de/schemas/analytics-track.yaml#/TrackEvent"
},
{
"properties": {
"event": {
"const": "DashboardUpdated"
},
"properties": {
"properties": {
"dashboardId": {
"description": "Unique identifier of the dashboard in Superset.",
"example": 7,
"format": "int64",
"type": "integer"
}
},
"type": "object"
}
},
"title": "Specific event properties",
"type": "object"
}
]
},
"DashboardViewedPayload": {
"allOf": [
{
"$ref": "https://eventcatalog.event-catalog.int.otc.fts.d-3.de/schemas/analytics-track.yaml#/TrackEvent"
},
{
"properties": {
"event": {
"const": "DashboardViewed"
},
"properties": {
"properties": {
"dashboardId": {
"description": "Unique identifier of the dashboard in Superset.",
"example": 7,
"format": "int64",
"type": "integer"
}
},
"type": "object"
}
},
"title": "Specific event properties",
"type": "object"
}
]
},
"DatasetCreatedPayload": {
"allOf": [
{
"$ref": "https://eventcatalog.event-catalog.int.otc.fts.d-3.de/schemas/analytics-track.yaml#/TrackEvent"
},
{
"properties": {
"event": {
"const": "DatasetCreated"
}
},
"title": "Specific event properties",
"type": "object"
}
]
},
"DatasetDeletedPayload": {
"allOf": [
{
"$ref": "https://eventcatalog.event-catalog.int.otc.fts.d-3.de/schemas/analytics-track.yaml#/TrackEvent"
},
{
"properties": {
"event": {
"const": "DatasetDeleted"
}
},
"title": "Specific event properties",
"type": "object"
}
]
},
"SavedQueryCreatedPayload": {
"allOf": [
{
"$ref": "https://eventcatalog.event-catalog.int.otc.fts.d-3.de/schemas/analytics-track.yaml#/TrackEvent"
},
{
"properties": {
"event": {
"const": "SavedQueryCreated"
}
},
"title": "Specific event properties",
"type": "object"
}
]
},
"SqlLabQueryExecutionFailedPayload": {
"allOf": [
{
"$ref": "https://eventcatalog.event-catalog.int.otc.fts.d-3.de/schemas/analytics-track.yaml#/TrackEvent"
},
{
"properties": {
"event": {
"const": "SqlLabQueryExecutionFailed"
}
},
"title": "Specific event properties",
"type": "object"
}
]
},
"SqlLabQueryExecutionSucceededPayload": {
"allOf": [
{
"$ref": "https://eventcatalog.event-catalog.int.otc.fts.d-3.de/schemas/analytics-track.yaml#/TrackEvent"
},
{
"properties": {
"event": {
"const": "SqlLabQueryExecutionSucceeded"
},
"properties": {
"properties": {
"dashboardId": {
"description": "Unique identifier of the dashboard in Superset.",
"example": 12,
"format": "int64",
"type": "integer"
}
},
"type": "object"
}
},
"title": "Specific event properties",
"type": "object"
}
]
}
}
}
}
---
id: analytics-platform.ChartFavorited
name: ChartFavorited
version: 1.0.0
summary: "Indicates that a user has favorited a chart in Superset"
producers:
- analytics-platform
consumers: []
schemaPath: 'schema.json'
---
# ChartFavorited
Indicates that a user has favorited a chart in Superset
## Base Schema
All analytics events are based on the **TrackEvent** schema which provides common properties like `messageId`, `userId`, `context`, timestamps, and more.
**Base Schema Reference**: [analytics-track.yaml](https://event-catalog.prod.otc.fts.d-3.de/schemas/analytics-track.yaml)
## Event-Specific Properties
This schema shows only the event-specific properties that extend the base TrackEvent schema:
## Raw Schema:schema.json
{
"title": "Event-Specific Properties",
"type": "object",
"description": "Properties specific to this event type (extends BaseEvent)",
"extends": "https://eventcatalog.event-catalog.int.otc.fts.d-3.de/schemas/analytics-track.yaml#/TrackEvent",
"eventType": "ChartFavorited",
"properties": {
"chartId": {
"description": "Unique identifier of the chart in Superset.",
"example": 333,
"format": "int64",
"type": "integer"
}
},
"components": {
"schemas": {
"ChartCreatedPayload": {
"allOf": [
{
"$ref": "https://eventcatalog.event-catalog.int.otc.fts.d-3.de/schemas/analytics-track.yaml#/TrackEvent"
},
{
"properties": {
"event": {
"const": "ChartCreated"
}
},
"title": "Specific event properties",
"type": "object"
}
]
},
"ChartDataLoadedPayload": {
"allOf": [
{
"$ref": "https://eventcatalog.event-catalog.int.otc.fts.d-3.de/schemas/analytics-track.yaml#/TrackEvent"
},
{
"properties": {
"event": {
"const": "ChartDataLoaded"
},
"properties": {
"properties": {
"chartId": {
"description": "Unique identifier of the chart in Superset.",
"example": 42,
"format": "int64",
"type": "integer"
},
"dashboardId": {
"description": "Unique identifier of the dashboard in Superset.",
"example": 7,
"format": "int64",
"type": "integer"
},
"vizType": {
"description": "Type of visualization (e.g., bar, line, pie) used in the chart.",
"example": "table",
"type": "string"
}
},
"type": "object"
}
},
"title": "Specific event properties",
"type": "object"
}
]
},
"ChartDeletedPayload": {
"allOf": [
{
"$ref": "https://eventcatalog.event-catalog.int.otc.fts.d-3.de/schemas/analytics-track.yaml#/TrackEvent"
},
{
"properties": {
"event": {
"const": "ChartDeleted"
},
"properties": {
"properties": {
"chartId": {
"description": "Unique identifier of the chart in Superset.",
"example": 42,
"format": "int64",
"type": "integer"
}
},
"type": "object"
}
},
"title": "Specific event properties",
"type": "object"
}
]
},
"ChartFavoritedPayload": {
"allOf": [
{
"$ref": "https://eventcatalog.event-catalog.int.otc.fts.d-3.de/schemas/analytics-track.yaml#/TrackEvent"
},
{
"properties": {
"event": {
"const": "ChartFavorited"
},
"properties": {
"properties": {
"chartId": {
"description": "Unique identifier of the chart in Superset.",
"example": 333,
"format": "int64",
"type": "integer"
}
},
"type": "object"
}
},
"title": "Specific event properties",
"type": "object"
}
]
},
"ChartUnfavoritedPayload": {
"allOf": [
{
"$ref": "https://eventcatalog.event-catalog.int.otc.fts.d-3.de/schemas/analytics-track.yaml#/TrackEvent"
},
{
"properties": {
"event": {
"const": "ChartUnfavorited"
},
"properties": {
"properties": {
"chartId": {
"description": "Unique identifier of the chart in Superset.",
"example": 42,
"format": "int64",
"type": "integer"
}
},
"type": "object"
}
},
"title": "Specific event properties",
"type": "object"
}
]
},
"ChartUpdatedPayload": {
"allOf": [
{
"$ref": "https://eventcatalog.event-catalog.int.otc.fts.d-3.de/schemas/analytics-track.yaml#/TrackEvent"
},
{
"properties": {
"event": {
"const": "ChartUpdated"
},
"properties": {
"properties": {
"chartId": {
"description": "Unique identifier of the chart in Superset.",
"example": 42,
"format": "int64",
"type": "integer"
}
},
"type": "object"
}
},
"title": "Specific event properties",
"type": "object"
}
]
},
"DashboardCreatedPayload": {
"allOf": [
{
"$ref": "https://eventcatalog.event-catalog.int.otc.fts.d-3.de/schemas/analytics-track.yaml#/TrackEvent"
},
{
"properties": {
"event": {
"const": "DashboardCreated"
},
"properties": {
"properties": {
"dashboardId": {
"description": "Unique identifier of the dashboard in Superset.",
"example": 7,
"format": "int64",
"type": "integer"
}
},
"type": "object"
}
},
"title": "Specific event properties",
"type": "object"
}
]
},
"DashboardDeletedPayload": {
"allOf": [
{
"$ref": "https://eventcatalog.event-catalog.int.otc.fts.d-3.de/schemas/analytics-track.yaml#/TrackEvent"
},
{
"properties": {
"event": {
"const": "DashboardDeleted"
},
"properties": {
"properties": {
"dashboardId": {
"description": "Unique identifier of the dashboard in Superset.",
"example": 7,
"format": "int64",
"type": "integer"
}
},
"type": "object"
}
},
"title": "Specific event properties",
"type": "object"
}
]
},
"DashboardFavoritedPayload": {
"allOf": [
{
"$ref": "https://eventcatalog.event-catalog.int.otc.fts.d-3.de/schemas/analytics-track.yaml#/TrackEvent"
},
{
"properties": {
"event": {
"const": "DashboardFavorited"
},
"properties": {
"properties": {
"dashboardId": {
"description": "Unique identifier of the dashboard in Superset.",
"example": 7,
"format": "int64",
"type": "integer"
}
},
"type": "object"
}
},
"title": "Specific event properties",
"type": "object"
}
]
},
"DashboardUnfavoritedPayload": {
"allOf": [
{
"$ref": "https://eventcatalog.event-catalog.int.otc.fts.d-3.de/schemas/analytics-track.yaml#/TrackEvent"
},
{
"properties": {
"event": {
"const": "DashboardUnfavorited"
},
"properties": {
"properties": {
"dashboardId": {
"description": "Unique identifier of the dashboard in Superset.",
"example": 7,
"format": "int64",
"type": "integer"
}
},
"type": "object"
}
},
"title": "Specific event properties",
"type": "object"
}
]
},
"DashboardUpdatedPayload": {
"allOf": [
{
"$ref": "https://eventcatalog.event-catalog.int.otc.fts.d-3.de/schemas/analytics-track.yaml#/TrackEvent"
},
{
"properties": {
"event": {
"const": "DashboardUpdated"
},
"properties": {
"properties": {
"dashboardId": {
"description": "Unique identifier of the dashboard in Superset.",
"example": 7,
"format": "int64",
"type": "integer"
}
},
"type": "object"
}
},
"title": "Specific event properties",
"type": "object"
}
]
},
"DashboardViewedPayload": {
"allOf": [
{
"$ref": "https://eventcatalog.event-catalog.int.otc.fts.d-3.de/schemas/analytics-track.yaml#/TrackEvent"
},
{
"properties": {
"event": {
"const": "DashboardViewed"
},
"properties": {
"properties": {
"dashboardId": {
"description": "Unique identifier of the dashboard in Superset.",
"example": 7,
"format": "int64",
"type": "integer"
}
},
"type": "object"
}
},
"title": "Specific event properties",
"type": "object"
}
]
},
"DatasetCreatedPayload": {
"allOf": [
{
"$ref": "https://eventcatalog.event-catalog.int.otc.fts.d-3.de/schemas/analytics-track.yaml#/TrackEvent"
},
{
"properties": {
"event": {
"const": "DatasetCreated"
}
},
"title": "Specific event properties",
"type": "object"
}
]
},
"DatasetDeletedPayload": {
"allOf": [
{
"$ref": "https://eventcatalog.event-catalog.int.otc.fts.d-3.de/schemas/analytics-track.yaml#/TrackEvent"
},
{
"properties": {
"event": {
"const": "DatasetDeleted"
}
},
"title": "Specific event properties",
"type": "object"
}
]
},
"SavedQueryCreatedPayload": {
"allOf": [
{
"$ref": "https://eventcatalog.event-catalog.int.otc.fts.d-3.de/schemas/analytics-track.yaml#/TrackEvent"
},
{
"properties": {
"event": {
"const": "SavedQueryCreated"
}
},
"title": "Specific event properties",
"type": "object"
}
]
},
"SqlLabQueryExecutionFailedPayload": {
"allOf": [
{
"$ref": "https://eventcatalog.event-catalog.int.otc.fts.d-3.de/schemas/analytics-track.yaml#/TrackEvent"
},
{
"properties": {
"event": {
"const": "SqlLabQueryExecutionFailed"
}
},
"title": "Specific event properties",
"type": "object"
}
]
},
"SqlLabQueryExecutionSucceededPayload": {
"allOf": [
{
"$ref": "https://eventcatalog.event-catalog.int.otc.fts.d-3.de/schemas/analytics-track.yaml#/TrackEvent"
},
{
"properties": {
"event": {
"const": "SqlLabQueryExecutionSucceeded"
},
"properties": {
"properties": {
"dashboardId": {
"description": "Unique identifier of the dashboard in Superset.",
"example": 12,
"format": "int64",
"type": "integer"
}
},
"type": "object"
}
},
"title": "Specific event properties",
"type": "object"
}
]
}
}
}
}
---
id: analytics-platform.ChartUnfavorited
name: ChartUnfavorited
version: 1.0.0
summary: "Indicates that a user has unfavorited a chart in Superset"
producers:
- analytics-platform
consumers: []
schemaPath: 'schema.json'
---
# ChartUnfavorited
Indicates that a user has unfavorited a chart in Superset
## Base Schema
All analytics events are based on the **TrackEvent** schema which provides common properties like `messageId`, `userId`, `context`, timestamps, and more.
**Base Schema Reference**: [analytics-track.yaml](https://event-catalog.prod.otc.fts.d-3.de/schemas/analytics-track.yaml)
## Event-Specific Properties
This schema shows only the event-specific properties that extend the base TrackEvent schema:
## Raw Schema:schema.json
{
"title": "Event-Specific Properties",
"type": "object",
"description": "Properties specific to this event type (extends BaseEvent)",
"extends": "https://eventcatalog.event-catalog.int.otc.fts.d-3.de/schemas/analytics-track.yaml#/TrackEvent",
"eventType": "ChartUnfavorited",
"properties": {
"chartId": {
"description": "Unique identifier of the chart in Superset.",
"example": 42,
"format": "int64",
"type": "integer"
}
},
"components": {
"schemas": {
"ChartCreatedPayload": {
"allOf": [
{
"$ref": "https://eventcatalog.event-catalog.int.otc.fts.d-3.de/schemas/analytics-track.yaml#/TrackEvent"
},
{
"properties": {
"event": {
"const": "ChartCreated"
}
},
"title": "Specific event properties",
"type": "object"
}
]
},
"ChartDataLoadedPayload": {
"allOf": [
{
"$ref": "https://eventcatalog.event-catalog.int.otc.fts.d-3.de/schemas/analytics-track.yaml#/TrackEvent"
},
{
"properties": {
"event": {
"const": "ChartDataLoaded"
},
"properties": {
"properties": {
"chartId": {
"description": "Unique identifier of the chart in Superset.",
"example": 42,
"format": "int64",
"type": "integer"
},
"dashboardId": {
"description": "Unique identifier of the dashboard in Superset.",
"example": 7,
"format": "int64",
"type": "integer"
},
"vizType": {
"description": "Type of visualization (e.g., bar, line, pie) used in the chart.",
"example": "table",
"type": "string"
}
},
"type": "object"
}
},
"title": "Specific event properties",
"type": "object"
}
]
},
"ChartDeletedPayload": {
"allOf": [
{
"$ref": "https://eventcatalog.event-catalog.int.otc.fts.d-3.de/schemas/analytics-track.yaml#/TrackEvent"
},
{
"properties": {
"event": {
"const": "ChartDeleted"
},
"properties": {
"properties": {
"chartId": {
"description": "Unique identifier of the chart in Superset.",
"example": 42,
"format": "int64",
"type": "integer"
}
},
"type": "object"
}
},
"title": "Specific event properties",
"type": "object"
}
]
},
"ChartFavoritedPayload": {
"allOf": [
{
"$ref": "https://eventcatalog.event-catalog.int.otc.fts.d-3.de/schemas/analytics-track.yaml#/TrackEvent"
},
{
"properties": {
"event": {
"const": "ChartFavorited"
},
"properties": {
"properties": {
"chartId": {
"description": "Unique identifier of the chart in Superset.",
"example": 333,
"format": "int64",
"type": "integer"
}
},
"type": "object"
}
},
"title": "Specific event properties",
"type": "object"
}
]
},
"ChartUnfavoritedPayload": {
"allOf": [
{
"$ref": "https://eventcatalog.event-catalog.int.otc.fts.d-3.de/schemas/analytics-track.yaml#/TrackEvent"
},
{
"properties": {
"event": {
"const": "ChartUnfavorited"
},
"properties": {
"properties": {
"chartId": {
"description": "Unique identifier of the chart in Superset.",
"example": 42,
"format": "int64",
"type": "integer"
}
},
"type": "object"
}
},
"title": "Specific event properties",
"type": "object"
}
]
},
"ChartUpdatedPayload": {
"allOf": [
{
"$ref": "https://eventcatalog.event-catalog.int.otc.fts.d-3.de/schemas/analytics-track.yaml#/TrackEvent"
},
{
"properties": {
"event": {
"const": "ChartUpdated"
},
"properties": {
"properties": {
"chartId": {
"description": "Unique identifier of the chart in Superset.",
"example": 42,
"format": "int64",
"type": "integer"
}
},
"type": "object"
}
},
"title": "Specific event properties",
"type": "object"
}
]
},
"DashboardCreatedPayload": {
"allOf": [
{
"$ref": "https://eventcatalog.event-catalog.int.otc.fts.d-3.de/schemas/analytics-track.yaml#/TrackEvent"
},
{
"properties": {
"event": {
"const": "DashboardCreated"
},
"properties": {
"properties": {
"dashboardId": {
"description": "Unique identifier of the dashboard in Superset.",
"example": 7,
"format": "int64",
"type": "integer"
}
},
"type": "object"
}
},
"title": "Specific event properties",
"type": "object"
}
]
},
"DashboardDeletedPayload": {
"allOf": [
{
"$ref": "https://eventcatalog.event-catalog.int.otc.fts.d-3.de/schemas/analytics-track.yaml#/TrackEvent"
},
{
"properties": {
"event": {
"const": "DashboardDeleted"
},
"properties": {
"properties": {
"dashboardId": {
"description": "Unique identifier of the dashboard in Superset.",
"example": 7,
"format": "int64",
"type": "integer"
}
},
"type": "object"
}
},
"title": "Specific event properties",
"type": "object"
}
]
},
"DashboardFavoritedPayload": {
"allOf": [
{
"$ref": "https://eventcatalog.event-catalog.int.otc.fts.d-3.de/schemas/analytics-track.yaml#/TrackEvent"
},
{
"properties": {
"event": {
"const": "DashboardFavorited"
},
"properties": {
"properties": {
"dashboardId": {
"description": "Unique identifier of the dashboard in Superset.",
"example": 7,
"format": "int64",
"type": "integer"
}
},
"type": "object"
}
},
"title": "Specific event properties",
"type": "object"
}
]
},
"DashboardUnfavoritedPayload": {
"allOf": [
{
"$ref": "https://eventcatalog.event-catalog.int.otc.fts.d-3.de/schemas/analytics-track.yaml#/TrackEvent"
},
{
"properties": {
"event": {
"const": "DashboardUnfavorited"
},
"properties": {
"properties": {
"dashboardId": {
"description": "Unique identifier of the dashboard in Superset.",
"example": 7,
"format": "int64",
"type": "integer"
}
},
"type": "object"
}
},
"title": "Specific event properties",
"type": "object"
}
]
},
"DashboardUpdatedPayload": {
"allOf": [
{
"$ref": "https://eventcatalog.event-catalog.int.otc.fts.d-3.de/schemas/analytics-track.yaml#/TrackEvent"
},
{
"properties": {
"event": {
"const": "DashboardUpdated"
},
"properties": {
"properties": {
"dashboardId": {
"description": "Unique identifier of the dashboard in Superset.",
"example": 7,
"format": "int64",
"type": "integer"
}
},
"type": "object"
}
},
"title": "Specific event properties",
"type": "object"
}
]
},
"DashboardViewedPayload": {
"allOf": [
{
"$ref": "https://eventcatalog.event-catalog.int.otc.fts.d-3.de/schemas/analytics-track.yaml#/TrackEvent"
},
{
"properties": {
"event": {
"const": "DashboardViewed"
},
"properties": {
"properties": {
"dashboardId": {
"description": "Unique identifier of the dashboard in Superset.",
"example": 7,
"format": "int64",
"type": "integer"
}
},
"type": "object"
}
},
"title": "Specific event properties",
"type": "object"
}
]
},
"DatasetCreatedPayload": {
"allOf": [
{
"$ref": "https://eventcatalog.event-catalog.int.otc.fts.d-3.de/schemas/analytics-track.yaml#/TrackEvent"
},
{
"properties": {
"event": {
"const": "DatasetCreated"
}
},
"title": "Specific event properties",
"type": "object"
}
]
},
"DatasetDeletedPayload": {
"allOf": [
{
"$ref": "https://eventcatalog.event-catalog.int.otc.fts.d-3.de/schemas/analytics-track.yaml#/TrackEvent"
},
{
"properties": {
"event": {
"const": "DatasetDeleted"
}
},
"title": "Specific event properties",
"type": "object"
}
]
},
"SavedQueryCreatedPayload": {
"allOf": [
{
"$ref": "https://eventcatalog.event-catalog.int.otc.fts.d-3.de/schemas/analytics-track.yaml#/TrackEvent"
},
{
"properties": {
"event": {
"const": "SavedQueryCreated"
}
},
"title": "Specific event properties",
"type": "object"
}
]
},
"SqlLabQueryExecutionFailedPayload": {
"allOf": [
{
"$ref": "https://eventcatalog.event-catalog.int.otc.fts.d-3.de/schemas/analytics-track.yaml#/TrackEvent"
},
{
"properties": {
"event": {
"const": "SqlLabQueryExecutionFailed"
}
},
"title": "Specific event properties",
"type": "object"
}
]
},
"SqlLabQueryExecutionSucceededPayload": {
"allOf": [
{
"$ref": "https://eventcatalog.event-catalog.int.otc.fts.d-3.de/schemas/analytics-track.yaml#/TrackEvent"
},
{
"properties": {
"event": {
"const": "SqlLabQueryExecutionSucceeded"
},
"properties": {
"properties": {
"dashboardId": {
"description": "Unique identifier of the dashboard in Superset.",
"example": 12,
"format": "int64",
"type": "integer"
}
},
"type": "object"
}
},
"title": "Specific event properties",
"type": "object"
}
]
}
}
}
}
---
id: analytics-platform.ChartUpdated
name: ChartUpdated
version: 1.0.0
summary: "Indicates that a user has updated a chart in Superset"
producers:
- analytics-platform
consumers: []
schemaPath: 'schema.json'
---
# ChartUpdated
Indicates that a user has updated a chart in Superset
## Base Schema
All analytics events are based on the **TrackEvent** schema which provides common properties like `messageId`, `userId`, `context`, timestamps, and more.
**Base Schema Reference**: [analytics-track.yaml](https://event-catalog.prod.otc.fts.d-3.de/schemas/analytics-track.yaml)
## Event-Specific Properties
This schema shows only the event-specific properties that extend the base TrackEvent schema:
## Raw Schema:schema.json
{
"title": "Event-Specific Properties",
"type": "object",
"description": "Properties specific to this event type (extends BaseEvent)",
"extends": "https://eventcatalog.event-catalog.int.otc.fts.d-3.de/schemas/analytics-track.yaml#/TrackEvent",
"eventType": "ChartUpdated",
"properties": {
"chartId": {
"description": "Unique identifier of the chart in Superset.",
"example": 42,
"format": "int64",
"type": "integer"
}
},
"components": {
"schemas": {
"ChartCreatedPayload": {
"allOf": [
{
"$ref": "https://eventcatalog.event-catalog.int.otc.fts.d-3.de/schemas/analytics-track.yaml#/TrackEvent"
},
{
"properties": {
"event": {
"const": "ChartCreated"
}
},
"title": "Specific event properties",
"type": "object"
}
]
},
"ChartDataLoadedPayload": {
"allOf": [
{
"$ref": "https://eventcatalog.event-catalog.int.otc.fts.d-3.de/schemas/analytics-track.yaml#/TrackEvent"
},
{
"properties": {
"event": {
"const": "ChartDataLoaded"
},
"properties": {
"properties": {
"chartId": {
"description": "Unique identifier of the chart in Superset.",
"example": 42,
"format": "int64",
"type": "integer"
},
"dashboardId": {
"description": "Unique identifier of the dashboard in Superset.",
"example": 7,
"format": "int64",
"type": "integer"
},
"vizType": {
"description": "Type of visualization (e.g., bar, line, pie) used in the chart.",
"example": "table",
"type": "string"
}
},
"type": "object"
}
},
"title": "Specific event properties",
"type": "object"
}
]
},
"ChartDeletedPayload": {
"allOf": [
{
"$ref": "https://eventcatalog.event-catalog.int.otc.fts.d-3.de/schemas/analytics-track.yaml#/TrackEvent"
},
{
"properties": {
"event": {
"const": "ChartDeleted"
},
"properties": {
"properties": {
"chartId": {
"description": "Unique identifier of the chart in Superset.",
"example": 42,
"format": "int64",
"type": "integer"
}
},
"type": "object"
}
},
"title": "Specific event properties",
"type": "object"
}
]
},
"ChartFavoritedPayload": {
"allOf": [
{
"$ref": "https://eventcatalog.event-catalog.int.otc.fts.d-3.de/schemas/analytics-track.yaml#/TrackEvent"
},
{
"properties": {
"event": {
"const": "ChartFavorited"
},
"properties": {
"properties": {
"chartId": {
"description": "Unique identifier of the chart in Superset.",
"example": 333,
"format": "int64",
"type": "integer"
}
},
"type": "object"
}
},
"title": "Specific event properties",
"type": "object"
}
]
},
"ChartUnfavoritedPayload": {
"allOf": [
{
"$ref": "https://eventcatalog.event-catalog.int.otc.fts.d-3.de/schemas/analytics-track.yaml#/TrackEvent"
},
{
"properties": {
"event": {
"const": "ChartUnfavorited"
},
"properties": {
"properties": {
"chartId": {
"description": "Unique identifier of the chart in Superset.",
"example": 42,
"format": "int64",
"type": "integer"
}
},
"type": "object"
}
},
"title": "Specific event properties",
"type": "object"
}
]
},
"ChartUpdatedPayload": {
"allOf": [
{
"$ref": "https://eventcatalog.event-catalog.int.otc.fts.d-3.de/schemas/analytics-track.yaml#/TrackEvent"
},
{
"properties": {
"event": {
"const": "ChartUpdated"
},
"properties": {
"properties": {
"chartId": {
"description": "Unique identifier of the chart in Superset.",
"example": 42,
"format": "int64",
"type": "integer"
}
},
"type": "object"
}
},
"title": "Specific event properties",
"type": "object"
}
]
},
"DashboardCreatedPayload": {
"allOf": [
{
"$ref": "https://eventcatalog.event-catalog.int.otc.fts.d-3.de/schemas/analytics-track.yaml#/TrackEvent"
},
{
"properties": {
"event": {
"const": "DashboardCreated"
},
"properties": {
"properties": {
"dashboardId": {
"description": "Unique identifier of the dashboard in Superset.",
"example": 7,
"format": "int64",
"type": "integer"
}
},
"type": "object"
}
},
"title": "Specific event properties",
"type": "object"
}
]
},
"DashboardDeletedPayload": {
"allOf": [
{
"$ref": "https://eventcatalog.event-catalog.int.otc.fts.d-3.de/schemas/analytics-track.yaml#/TrackEvent"
},
{
"properties": {
"event": {
"const": "DashboardDeleted"
},
"properties": {
"properties": {
"dashboardId": {
"description": "Unique identifier of the dashboard in Superset.",
"example": 7,
"format": "int64",
"type": "integer"
}
},
"type": "object"
}
},
"title": "Specific event properties",
"type": "object"
}
]
},
"DashboardFavoritedPayload": {
"allOf": [
{
"$ref": "https://eventcatalog.event-catalog.int.otc.fts.d-3.de/schemas/analytics-track.yaml#/TrackEvent"
},
{
"properties": {
"event": {
"const": "DashboardFavorited"
},
"properties": {
"properties": {
"dashboardId": {
"description": "Unique identifier of the dashboard in Superset.",
"example": 7,
"format": "int64",
"type": "integer"
}
},
"type": "object"
}
},
"title": "Specific event properties",
"type": "object"
}
]
},
"DashboardUnfavoritedPayload": {
"allOf": [
{
"$ref": "https://eventcatalog.event-catalog.int.otc.fts.d-3.de/schemas/analytics-track.yaml#/TrackEvent"
},
{
"properties": {
"event": {
"const": "DashboardUnfavorited"
},
"properties": {
"properties": {
"dashboardId": {
"description": "Unique identifier of the dashboard in Superset.",
"example": 7,
"format": "int64",
"type": "integer"
}
},
"type": "object"
}
},
"title": "Specific event properties",
"type": "object"
}
]
},
"DashboardUpdatedPayload": {
"allOf": [
{
"$ref": "https://eventcatalog.event-catalog.int.otc.fts.d-3.de/schemas/analytics-track.yaml#/TrackEvent"
},
{
"properties": {
"event": {
"const": "DashboardUpdated"
},
"properties": {
"properties": {
"dashboardId": {
"description": "Unique identifier of the dashboard in Superset.",
"example": 7,
"format": "int64",
"type": "integer"
}
},
"type": "object"
}
},
"title": "Specific event properties",
"type": "object"
}
]
},
"DashboardViewedPayload": {
"allOf": [
{
"$ref": "https://eventcatalog.event-catalog.int.otc.fts.d-3.de/schemas/analytics-track.yaml#/TrackEvent"
},
{
"properties": {
"event": {
"const": "DashboardViewed"
},
"properties": {
"properties": {
"dashboardId": {
"description": "Unique identifier of the dashboard in Superset.",
"example": 7,
"format": "int64",
"type": "integer"
}
},
"type": "object"
}
},
"title": "Specific event properties",
"type": "object"
}
]
},
"DatasetCreatedPayload": {
"allOf": [
{
"$ref": "https://eventcatalog.event-catalog.int.otc.fts.d-3.de/schemas/analytics-track.yaml#/TrackEvent"
},
{
"properties": {
"event": {
"const": "DatasetCreated"
}
},
"title": "Specific event properties",
"type": "object"
}
]
},
"DatasetDeletedPayload": {
"allOf": [
{
"$ref": "https://eventcatalog.event-catalog.int.otc.fts.d-3.de/schemas/analytics-track.yaml#/TrackEvent"
},
{
"properties": {
"event": {
"const": "DatasetDeleted"
}
},
"title": "Specific event properties",
"type": "object"
}
]
},
"SavedQueryCreatedPayload": {
"allOf": [
{
"$ref": "https://eventcatalog.event-catalog.int.otc.fts.d-3.de/schemas/analytics-track.yaml#/TrackEvent"
},
{
"properties": {
"event": {
"const": "SavedQueryCreated"
}
},
"title": "Specific event properties",
"type": "object"
}
]
},
"SqlLabQueryExecutionFailedPayload": {
"allOf": [
{
"$ref": "https://eventcatalog.event-catalog.int.otc.fts.d-3.de/schemas/analytics-track.yaml#/TrackEvent"
},
{
"properties": {
"event": {
"const": "SqlLabQueryExecutionFailed"
}
},
"title": "Specific event properties",
"type": "object"
}
]
},
"SqlLabQueryExecutionSucceededPayload": {
"allOf": [
{
"$ref": "https://eventcatalog.event-catalog.int.otc.fts.d-3.de/schemas/analytics-track.yaml#/TrackEvent"
},
{
"properties": {
"event": {
"const": "SqlLabQueryExecutionSucceeded"
},
"properties": {
"properties": {
"dashboardId": {
"description": "Unique identifier of the dashboard in Superset.",
"example": 12,
"format": "int64",
"type": "integer"
}
},
"type": "object"
}
},
"title": "Specific event properties",
"type": "object"
}
]
}
}
}
}
---
id: analytics-platform.DashboardCreated
name: DashboardCreated
version: 1.0.0
summary: "Indicates that a user has created a dashboard in Superset"
producers:
- analytics-platform
consumers: []
schemaPath: 'schema.json'
---
# DashboardCreated
Indicates that a user has created a dashboard in Superset
## Base Schema
All analytics events are based on the **TrackEvent** schema which provides common properties like `messageId`, `userId`, `context`, timestamps, and more.
**Base Schema Reference**: [analytics-track.yaml](https://event-catalog.prod.otc.fts.d-3.de/schemas/analytics-track.yaml)
## Event-Specific Properties
This schema shows only the event-specific properties that extend the base TrackEvent schema:
## Raw Schema:schema.json
{
"title": "Event-Specific Properties",
"type": "object",
"description": "Properties specific to this event type (extends BaseEvent)",
"extends": "https://eventcatalog.event-catalog.int.otc.fts.d-3.de/schemas/analytics-track.yaml#/TrackEvent",
"eventType": "DashboardCreated",
"properties": {
"dashboardId": {
"description": "Unique identifier of the dashboard in Superset.",
"example": 7,
"format": "int64",
"type": "integer"
}
},
"components": {
"schemas": {
"ChartCreatedPayload": {
"allOf": [
{
"$ref": "https://eventcatalog.event-catalog.int.otc.fts.d-3.de/schemas/analytics-track.yaml#/TrackEvent"
},
{
"properties": {
"event": {
"const": "ChartCreated"
}
},
"title": "Specific event properties",
"type": "object"
}
]
},
"ChartDataLoadedPayload": {
"allOf": [
{
"$ref": "https://eventcatalog.event-catalog.int.otc.fts.d-3.de/schemas/analytics-track.yaml#/TrackEvent"
},
{
"properties": {
"event": {
"const": "ChartDataLoaded"
},
"properties": {
"properties": {
"chartId": {
"description": "Unique identifier of the chart in Superset.",
"example": 42,
"format": "int64",
"type": "integer"
},
"dashboardId": {
"description": "Unique identifier of the dashboard in Superset.",
"example": 7,
"format": "int64",
"type": "integer"
},
"vizType": {
"description": "Type of visualization (e.g., bar, line, pie) used in the chart.",
"example": "table",
"type": "string"
}
},
"type": "object"
}
},
"title": "Specific event properties",
"type": "object"
}
]
},
"ChartDeletedPayload": {
"allOf": [
{
"$ref": "https://eventcatalog.event-catalog.int.otc.fts.d-3.de/schemas/analytics-track.yaml#/TrackEvent"
},
{
"properties": {
"event": {
"const": "ChartDeleted"
},
"properties": {
"properties": {
"chartId": {
"description": "Unique identifier of the chart in Superset.",
"example": 42,
"format": "int64",
"type": "integer"
}
},
"type": "object"
}
},
"title": "Specific event properties",
"type": "object"
}
]
},
"ChartFavoritedPayload": {
"allOf": [
{
"$ref": "https://eventcatalog.event-catalog.int.otc.fts.d-3.de/schemas/analytics-track.yaml#/TrackEvent"
},
{
"properties": {
"event": {
"const": "ChartFavorited"
},
"properties": {
"properties": {
"chartId": {
"description": "Unique identifier of the chart in Superset.",
"example": 333,
"format": "int64",
"type": "integer"
}
},
"type": "object"
}
},
"title": "Specific event properties",
"type": "object"
}
]
},
"ChartUnfavoritedPayload": {
"allOf": [
{
"$ref": "https://eventcatalog.event-catalog.int.otc.fts.d-3.de/schemas/analytics-track.yaml#/TrackEvent"
},
{
"properties": {
"event": {
"const": "ChartUnfavorited"
},
"properties": {
"properties": {
"chartId": {
"description": "Unique identifier of the chart in Superset.",
"example": 42,
"format": "int64",
"type": "integer"
}
},
"type": "object"
}
},
"title": "Specific event properties",
"type": "object"
}
]
},
"ChartUpdatedPayload": {
"allOf": [
{
"$ref": "https://eventcatalog.event-catalog.int.otc.fts.d-3.de/schemas/analytics-track.yaml#/TrackEvent"
},
{
"properties": {
"event": {
"const": "ChartUpdated"
},
"properties": {
"properties": {
"chartId": {
"description": "Unique identifier of the chart in Superset.",
"example": 42,
"format": "int64",
"type": "integer"
}
},
"type": "object"
}
},
"title": "Specific event properties",
"type": "object"
}
]
},
"DashboardCreatedPayload": {
"allOf": [
{
"$ref": "https://eventcatalog.event-catalog.int.otc.fts.d-3.de/schemas/analytics-track.yaml#/TrackEvent"
},
{
"properties": {
"event": {
"const": "DashboardCreated"
},
"properties": {
"properties": {
"dashboardId": {
"description": "Unique identifier of the dashboard in Superset.",
"example": 7,
"format": "int64",
"type": "integer"
}
},
"type": "object"
}
},
"title": "Specific event properties",
"type": "object"
}
]
},
"DashboardDeletedPayload": {
"allOf": [
{
"$ref": "https://eventcatalog.event-catalog.int.otc.fts.d-3.de/schemas/analytics-track.yaml#/TrackEvent"
},
{
"properties": {
"event": {
"const": "DashboardDeleted"
},
"properties": {
"properties": {
"dashboardId": {
"description": "Unique identifier of the dashboard in Superset.",
"example": 7,
"format": "int64",
"type": "integer"
}
},
"type": "object"
}
},
"title": "Specific event properties",
"type": "object"
}
]
},
"DashboardFavoritedPayload": {
"allOf": [
{
"$ref": "https://eventcatalog.event-catalog.int.otc.fts.d-3.de/schemas/analytics-track.yaml#/TrackEvent"
},
{
"properties": {
"event": {
"const": "DashboardFavorited"
},
"properties": {
"properties": {
"dashboardId": {
"description": "Unique identifier of the dashboard in Superset.",
"example": 7,
"format": "int64",
"type": "integer"
}
},
"type": "object"
}
},
"title": "Specific event properties",
"type": "object"
}
]
},
"DashboardUnfavoritedPayload": {
"allOf": [
{
"$ref": "https://eventcatalog.event-catalog.int.otc.fts.d-3.de/schemas/analytics-track.yaml#/TrackEvent"
},
{
"properties": {
"event": {
"const": "DashboardUnfavorited"
},
"properties": {
"properties": {
"dashboardId": {
"description": "Unique identifier of the dashboard in Superset.",
"example": 7,
"format": "int64",
"type": "integer"
}
},
"type": "object"
}
},
"title": "Specific event properties",
"type": "object"
}
]
},
"DashboardUpdatedPayload": {
"allOf": [
{
"$ref": "https://eventcatalog.event-catalog.int.otc.fts.d-3.de/schemas/analytics-track.yaml#/TrackEvent"
},
{
"properties": {
"event": {
"const": "DashboardUpdated"
},
"properties": {
"properties": {
"dashboardId": {
"description": "Unique identifier of the dashboard in Superset.",
"example": 7,
"format": "int64",
"type": "integer"
}
},
"type": "object"
}
},
"title": "Specific event properties",
"type": "object"
}
]
},
"DashboardViewedPayload": {
"allOf": [
{
"$ref": "https://eventcatalog.event-catalog.int.otc.fts.d-3.de/schemas/analytics-track.yaml#/TrackEvent"
},
{
"properties": {
"event": {
"const": "DashboardViewed"
},
"properties": {
"properties": {
"dashboardId": {
"description": "Unique identifier of the dashboard in Superset.",
"example": 7,
"format": "int64",
"type": "integer"
}
},
"type": "object"
}
},
"title": "Specific event properties",
"type": "object"
}
]
},
"DatasetCreatedPayload": {
"allOf": [
{
"$ref": "https://eventcatalog.event-catalog.int.otc.fts.d-3.de/schemas/analytics-track.yaml#/TrackEvent"
},
{
"properties": {
"event": {
"const": "DatasetCreated"
}
},
"title": "Specific event properties",
"type": "object"
}
]
},
"DatasetDeletedPayload": {
"allOf": [
{
"$ref": "https://eventcatalog.event-catalog.int.otc.fts.d-3.de/schemas/analytics-track.yaml#/TrackEvent"
},
{
"properties": {
"event": {
"const": "DatasetDeleted"
}
},
"title": "Specific event properties",
"type": "object"
}
]
},
"SavedQueryCreatedPayload": {
"allOf": [
{
"$ref": "https://eventcatalog.event-catalog.int.otc.fts.d-3.de/schemas/analytics-track.yaml#/TrackEvent"
},
{
"properties": {
"event": {
"const": "SavedQueryCreated"
}
},
"title": "Specific event properties",
"type": "object"
}
]
},
"SqlLabQueryExecutionFailedPayload": {
"allOf": [
{
"$ref": "https://eventcatalog.event-catalog.int.otc.fts.d-3.de/schemas/analytics-track.yaml#/TrackEvent"
},
{
"properties": {
"event": {
"const": "SqlLabQueryExecutionFailed"
}
},
"title": "Specific event properties",
"type": "object"
}
]
},
"SqlLabQueryExecutionSucceededPayload": {
"allOf": [
{
"$ref": "https://eventcatalog.event-catalog.int.otc.fts.d-3.de/schemas/analytics-track.yaml#/TrackEvent"
},
{
"properties": {
"event": {
"const": "SqlLabQueryExecutionSucceeded"
},
"properties": {
"properties": {
"dashboardId": {
"description": "Unique identifier of the dashboard in Superset.",
"example": 12,
"format": "int64",
"type": "integer"
}
},
"type": "object"
}
},
"title": "Specific event properties",
"type": "object"
}
]
}
}
}
}
---
id: analytics-platform.DashboardDeleted
name: DashboardDeleted
version: 1.0.0
summary: "Indicates that a user has deleted a dashboard in Superset"
producers:
- analytics-platform
consumers: []
schemaPath: 'schema.json'
---
# DashboardDeleted
Indicates that a user has deleted a dashboard in Superset
## Base Schema
All analytics events are based on the **TrackEvent** schema which provides common properties like `messageId`, `userId`, `context`, timestamps, and more.
**Base Schema Reference**: [analytics-track.yaml](https://event-catalog.prod.otc.fts.d-3.de/schemas/analytics-track.yaml)
## Event-Specific Properties
This schema shows only the event-specific properties that extend the base TrackEvent schema:
## Raw Schema:schema.json
{
"title": "Event-Specific Properties",
"type": "object",
"description": "Properties specific to this event type (extends BaseEvent)",
"extends": "https://eventcatalog.event-catalog.int.otc.fts.d-3.de/schemas/analytics-track.yaml#/TrackEvent",
"eventType": "DashboardDeleted",
"properties": {
"dashboardId": {
"description": "Unique identifier of the dashboard in Superset.",
"example": 7,
"format": "int64",
"type": "integer"
}
},
"components": {
"schemas": {
"ChartCreatedPayload": {
"allOf": [
{
"$ref": "https://eventcatalog.event-catalog.int.otc.fts.d-3.de/schemas/analytics-track.yaml#/TrackEvent"
},
{
"properties": {
"event": {
"const": "ChartCreated"
}
},
"title": "Specific event properties",
"type": "object"
}
]
},
"ChartDataLoadedPayload": {
"allOf": [
{
"$ref": "https://eventcatalog.event-catalog.int.otc.fts.d-3.de/schemas/analytics-track.yaml#/TrackEvent"
},
{
"properties": {
"event": {
"const": "ChartDataLoaded"
},
"properties": {
"properties": {
"chartId": {
"description": "Unique identifier of the chart in Superset.",
"example": 42,
"format": "int64",
"type": "integer"
},
"dashboardId": {
"description": "Unique identifier of the dashboard in Superset.",
"example": 7,
"format": "int64",
"type": "integer"
},
"vizType": {
"description": "Type of visualization (e.g., bar, line, pie) used in the chart.",
"example": "table",
"type": "string"
}
},
"type": "object"
}
},
"title": "Specific event properties",
"type": "object"
}
]
},
"ChartDeletedPayload": {
"allOf": [
{
"$ref": "https://eventcatalog.event-catalog.int.otc.fts.d-3.de/schemas/analytics-track.yaml#/TrackEvent"
},
{
"properties": {
"event": {
"const": "ChartDeleted"
},
"properties": {
"properties": {
"chartId": {
"description": "Unique identifier of the chart in Superset.",
"example": 42,
"format": "int64",
"type": "integer"
}
},
"type": "object"
}
},
"title": "Specific event properties",
"type": "object"
}
]
},
"ChartFavoritedPayload": {
"allOf": [
{
"$ref": "https://eventcatalog.event-catalog.int.otc.fts.d-3.de/schemas/analytics-track.yaml#/TrackEvent"
},
{
"properties": {
"event": {
"const": "ChartFavorited"
},
"properties": {
"properties": {
"chartId": {
"description": "Unique identifier of the chart in Superset.",
"example": 333,
"format": "int64",
"type": "integer"
}
},
"type": "object"
}
},
"title": "Specific event properties",
"type": "object"
}
]
},
"ChartUnfavoritedPayload": {
"allOf": [
{
"$ref": "https://eventcatalog.event-catalog.int.otc.fts.d-3.de/schemas/analytics-track.yaml#/TrackEvent"
},
{
"properties": {
"event": {
"const": "ChartUnfavorited"
},
"properties": {
"properties": {
"chartId": {
"description": "Unique identifier of the chart in Superset.",
"example": 42,
"format": "int64",
"type": "integer"
}
},
"type": "object"
}
},
"title": "Specific event properties",
"type": "object"
}
]
},
"ChartUpdatedPayload": {
"allOf": [
{
"$ref": "https://eventcatalog.event-catalog.int.otc.fts.d-3.de/schemas/analytics-track.yaml#/TrackEvent"
},
{
"properties": {
"event": {
"const": "ChartUpdated"
},
"properties": {
"properties": {
"chartId": {
"description": "Unique identifier of the chart in Superset.",
"example": 42,
"format": "int64",
"type": "integer"
}
},
"type": "object"
}
},
"title": "Specific event properties",
"type": "object"
}
]
},
"DashboardCreatedPayload": {
"allOf": [
{
"$ref": "https://eventcatalog.event-catalog.int.otc.fts.d-3.de/schemas/analytics-track.yaml#/TrackEvent"
},
{
"properties": {
"event": {
"const": "DashboardCreated"
},
"properties": {
"properties": {
"dashboardId": {
"description": "Unique identifier of the dashboard in Superset.",
"example": 7,
"format": "int64",
"type": "integer"
}
},
"type": "object"
}
},
"title": "Specific event properties",
"type": "object"
}
]
},
"DashboardDeletedPayload": {
"allOf": [
{
"$ref": "https://eventcatalog.event-catalog.int.otc.fts.d-3.de/schemas/analytics-track.yaml#/TrackEvent"
},
{
"properties": {
"event": {
"const": "DashboardDeleted"
},
"properties": {
"properties": {
"dashboardId": {
"description": "Unique identifier of the dashboard in Superset.",
"example": 7,
"format": "int64",
"type": "integer"
}
},
"type": "object"
}
},
"title": "Specific event properties",
"type": "object"
}
]
},
"DashboardFavoritedPayload": {
"allOf": [
{
"$ref": "https://eventcatalog.event-catalog.int.otc.fts.d-3.de/schemas/analytics-track.yaml#/TrackEvent"
},
{
"properties": {
"event": {
"const": "DashboardFavorited"
},
"properties": {
"properties": {
"dashboardId": {
"description": "Unique identifier of the dashboard in Superset.",
"example": 7,
"format": "int64",
"type": "integer"
}
},
"type": "object"
}
},
"title": "Specific event properties",
"type": "object"
}
]
},
"DashboardUnfavoritedPayload": {
"allOf": [
{
"$ref": "https://eventcatalog.event-catalog.int.otc.fts.d-3.de/schemas/analytics-track.yaml#/TrackEvent"
},
{
"properties": {
"event": {
"const": "DashboardUnfavorited"
},
"properties": {
"properties": {
"dashboardId": {
"description": "Unique identifier of the dashboard in Superset.",
"example": 7,
"format": "int64",
"type": "integer"
}
},
"type": "object"
}
},
"title": "Specific event properties",
"type": "object"
}
]
},
"DashboardUpdatedPayload": {
"allOf": [
{
"$ref": "https://eventcatalog.event-catalog.int.otc.fts.d-3.de/schemas/analytics-track.yaml#/TrackEvent"
},
{
"properties": {
"event": {
"const": "DashboardUpdated"
},
"properties": {
"properties": {
"dashboardId": {
"description": "Unique identifier of the dashboard in Superset.",
"example": 7,
"format": "int64",
"type": "integer"
}
},
"type": "object"
}
},
"title": "Specific event properties",
"type": "object"
}
]
},
"DashboardViewedPayload": {
"allOf": [
{
"$ref": "https://eventcatalog.event-catalog.int.otc.fts.d-3.de/schemas/analytics-track.yaml#/TrackEvent"
},
{
"properties": {
"event": {
"const": "DashboardViewed"
},
"properties": {
"properties": {
"dashboardId": {
"description": "Unique identifier of the dashboard in Superset.",
"example": 7,
"format": "int64",
"type": "integer"
}
},
"type": "object"
}
},
"title": "Specific event properties",
"type": "object"
}
]
},
"DatasetCreatedPayload": {
"allOf": [
{
"$ref": "https://eventcatalog.event-catalog.int.otc.fts.d-3.de/schemas/analytics-track.yaml#/TrackEvent"
},
{
"properties": {
"event": {
"const": "DatasetCreated"
}
},
"title": "Specific event properties",
"type": "object"
}
]
},
"DatasetDeletedPayload": {
"allOf": [
{
"$ref": "https://eventcatalog.event-catalog.int.otc.fts.d-3.de/schemas/analytics-track.yaml#/TrackEvent"
},
{
"properties": {
"event": {
"const": "DatasetDeleted"
}
},
"title": "Specific event properties",
"type": "object"
}
]
},
"SavedQueryCreatedPayload": {
"allOf": [
{
"$ref": "https://eventcatalog.event-catalog.int.otc.fts.d-3.de/schemas/analytics-track.yaml#/TrackEvent"
},
{
"properties": {
"event": {
"const": "SavedQueryCreated"
}
},
"title": "Specific event properties",
"type": "object"
}
]
},
"SqlLabQueryExecutionFailedPayload": {
"allOf": [
{
"$ref": "https://eventcatalog.event-catalog.int.otc.fts.d-3.de/schemas/analytics-track.yaml#/TrackEvent"
},
{
"properties": {
"event": {
"const": "SqlLabQueryExecutionFailed"
}
},
"title": "Specific event properties",
"type": "object"
}
]
},
"SqlLabQueryExecutionSucceededPayload": {
"allOf": [
{
"$ref": "https://eventcatalog.event-catalog.int.otc.fts.d-3.de/schemas/analytics-track.yaml#/TrackEvent"
},
{
"properties": {
"event": {
"const": "SqlLabQueryExecutionSucceeded"
},
"properties": {
"properties": {
"dashboardId": {
"description": "Unique identifier of the dashboard in Superset.",
"example": 12,
"format": "int64",
"type": "integer"
}
},
"type": "object"
}
},
"title": "Specific event properties",
"type": "object"
}
]
}
}
}
}
---
id: analytics-platform.DashboardFavorited
name: DashboardFavorited
version: 1.0.0
summary: "Indicates that a user has favorited a dashboard in Superset"
producers:
- analytics-platform
consumers: []
schemaPath: 'schema.json'
---
# DashboardFavorited
Indicates that a user has favorited a dashboard in Superset
## Base Schema
All analytics events are based on the **TrackEvent** schema which provides common properties like `messageId`, `userId`, `context`, timestamps, and more.
**Base Schema Reference**: [analytics-track.yaml](https://event-catalog.prod.otc.fts.d-3.de/schemas/analytics-track.yaml)
## Event-Specific Properties
This schema shows only the event-specific properties that extend the base TrackEvent schema:
## Raw Schema:schema.json
{
"title": "Event-Specific Properties",
"type": "object",
"description": "Properties specific to this event type (extends BaseEvent)",
"extends": "https://eventcatalog.event-catalog.int.otc.fts.d-3.de/schemas/analytics-track.yaml#/TrackEvent",
"eventType": "DashboardFavorited",
"properties": {
"dashboardId": {
"description": "Unique identifier of the dashboard in Superset.",
"example": 7,
"format": "int64",
"type": "integer"
}
},
"components": {
"schemas": {
"ChartCreatedPayload": {
"allOf": [
{
"$ref": "https://eventcatalog.event-catalog.int.otc.fts.d-3.de/schemas/analytics-track.yaml#/TrackEvent"
},
{
"properties": {
"event": {
"const": "ChartCreated"
}
},
"title": "Specific event properties",
"type": "object"
}
]
},
"ChartDataLoadedPayload": {
"allOf": [
{
"$ref": "https://eventcatalog.event-catalog.int.otc.fts.d-3.de/schemas/analytics-track.yaml#/TrackEvent"
},
{
"properties": {
"event": {
"const": "ChartDataLoaded"
},
"properties": {
"properties": {
"chartId": {
"description": "Unique identifier of the chart in Superset.",
"example": 42,
"format": "int64",
"type": "integer"
},
"dashboardId": {
"description": "Unique identifier of the dashboard in Superset.",
"example": 7,
"format": "int64",
"type": "integer"
},
"vizType": {
"description": "Type of visualization (e.g., bar, line, pie) used in the chart.",
"example": "table",
"type": "string"
}
},
"type": "object"
}
},
"title": "Specific event properties",
"type": "object"
}
]
},
"ChartDeletedPayload": {
"allOf": [
{
"$ref": "https://eventcatalog.event-catalog.int.otc.fts.d-3.de/schemas/analytics-track.yaml#/TrackEvent"
},
{
"properties": {
"event": {
"const": "ChartDeleted"
},
"properties": {
"properties": {
"chartId": {
"description": "Unique identifier of the chart in Superset.",
"example": 42,
"format": "int64",
"type": "integer"
}
},
"type": "object"
}
},
"title": "Specific event properties",
"type": "object"
}
]
},
"ChartFavoritedPayload": {
"allOf": [
{
"$ref": "https://eventcatalog.event-catalog.int.otc.fts.d-3.de/schemas/analytics-track.yaml#/TrackEvent"
},
{
"properties": {
"event": {
"const": "ChartFavorited"
},
"properties": {
"properties": {
"chartId": {
"description": "Unique identifier of the chart in Superset.",
"example": 333,
"format": "int64",
"type": "integer"
}
},
"type": "object"
}
},
"title": "Specific event properties",
"type": "object"
}
]
},
"ChartUnfavoritedPayload": {
"allOf": [
{
"$ref": "https://eventcatalog.event-catalog.int.otc.fts.d-3.de/schemas/analytics-track.yaml#/TrackEvent"
},
{
"properties": {
"event": {
"const": "ChartUnfavorited"
},
"properties": {
"properties": {
"chartId": {
"description": "Unique identifier of the chart in Superset.",
"example": 42,
"format": "int64",
"type": "integer"
}
},
"type": "object"
}
},
"title": "Specific event properties",
"type": "object"
}
]
},
"ChartUpdatedPayload": {
"allOf": [
{
"$ref": "https://eventcatalog.event-catalog.int.otc.fts.d-3.de/schemas/analytics-track.yaml#/TrackEvent"
},
{
"properties": {
"event": {
"const": "ChartUpdated"
},
"properties": {
"properties": {
"chartId": {
"description": "Unique identifier of the chart in Superset.",
"example": 42,
"format": "int64",
"type": "integer"
}
},
"type": "object"
}
},
"title": "Specific event properties",
"type": "object"
}
]
},
"DashboardCreatedPayload": {
"allOf": [
{
"$ref": "https://eventcatalog.event-catalog.int.otc.fts.d-3.de/schemas/analytics-track.yaml#/TrackEvent"
},
{
"properties": {
"event": {
"const": "DashboardCreated"
},
"properties": {
"properties": {
"dashboardId": {
"description": "Unique identifier of the dashboard in Superset.",
"example": 7,
"format": "int64",
"type": "integer"
}
},
"type": "object"
}
},
"title": "Specific event properties",
"type": "object"
}
]
},
"DashboardDeletedPayload": {
"allOf": [
{
"$ref": "https://eventcatalog.event-catalog.int.otc.fts.d-3.de/schemas/analytics-track.yaml#/TrackEvent"
},
{
"properties": {
"event": {
"const": "DashboardDeleted"
},
"properties": {
"properties": {
"dashboardId": {
"description": "Unique identifier of the dashboard in Superset.",
"example": 7,
"format": "int64",
"type": "integer"
}
},
"type": "object"
}
},
"title": "Specific event properties",
"type": "object"
}
]
},
"DashboardFavoritedPayload": {
"allOf": [
{
"$ref": "https://eventcatalog.event-catalog.int.otc.fts.d-3.de/schemas/analytics-track.yaml#/TrackEvent"
},
{
"properties": {
"event": {
"const": "DashboardFavorited"
},
"properties": {
"properties": {
"dashboardId": {
"description": "Unique identifier of the dashboard in Superset.",
"example": 7,
"format": "int64",
"type": "integer"
}
},
"type": "object"
}
},
"title": "Specific event properties",
"type": "object"
}
]
},
"DashboardUnfavoritedPayload": {
"allOf": [
{
"$ref": "https://eventcatalog.event-catalog.int.otc.fts.d-3.de/schemas/analytics-track.yaml#/TrackEvent"
},
{
"properties": {
"event": {
"const": "DashboardUnfavorited"
},
"properties": {
"properties": {
"dashboardId": {
"description": "Unique identifier of the dashboard in Superset.",
"example": 7,
"format": "int64",
"type": "integer"
}
},
"type": "object"
}
},
"title": "Specific event properties",
"type": "object"
}
]
},
"DashboardUpdatedPayload": {
"allOf": [
{
"$ref": "https://eventcatalog.event-catalog.int.otc.fts.d-3.de/schemas/analytics-track.yaml#/TrackEvent"
},
{
"properties": {
"event": {
"const": "DashboardUpdated"
},
"properties": {
"properties": {
"dashboardId": {
"description": "Unique identifier of the dashboard in Superset.",
"example": 7,
"format": "int64",
"type": "integer"
}
},
"type": "object"
}
},
"title": "Specific event properties",
"type": "object"
}
]
},
"DashboardViewedPayload": {
"allOf": [
{
"$ref": "https://eventcatalog.event-catalog.int.otc.fts.d-3.de/schemas/analytics-track.yaml#/TrackEvent"
},
{
"properties": {
"event": {
"const": "DashboardViewed"
},
"properties": {
"properties": {
"dashboardId": {
"description": "Unique identifier of the dashboard in Superset.",
"example": 7,
"format": "int64",
"type": "integer"
}
},
"type": "object"
}
},
"title": "Specific event properties",
"type": "object"
}
]
},
"DatasetCreatedPayload": {
"allOf": [
{
"$ref": "https://eventcatalog.event-catalog.int.otc.fts.d-3.de/schemas/analytics-track.yaml#/TrackEvent"
},
{
"properties": {
"event": {
"const": "DatasetCreated"
}
},
"title": "Specific event properties",
"type": "object"
}
]
},
"DatasetDeletedPayload": {
"allOf": [
{
"$ref": "https://eventcatalog.event-catalog.int.otc.fts.d-3.de/schemas/analytics-track.yaml#/TrackEvent"
},
{
"properties": {
"event": {
"const": "DatasetDeleted"
}
},
"title": "Specific event properties",
"type": "object"
}
]
},
"SavedQueryCreatedPayload": {
"allOf": [
{
"$ref": "https://eventcatalog.event-catalog.int.otc.fts.d-3.de/schemas/analytics-track.yaml#/TrackEvent"
},
{
"properties": {
"event": {
"const": "SavedQueryCreated"
}
},
"title": "Specific event properties",
"type": "object"
}
]
},
"SqlLabQueryExecutionFailedPayload": {
"allOf": [
{
"$ref": "https://eventcatalog.event-catalog.int.otc.fts.d-3.de/schemas/analytics-track.yaml#/TrackEvent"
},
{
"properties": {
"event": {
"const": "SqlLabQueryExecutionFailed"
}
},
"title": "Specific event properties",
"type": "object"
}
]
},
"SqlLabQueryExecutionSucceededPayload": {
"allOf": [
{
"$ref": "https://eventcatalog.event-catalog.int.otc.fts.d-3.de/schemas/analytics-track.yaml#/TrackEvent"
},
{
"properties": {
"event": {
"const": "SqlLabQueryExecutionSucceeded"
},
"properties": {
"properties": {
"dashboardId": {
"description": "Unique identifier of the dashboard in Superset.",
"example": 12,
"format": "int64",
"type": "integer"
}
},
"type": "object"
}
},
"title": "Specific event properties",
"type": "object"
}
]
}
}
}
}
---
id: analytics-platform.DashboardUnfavorited
name: DashboardUnfavorited
version: 1.0.0
summary: "Indicates that a user has unfavorited a dashboard in Superset"
producers:
- analytics-platform
consumers: []
schemaPath: 'schema.json'
---
# DashboardUnfavorited
Indicates that a user has unfavorited a dashboard in Superset
## Base Schema
All analytics events are based on the **TrackEvent** schema which provides common properties like `messageId`, `userId`, `context`, timestamps, and more.
**Base Schema Reference**: [analytics-track.yaml](https://event-catalog.prod.otc.fts.d-3.de/schemas/analytics-track.yaml)
## Event-Specific Properties
This schema shows only the event-specific properties that extend the base TrackEvent schema:
## Raw Schema:schema.json
{
"title": "Event-Specific Properties",
"type": "object",
"description": "Properties specific to this event type (extends BaseEvent)",
"extends": "https://eventcatalog.event-catalog.int.otc.fts.d-3.de/schemas/analytics-track.yaml#/TrackEvent",
"eventType": "DashboardUnfavorited",
"properties": {
"dashboardId": {
"description": "Unique identifier of the dashboard in Superset.",
"example": 7,
"format": "int64",
"type": "integer"
}
},
"components": {
"schemas": {
"ChartCreatedPayload": {
"allOf": [
{
"$ref": "https://eventcatalog.event-catalog.int.otc.fts.d-3.de/schemas/analytics-track.yaml#/TrackEvent"
},
{
"properties": {
"event": {
"const": "ChartCreated"
}
},
"title": "Specific event properties",
"type": "object"
}
]
},
"ChartDataLoadedPayload": {
"allOf": [
{
"$ref": "https://eventcatalog.event-catalog.int.otc.fts.d-3.de/schemas/analytics-track.yaml#/TrackEvent"
},
{
"properties": {
"event": {
"const": "ChartDataLoaded"
},
"properties": {
"properties": {
"chartId": {
"description": "Unique identifier of the chart in Superset.",
"example": 42,
"format": "int64",
"type": "integer"
},
"dashboardId": {
"description": "Unique identifier of the dashboard in Superset.",
"example": 7,
"format": "int64",
"type": "integer"
},
"vizType": {
"description": "Type of visualization (e.g., bar, line, pie) used in the chart.",
"example": "table",
"type": "string"
}
},
"type": "object"
}
},
"title": "Specific event properties",
"type": "object"
}
]
},
"ChartDeletedPayload": {
"allOf": [
{
"$ref": "https://eventcatalog.event-catalog.int.otc.fts.d-3.de/schemas/analytics-track.yaml#/TrackEvent"
},
{
"properties": {
"event": {
"const": "ChartDeleted"
},
"properties": {
"properties": {
"chartId": {
"description": "Unique identifier of the chart in Superset.",
"example": 42,
"format": "int64",
"type": "integer"
}
},
"type": "object"
}
},
"title": "Specific event properties",
"type": "object"
}
]
},
"ChartFavoritedPayload": {
"allOf": [
{
"$ref": "https://eventcatalog.event-catalog.int.otc.fts.d-3.de/schemas/analytics-track.yaml#/TrackEvent"
},
{
"properties": {
"event": {
"const": "ChartFavorited"
},
"properties": {
"properties": {
"chartId": {
"description": "Unique identifier of the chart in Superset.",
"example": 333,
"format": "int64",
"type": "integer"
}
},
"type": "object"
}
},
"title": "Specific event properties",
"type": "object"
}
]
},
"ChartUnfavoritedPayload": {
"allOf": [
{
"$ref": "https://eventcatalog.event-catalog.int.otc.fts.d-3.de/schemas/analytics-track.yaml#/TrackEvent"
},
{
"properties": {
"event": {
"const": "ChartUnfavorited"
},
"properties": {
"properties": {
"chartId": {
"description": "Unique identifier of the chart in Superset.",
"example": 42,
"format": "int64",
"type": "integer"
}
},
"type": "object"
}
},
"title": "Specific event properties",
"type": "object"
}
]
},
"ChartUpdatedPayload": {
"allOf": [
{
"$ref": "https://eventcatalog.event-catalog.int.otc.fts.d-3.de/schemas/analytics-track.yaml#/TrackEvent"
},
{
"properties": {
"event": {
"const": "ChartUpdated"
},
"properties": {
"properties": {
"chartId": {
"description": "Unique identifier of the chart in Superset.",
"example": 42,
"format": "int64",
"type": "integer"
}
},
"type": "object"
}
},
"title": "Specific event properties",
"type": "object"
}
]
},
"DashboardCreatedPayload": {
"allOf": [
{
"$ref": "https://eventcatalog.event-catalog.int.otc.fts.d-3.de/schemas/analytics-track.yaml#/TrackEvent"
},
{
"properties": {
"event": {
"const": "DashboardCreated"
},
"properties": {
"properties": {
"dashboardId": {
"description": "Unique identifier of the dashboard in Superset.",
"example": 7,
"format": "int64",
"type": "integer"
}
},
"type": "object"
}
},
"title": "Specific event properties",
"type": "object"
}
]
},
"DashboardDeletedPayload": {
"allOf": [
{
"$ref": "https://eventcatalog.event-catalog.int.otc.fts.d-3.de/schemas/analytics-track.yaml#/TrackEvent"
},
{
"properties": {
"event": {
"const": "DashboardDeleted"
},
"properties": {
"properties": {
"dashboardId": {
"description": "Unique identifier of the dashboard in Superset.",
"example": 7,
"format": "int64",
"type": "integer"
}
},
"type": "object"
}
},
"title": "Specific event properties",
"type": "object"
}
]
},
"DashboardFavoritedPayload": {
"allOf": [
{
"$ref": "https://eventcatalog.event-catalog.int.otc.fts.d-3.de/schemas/analytics-track.yaml#/TrackEvent"
},
{
"properties": {
"event": {
"const": "DashboardFavorited"
},
"properties": {
"properties": {
"dashboardId": {
"description": "Unique identifier of the dashboard in Superset.",
"example": 7,
"format": "int64",
"type": "integer"
}
},
"type": "object"
}
},
"title": "Specific event properties",
"type": "object"
}
]
},
"DashboardUnfavoritedPayload": {
"allOf": [
{
"$ref": "https://eventcatalog.event-catalog.int.otc.fts.d-3.de/schemas/analytics-track.yaml#/TrackEvent"
},
{
"properties": {
"event": {
"const": "DashboardUnfavorited"
},
"properties": {
"properties": {
"dashboardId": {
"description": "Unique identifier of the dashboard in Superset.",
"example": 7,
"format": "int64",
"type": "integer"
}
},
"type": "object"
}
},
"title": "Specific event properties",
"type": "object"
}
]
},
"DashboardUpdatedPayload": {
"allOf": [
{
"$ref": "https://eventcatalog.event-catalog.int.otc.fts.d-3.de/schemas/analytics-track.yaml#/TrackEvent"
},
{
"properties": {
"event": {
"const": "DashboardUpdated"
},
"properties": {
"properties": {
"dashboardId": {
"description": "Unique identifier of the dashboard in Superset.",
"example": 7,
"format": "int64",
"type": "integer"
}
},
"type": "object"
}
},
"title": "Specific event properties",
"type": "object"
}
]
},
"DashboardViewedPayload": {
"allOf": [
{
"$ref": "https://eventcatalog.event-catalog.int.otc.fts.d-3.de/schemas/analytics-track.yaml#/TrackEvent"
},
{
"properties": {
"event": {
"const": "DashboardViewed"
},
"properties": {
"properties": {
"dashboardId": {
"description": "Unique identifier of the dashboard in Superset.",
"example": 7,
"format": "int64",
"type": "integer"
}
},
"type": "object"
}
},
"title": "Specific event properties",
"type": "object"
}
]
},
"DatasetCreatedPayload": {
"allOf": [
{
"$ref": "https://eventcatalog.event-catalog.int.otc.fts.d-3.de/schemas/analytics-track.yaml#/TrackEvent"
},
{
"properties": {
"event": {
"const": "DatasetCreated"
}
},
"title": "Specific event properties",
"type": "object"
}
]
},
"DatasetDeletedPayload": {
"allOf": [
{
"$ref": "https://eventcatalog.event-catalog.int.otc.fts.d-3.de/schemas/analytics-track.yaml#/TrackEvent"
},
{
"properties": {
"event": {
"const": "DatasetDeleted"
}
},
"title": "Specific event properties",
"type": "object"
}
]
},
"SavedQueryCreatedPayload": {
"allOf": [
{
"$ref": "https://eventcatalog.event-catalog.int.otc.fts.d-3.de/schemas/analytics-track.yaml#/TrackEvent"
},
{
"properties": {
"event": {
"const": "SavedQueryCreated"
}
},
"title": "Specific event properties",
"type": "object"
}
]
},
"SqlLabQueryExecutionFailedPayload": {
"allOf": [
{
"$ref": "https://eventcatalog.event-catalog.int.otc.fts.d-3.de/schemas/analytics-track.yaml#/TrackEvent"
},
{
"properties": {
"event": {
"const": "SqlLabQueryExecutionFailed"
}
},
"title": "Specific event properties",
"type": "object"
}
]
},
"SqlLabQueryExecutionSucceededPayload": {
"allOf": [
{
"$ref": "https://eventcatalog.event-catalog.int.otc.fts.d-3.de/schemas/analytics-track.yaml#/TrackEvent"
},
{
"properties": {
"event": {
"const": "SqlLabQueryExecutionSucceeded"
},
"properties": {
"properties": {
"dashboardId": {
"description": "Unique identifier of the dashboard in Superset.",
"example": 12,
"format": "int64",
"type": "integer"
}
},
"type": "object"
}
},
"title": "Specific event properties",
"type": "object"
}
]
}
}
}
}
---
id: analytics-platform.DashboardUpdated
name: DashboardUpdated
version: 1.0.0
summary: "Indicates that a user has updated a dashboard in Superset"
producers:
- analytics-platform
consumers: []
schemaPath: 'schema.json'
---
# DashboardUpdated
Indicates that a user has updated a dashboard in Superset
## Base Schema
All analytics events are based on the **TrackEvent** schema which provides common properties like `messageId`, `userId`, `context`, timestamps, and more.
**Base Schema Reference**: [analytics-track.yaml](https://event-catalog.prod.otc.fts.d-3.de/schemas/analytics-track.yaml)
## Event-Specific Properties
This schema shows only the event-specific properties that extend the base TrackEvent schema:
## Raw Schema:schema.json
{
"title": "Event-Specific Properties",
"type": "object",
"description": "Properties specific to this event type (extends BaseEvent)",
"extends": "https://eventcatalog.event-catalog.int.otc.fts.d-3.de/schemas/analytics-track.yaml#/TrackEvent",
"eventType": "DashboardUpdated",
"properties": {
"dashboardId": {
"description": "Unique identifier of the dashboard in Superset.",
"example": 7,
"format": "int64",
"type": "integer"
}
},
"components": {
"schemas": {
"ChartCreatedPayload": {
"allOf": [
{
"$ref": "https://eventcatalog.event-catalog.int.otc.fts.d-3.de/schemas/analytics-track.yaml#/TrackEvent"
},
{
"properties": {
"event": {
"const": "ChartCreated"
}
},
"title": "Specific event properties",
"type": "object"
}
]
},
"ChartDataLoadedPayload": {
"allOf": [
{
"$ref": "https://eventcatalog.event-catalog.int.otc.fts.d-3.de/schemas/analytics-track.yaml#/TrackEvent"
},
{
"properties": {
"event": {
"const": "ChartDataLoaded"
},
"properties": {
"properties": {
"chartId": {
"description": "Unique identifier of the chart in Superset.",
"example": 42,
"format": "int64",
"type": "integer"
},
"dashboardId": {
"description": "Unique identifier of the dashboard in Superset.",
"example": 7,
"format": "int64",
"type": "integer"
},
"vizType": {
"description": "Type of visualization (e.g., bar, line, pie) used in the chart.",
"example": "table",
"type": "string"
}
},
"type": "object"
}
},
"title": "Specific event properties",
"type": "object"
}
]
},
"ChartDeletedPayload": {
"allOf": [
{
"$ref": "https://eventcatalog.event-catalog.int.otc.fts.d-3.de/schemas/analytics-track.yaml#/TrackEvent"
},
{
"properties": {
"event": {
"const": "ChartDeleted"
},
"properties": {
"properties": {
"chartId": {
"description": "Unique identifier of the chart in Superset.",
"example": 42,
"format": "int64",
"type": "integer"
}
},
"type": "object"
}
},
"title": "Specific event properties",
"type": "object"
}
]
},
"ChartFavoritedPayload": {
"allOf": [
{
"$ref": "https://eventcatalog.event-catalog.int.otc.fts.d-3.de/schemas/analytics-track.yaml#/TrackEvent"
},
{
"properties": {
"event": {
"const": "ChartFavorited"
},
"properties": {
"properties": {
"chartId": {
"description": "Unique identifier of the chart in Superset.",
"example": 333,
"format": "int64",
"type": "integer"
}
},
"type": "object"
}
},
"title": "Specific event properties",
"type": "object"
}
]
},
"ChartUnfavoritedPayload": {
"allOf": [
{
"$ref": "https://eventcatalog.event-catalog.int.otc.fts.d-3.de/schemas/analytics-track.yaml#/TrackEvent"
},
{
"properties": {
"event": {
"const": "ChartUnfavorited"
},
"properties": {
"properties": {
"chartId": {
"description": "Unique identifier of the chart in Superset.",
"example": 42,
"format": "int64",
"type": "integer"
}
},
"type": "object"
}
},
"title": "Specific event properties",
"type": "object"
}
]
},
"ChartUpdatedPayload": {
"allOf": [
{
"$ref": "https://eventcatalog.event-catalog.int.otc.fts.d-3.de/schemas/analytics-track.yaml#/TrackEvent"
},
{
"properties": {
"event": {
"const": "ChartUpdated"
},
"properties": {
"properties": {
"chartId": {
"description": "Unique identifier of the chart in Superset.",
"example": 42,
"format": "int64",
"type": "integer"
}
},
"type": "object"
}
},
"title": "Specific event properties",
"type": "object"
}
]
},
"DashboardCreatedPayload": {
"allOf": [
{
"$ref": "https://eventcatalog.event-catalog.int.otc.fts.d-3.de/schemas/analytics-track.yaml#/TrackEvent"
},
{
"properties": {
"event": {
"const": "DashboardCreated"
},
"properties": {
"properties": {
"dashboardId": {
"description": "Unique identifier of the dashboard in Superset.",
"example": 7,
"format": "int64",
"type": "integer"
}
},
"type": "object"
}
},
"title": "Specific event properties",
"type": "object"
}
]
},
"DashboardDeletedPayload": {
"allOf": [
{
"$ref": "https://eventcatalog.event-catalog.int.otc.fts.d-3.de/schemas/analytics-track.yaml#/TrackEvent"
},
{
"properties": {
"event": {
"const": "DashboardDeleted"
},
"properties": {
"properties": {
"dashboardId": {
"description": "Unique identifier of the dashboard in Superset.",
"example": 7,
"format": "int64",
"type": "integer"
}
},
"type": "object"
}
},
"title": "Specific event properties",
"type": "object"
}
]
},
"DashboardFavoritedPayload": {
"allOf": [
{
"$ref": "https://eventcatalog.event-catalog.int.otc.fts.d-3.de/schemas/analytics-track.yaml#/TrackEvent"
},
{
"properties": {
"event": {
"const": "DashboardFavorited"
},
"properties": {
"properties": {
"dashboardId": {
"description": "Unique identifier of the dashboard in Superset.",
"example": 7,
"format": "int64",
"type": "integer"
}
},
"type": "object"
}
},
"title": "Specific event properties",
"type": "object"
}
]
},
"DashboardUnfavoritedPayload": {
"allOf": [
{
"$ref": "https://eventcatalog.event-catalog.int.otc.fts.d-3.de/schemas/analytics-track.yaml#/TrackEvent"
},
{
"properties": {
"event": {
"const": "DashboardUnfavorited"
},
"properties": {
"properties": {
"dashboardId": {
"description": "Unique identifier of the dashboard in Superset.",
"example": 7,
"format": "int64",
"type": "integer"
}
},
"type": "object"
}
},
"title": "Specific event properties",
"type": "object"
}
]
},
"DashboardUpdatedPayload": {
"allOf": [
{
"$ref": "https://eventcatalog.event-catalog.int.otc.fts.d-3.de/schemas/analytics-track.yaml#/TrackEvent"
},
{
"properties": {
"event": {
"const": "DashboardUpdated"
},
"properties": {
"properties": {
"dashboardId": {
"description": "Unique identifier of the dashboard in Superset.",
"example": 7,
"format": "int64",
"type": "integer"
}
},
"type": "object"
}
},
"title": "Specific event properties",
"type": "object"
}
]
},
"DashboardViewedPayload": {
"allOf": [
{
"$ref": "https://eventcatalog.event-catalog.int.otc.fts.d-3.de/schemas/analytics-track.yaml#/TrackEvent"
},
{
"properties": {
"event": {
"const": "DashboardViewed"
},
"properties": {
"properties": {
"dashboardId": {
"description": "Unique identifier of the dashboard in Superset.",
"example": 7,
"format": "int64",
"type": "integer"
}
},
"type": "object"
}
},
"title": "Specific event properties",
"type": "object"
}
]
},
"DatasetCreatedPayload": {
"allOf": [
{
"$ref": "https://eventcatalog.event-catalog.int.otc.fts.d-3.de/schemas/analytics-track.yaml#/TrackEvent"
},
{
"properties": {
"event": {
"const": "DatasetCreated"
}
},
"title": "Specific event properties",
"type": "object"
}
]
},
"DatasetDeletedPayload": {
"allOf": [
{
"$ref": "https://eventcatalog.event-catalog.int.otc.fts.d-3.de/schemas/analytics-track.yaml#/TrackEvent"
},
{
"properties": {
"event": {
"const": "DatasetDeleted"
}
},
"title": "Specific event properties",
"type": "object"
}
]
},
"SavedQueryCreatedPayload": {
"allOf": [
{
"$ref": "https://eventcatalog.event-catalog.int.otc.fts.d-3.de/schemas/analytics-track.yaml#/TrackEvent"
},
{
"properties": {
"event": {
"const": "SavedQueryCreated"
}
},
"title": "Specific event properties",
"type": "object"
}
]
},
"SqlLabQueryExecutionFailedPayload": {
"allOf": [
{
"$ref": "https://eventcatalog.event-catalog.int.otc.fts.d-3.de/schemas/analytics-track.yaml#/TrackEvent"
},
{
"properties": {
"event": {
"const": "SqlLabQueryExecutionFailed"
}
},
"title": "Specific event properties",
"type": "object"
}
]
},
"SqlLabQueryExecutionSucceededPayload": {
"allOf": [
{
"$ref": "https://eventcatalog.event-catalog.int.otc.fts.d-3.de/schemas/analytics-track.yaml#/TrackEvent"
},
{
"properties": {
"event": {
"const": "SqlLabQueryExecutionSucceeded"
},
"properties": {
"properties": {
"dashboardId": {
"description": "Unique identifier of the dashboard in Superset.",
"example": 12,
"format": "int64",
"type": "integer"
}
},
"type": "object"
}
},
"title": "Specific event properties",
"type": "object"
}
]
}
}
}
}
---
id: analytics-platform.DashboardViewed
name: DashboardViewed
version: 1.0.0
summary: "Indicates that a user has viewed a dashboard in Superset"
producers:
- analytics-platform
consumers: []
schemaPath: 'schema.json'
---
# DashboardViewed
Indicates that a user has viewed a dashboard in Superset
## Base Schema
All analytics events are based on the **TrackEvent** schema which provides common properties like `messageId`, `userId`, `context`, timestamps, and more.
**Base Schema Reference**: [analytics-track.yaml](https://event-catalog.prod.otc.fts.d-3.de/schemas/analytics-track.yaml)
## Event-Specific Properties
This schema shows only the event-specific properties that extend the base TrackEvent schema:
## Raw Schema:schema.json
{
"title": "Event-Specific Properties",
"type": "object",
"description": "Properties specific to this event type (extends BaseEvent)",
"extends": "https://eventcatalog.event-catalog.int.otc.fts.d-3.de/schemas/analytics-track.yaml#/TrackEvent",
"eventType": "DashboardViewed",
"properties": {
"dashboardId": {
"description": "Unique identifier of the dashboard in Superset.",
"example": 7,
"format": "int64",
"type": "integer"
}
},
"components": {
"schemas": {
"ChartCreatedPayload": {
"allOf": [
{
"$ref": "https://eventcatalog.event-catalog.int.otc.fts.d-3.de/schemas/analytics-track.yaml#/TrackEvent"
},
{
"properties": {
"event": {
"const": "ChartCreated"
}
},
"title": "Specific event properties",
"type": "object"
}
]
},
"ChartDataLoadedPayload": {
"allOf": [
{
"$ref": "https://eventcatalog.event-catalog.int.otc.fts.d-3.de/schemas/analytics-track.yaml#/TrackEvent"
},
{
"properties": {
"event": {
"const": "ChartDataLoaded"
},
"properties": {
"properties": {
"chartId": {
"description": "Unique identifier of the chart in Superset.",
"example": 42,
"format": "int64",
"type": "integer"
},
"dashboardId": {
"description": "Unique identifier of the dashboard in Superset.",
"example": 7,
"format": "int64",
"type": "integer"
},
"vizType": {
"description": "Type of visualization (e.g., bar, line, pie) used in the chart.",
"example": "table",
"type": "string"
}
},
"type": "object"
}
},
"title": "Specific event properties",
"type": "object"
}
]
},
"ChartDeletedPayload": {
"allOf": [
{
"$ref": "https://eventcatalog.event-catalog.int.otc.fts.d-3.de/schemas/analytics-track.yaml#/TrackEvent"
},
{
"properties": {
"event": {
"const": "ChartDeleted"
},
"properties": {
"properties": {
"chartId": {
"description": "Unique identifier of the chart in Superset.",
"example": 42,
"format": "int64",
"type": "integer"
}
},
"type": "object"
}
},
"title": "Specific event properties",
"type": "object"
}
]
},
"ChartFavoritedPayload": {
"allOf": [
{
"$ref": "https://eventcatalog.event-catalog.int.otc.fts.d-3.de/schemas/analytics-track.yaml#/TrackEvent"
},
{
"properties": {
"event": {
"const": "ChartFavorited"
},
"properties": {
"properties": {
"chartId": {
"description": "Unique identifier of the chart in Superset.",
"example": 333,
"format": "int64",
"type": "integer"
}
},
"type": "object"
}
},
"title": "Specific event properties",
"type": "object"
}
]
},
"ChartUnfavoritedPayload": {
"allOf": [
{
"$ref": "https://eventcatalog.event-catalog.int.otc.fts.d-3.de/schemas/analytics-track.yaml#/TrackEvent"
},
{
"properties": {
"event": {
"const": "ChartUnfavorited"
},
"properties": {
"properties": {
"chartId": {
"description": "Unique identifier of the chart in Superset.",
"example": 42,
"format": "int64",
"type": "integer"
}
},
"type": "object"
}
},
"title": "Specific event properties",
"type": "object"
}
]
},
"ChartUpdatedPayload": {
"allOf": [
{
"$ref": "https://eventcatalog.event-catalog.int.otc.fts.d-3.de/schemas/analytics-track.yaml#/TrackEvent"
},
{
"properties": {
"event": {
"const": "ChartUpdated"
},
"properties": {
"properties": {
"chartId": {
"description": "Unique identifier of the chart in Superset.",
"example": 42,
"format": "int64",
"type": "integer"
}
},
"type": "object"
}
},
"title": "Specific event properties",
"type": "object"
}
]
},
"DashboardCreatedPayload": {
"allOf": [
{
"$ref": "https://eventcatalog.event-catalog.int.otc.fts.d-3.de/schemas/analytics-track.yaml#/TrackEvent"
},
{
"properties": {
"event": {
"const": "DashboardCreated"
},
"properties": {
"properties": {
"dashboardId": {
"description": "Unique identifier of the dashboard in Superset.",
"example": 7,
"format": "int64",
"type": "integer"
}
},
"type": "object"
}
},
"title": "Specific event properties",
"type": "object"
}
]
},
"DashboardDeletedPayload": {
"allOf": [
{
"$ref": "https://eventcatalog.event-catalog.int.otc.fts.d-3.de/schemas/analytics-track.yaml#/TrackEvent"
},
{
"properties": {
"event": {
"const": "DashboardDeleted"
},
"properties": {
"properties": {
"dashboardId": {
"description": "Unique identifier of the dashboard in Superset.",
"example": 7,
"format": "int64",
"type": "integer"
}
},
"type": "object"
}
},
"title": "Specific event properties",
"type": "object"
}
]
},
"DashboardFavoritedPayload": {
"allOf": [
{
"$ref": "https://eventcatalog.event-catalog.int.otc.fts.d-3.de/schemas/analytics-track.yaml#/TrackEvent"
},
{
"properties": {
"event": {
"const": "DashboardFavorited"
},
"properties": {
"properties": {
"dashboardId": {
"description": "Unique identifier of the dashboard in Superset.",
"example": 7,
"format": "int64",
"type": "integer"
}
},
"type": "object"
}
},
"title": "Specific event properties",
"type": "object"
}
]
},
"DashboardUnfavoritedPayload": {
"allOf": [
{
"$ref": "https://eventcatalog.event-catalog.int.otc.fts.d-3.de/schemas/analytics-track.yaml#/TrackEvent"
},
{
"properties": {
"event": {
"const": "DashboardUnfavorited"
},
"properties": {
"properties": {
"dashboardId": {
"description": "Unique identifier of the dashboard in Superset.",
"example": 7,
"format": "int64",
"type": "integer"
}
},
"type": "object"
}
},
"title": "Specific event properties",
"type": "object"
}
]
},
"DashboardUpdatedPayload": {
"allOf": [
{
"$ref": "https://eventcatalog.event-catalog.int.otc.fts.d-3.de/schemas/analytics-track.yaml#/TrackEvent"
},
{
"properties": {
"event": {
"const": "DashboardUpdated"
},
"properties": {
"properties": {
"dashboardId": {
"description": "Unique identifier of the dashboard in Superset.",
"example": 7,
"format": "int64",
"type": "integer"
}
},
"type": "object"
}
},
"title": "Specific event properties",
"type": "object"
}
]
},
"DashboardViewedPayload": {
"allOf": [
{
"$ref": "https://eventcatalog.event-catalog.int.otc.fts.d-3.de/schemas/analytics-track.yaml#/TrackEvent"
},
{
"properties": {
"event": {
"const": "DashboardViewed"
},
"properties": {
"properties": {
"dashboardId": {
"description": "Unique identifier of the dashboard in Superset.",
"example": 7,
"format": "int64",
"type": "integer"
}
},
"type": "object"
}
},
"title": "Specific event properties",
"type": "object"
}
]
},
"DatasetCreatedPayload": {
"allOf": [
{
"$ref": "https://eventcatalog.event-catalog.int.otc.fts.d-3.de/schemas/analytics-track.yaml#/TrackEvent"
},
{
"properties": {
"event": {
"const": "DatasetCreated"
}
},
"title": "Specific event properties",
"type": "object"
}
]
},
"DatasetDeletedPayload": {
"allOf": [
{
"$ref": "https://eventcatalog.event-catalog.int.otc.fts.d-3.de/schemas/analytics-track.yaml#/TrackEvent"
},
{
"properties": {
"event": {
"const": "DatasetDeleted"
}
},
"title": "Specific event properties",
"type": "object"
}
]
},
"SavedQueryCreatedPayload": {
"allOf": [
{
"$ref": "https://eventcatalog.event-catalog.int.otc.fts.d-3.de/schemas/analytics-track.yaml#/TrackEvent"
},
{
"properties": {
"event": {
"const": "SavedQueryCreated"
}
},
"title": "Specific event properties",
"type": "object"
}
]
},
"SqlLabQueryExecutionFailedPayload": {
"allOf": [
{
"$ref": "https://eventcatalog.event-catalog.int.otc.fts.d-3.de/schemas/analytics-track.yaml#/TrackEvent"
},
{
"properties": {
"event": {
"const": "SqlLabQueryExecutionFailed"
}
},
"title": "Specific event properties",
"type": "object"
}
]
},
"SqlLabQueryExecutionSucceededPayload": {
"allOf": [
{
"$ref": "https://eventcatalog.event-catalog.int.otc.fts.d-3.de/schemas/analytics-track.yaml#/TrackEvent"
},
{
"properties": {
"event": {
"const": "SqlLabQueryExecutionSucceeded"
},
"properties": {
"properties": {
"dashboardId": {
"description": "Unique identifier of the dashboard in Superset.",
"example": 12,
"format": "int64",
"type": "integer"
}
},
"type": "object"
}
},
"title": "Specific event properties",
"type": "object"
}
]
}
}
}
}
---
id: analytics-platform.DatasetCreated
name: DatasetCreated
version: 1.0.0
summary: "Indicates that a user has created a dataset in Superset"
producers:
- analytics-platform
consumers: []
schemaPath: 'schema.json'
---
# DatasetCreated
Indicates that a user has created a dataset in Superset
## Base Schema
All analytics events are based on the **TrackEvent** schema which provides common properties like `messageId`, `userId`, `context`, timestamps, and more.
**Base Schema Reference**: [analytics-track.yaml](https://event-catalog.prod.otc.fts.d-3.de/schemas/analytics-track.yaml)
## Event-Specific Properties
This schema shows only the event-specific properties that extend the base TrackEvent schema:
## Raw Schema:schema.json
{
"title": "Event-Specific Properties",
"type": "object",
"description": "Properties specific to this event type (extends BaseEvent)",
"extends": "https://eventcatalog.event-catalog.int.otc.fts.d-3.de/schemas/analytics-track.yaml#/TrackEvent",
"eventType": "DatasetCreated",
"properties": {},
"note": "This event uses only BaseEvent properties with no additional event-specific properties",
"components": {
"schemas": {
"ChartCreatedPayload": {
"allOf": [
{
"$ref": "https://eventcatalog.event-catalog.int.otc.fts.d-3.de/schemas/analytics-track.yaml#/TrackEvent"
},
{
"properties": {
"event": {
"const": "ChartCreated"
}
},
"title": "Specific event properties",
"type": "object"
}
]
},
"ChartDataLoadedPayload": {
"allOf": [
{
"$ref": "https://eventcatalog.event-catalog.int.otc.fts.d-3.de/schemas/analytics-track.yaml#/TrackEvent"
},
{
"properties": {
"event": {
"const": "ChartDataLoaded"
},
"properties": {
"properties": {
"chartId": {
"description": "Unique identifier of the chart in Superset.",
"example": 42,
"format": "int64",
"type": "integer"
},
"dashboardId": {
"description": "Unique identifier of the dashboard in Superset.",
"example": 7,
"format": "int64",
"type": "integer"
},
"vizType": {
"description": "Type of visualization (e.g., bar, line, pie) used in the chart.",
"example": "table",
"type": "string"
}
},
"type": "object"
}
},
"title": "Specific event properties",
"type": "object"
}
]
},
"ChartDeletedPayload": {
"allOf": [
{
"$ref": "https://eventcatalog.event-catalog.int.otc.fts.d-3.de/schemas/analytics-track.yaml#/TrackEvent"
},
{
"properties": {
"event": {
"const": "ChartDeleted"
},
"properties": {
"properties": {
"chartId": {
"description": "Unique identifier of the chart in Superset.",
"example": 42,
"format": "int64",
"type": "integer"
}
},
"type": "object"
}
},
"title": "Specific event properties",
"type": "object"
}
]
},
"ChartFavoritedPayload": {
"allOf": [
{
"$ref": "https://eventcatalog.event-catalog.int.otc.fts.d-3.de/schemas/analytics-track.yaml#/TrackEvent"
},
{
"properties": {
"event": {
"const": "ChartFavorited"
},
"properties": {
"properties": {
"chartId": {
"description": "Unique identifier of the chart in Superset.",
"example": 333,
"format": "int64",
"type": "integer"
}
},
"type": "object"
}
},
"title": "Specific event properties",
"type": "object"
}
]
},
"ChartUnfavoritedPayload": {
"allOf": [
{
"$ref": "https://eventcatalog.event-catalog.int.otc.fts.d-3.de/schemas/analytics-track.yaml#/TrackEvent"
},
{
"properties": {
"event": {
"const": "ChartUnfavorited"
},
"properties": {
"properties": {
"chartId": {
"description": "Unique identifier of the chart in Superset.",
"example": 42,
"format": "int64",
"type": "integer"
}
},
"type": "object"
}
},
"title": "Specific event properties",
"type": "object"
}
]
},
"ChartUpdatedPayload": {
"allOf": [
{
"$ref": "https://eventcatalog.event-catalog.int.otc.fts.d-3.de/schemas/analytics-track.yaml#/TrackEvent"
},
{
"properties": {
"event": {
"const": "ChartUpdated"
},
"properties": {
"properties": {
"chartId": {
"description": "Unique identifier of the chart in Superset.",
"example": 42,
"format": "int64",
"type": "integer"
}
},
"type": "object"
}
},
"title": "Specific event properties",
"type": "object"
}
]
},
"DashboardCreatedPayload": {
"allOf": [
{
"$ref": "https://eventcatalog.event-catalog.int.otc.fts.d-3.de/schemas/analytics-track.yaml#/TrackEvent"
},
{
"properties": {
"event": {
"const": "DashboardCreated"
},
"properties": {
"properties": {
"dashboardId": {
"description": "Unique identifier of the dashboard in Superset.",
"example": 7,
"format": "int64",
"type": "integer"
}
},
"type": "object"
}
},
"title": "Specific event properties",
"type": "object"
}
]
},
"DashboardDeletedPayload": {
"allOf": [
{
"$ref": "https://eventcatalog.event-catalog.int.otc.fts.d-3.de/schemas/analytics-track.yaml#/TrackEvent"
},
{
"properties": {
"event": {
"const": "DashboardDeleted"
},
"properties": {
"properties": {
"dashboardId": {
"description": "Unique identifier of the dashboard in Superset.",
"example": 7,
"format": "int64",
"type": "integer"
}
},
"type": "object"
}
},
"title": "Specific event properties",
"type": "object"
}
]
},
"DashboardFavoritedPayload": {
"allOf": [
{
"$ref": "https://eventcatalog.event-catalog.int.otc.fts.d-3.de/schemas/analytics-track.yaml#/TrackEvent"
},
{
"properties": {
"event": {
"const": "DashboardFavorited"
},
"properties": {
"properties": {
"dashboardId": {
"description": "Unique identifier of the dashboard in Superset.",
"example": 7,
"format": "int64",
"type": "integer"
}
},
"type": "object"
}
},
"title": "Specific event properties",
"type": "object"
}
]
},
"DashboardUnfavoritedPayload": {
"allOf": [
{
"$ref": "https://eventcatalog.event-catalog.int.otc.fts.d-3.de/schemas/analytics-track.yaml#/TrackEvent"
},
{
"properties": {
"event": {
"const": "DashboardUnfavorited"
},
"properties": {
"properties": {
"dashboardId": {
"description": "Unique identifier of the dashboard in Superset.",
"example": 7,
"format": "int64",
"type": "integer"
}
},
"type": "object"
}
},
"title": "Specific event properties",
"type": "object"
}
]
},
"DashboardUpdatedPayload": {
"allOf": [
{
"$ref": "https://eventcatalog.event-catalog.int.otc.fts.d-3.de/schemas/analytics-track.yaml#/TrackEvent"
},
{
"properties": {
"event": {
"const": "DashboardUpdated"
},
"properties": {
"properties": {
"dashboardId": {
"description": "Unique identifier of the dashboard in Superset.",
"example": 7,
"format": "int64",
"type": "integer"
}
},
"type": "object"
}
},
"title": "Specific event properties",
"type": "object"
}
]
},
"DashboardViewedPayload": {
"allOf": [
{
"$ref": "https://eventcatalog.event-catalog.int.otc.fts.d-3.de/schemas/analytics-track.yaml#/TrackEvent"
},
{
"properties": {
"event": {
"const": "DashboardViewed"
},
"properties": {
"properties": {
"dashboardId": {
"description": "Unique identifier of the dashboard in Superset.",
"example": 7,
"format": "int64",
"type": "integer"
}
},
"type": "object"
}
},
"title": "Specific event properties",
"type": "object"
}
]
},
"DatasetCreatedPayload": {
"allOf": [
{
"$ref": "https://eventcatalog.event-catalog.int.otc.fts.d-3.de/schemas/analytics-track.yaml#/TrackEvent"
},
{
"properties": {
"event": {
"const": "DatasetCreated"
}
},
"title": "Specific event properties",
"type": "object"
}
]
},
"DatasetDeletedPayload": {
"allOf": [
{
"$ref": "https://eventcatalog.event-catalog.int.otc.fts.d-3.de/schemas/analytics-track.yaml#/TrackEvent"
},
{
"properties": {
"event": {
"const": "DatasetDeleted"
}
},
"title": "Specific event properties",
"type": "object"
}
]
},
"SavedQueryCreatedPayload": {
"allOf": [
{
"$ref": "https://eventcatalog.event-catalog.int.otc.fts.d-3.de/schemas/analytics-track.yaml#/TrackEvent"
},
{
"properties": {
"event": {
"const": "SavedQueryCreated"
}
},
"title": "Specific event properties",
"type": "object"
}
]
},
"SqlLabQueryExecutionFailedPayload": {
"allOf": [
{
"$ref": "https://eventcatalog.event-catalog.int.otc.fts.d-3.de/schemas/analytics-track.yaml#/TrackEvent"
},
{
"properties": {
"event": {
"const": "SqlLabQueryExecutionFailed"
}
},
"title": "Specific event properties",
"type": "object"
}
]
},
"SqlLabQueryExecutionSucceededPayload": {
"allOf": [
{
"$ref": "https://eventcatalog.event-catalog.int.otc.fts.d-3.de/schemas/analytics-track.yaml#/TrackEvent"
},
{
"properties": {
"event": {
"const": "SqlLabQueryExecutionSucceeded"
},
"properties": {
"properties": {
"dashboardId": {
"description": "Unique identifier of the dashboard in Superset.",
"example": 12,
"format": "int64",
"type": "integer"
}
},
"type": "object"
}
},
"title": "Specific event properties",
"type": "object"
}
]
}
}
}
}
---
id: analytics-platform.DatasetDeleted
name: DatasetDeleted
version: 1.0.0
summary: "Indicates that a user has deleted a dataset in Superset"
producers:
- analytics-platform
consumers: []
schemaPath: 'schema.json'
---
# DatasetDeleted
Indicates that a user has deleted a dataset in Superset
## Base Schema
All analytics events are based on the **TrackEvent** schema which provides common properties like `messageId`, `userId`, `context`, timestamps, and more.
**Base Schema Reference**: [analytics-track.yaml](https://event-catalog.prod.otc.fts.d-3.de/schemas/analytics-track.yaml)
## Event-Specific Properties
This schema shows only the event-specific properties that extend the base TrackEvent schema:
## Raw Schema:schema.json
{
"title": "Event-Specific Properties",
"type": "object",
"description": "Properties specific to this event type (extends BaseEvent)",
"extends": "https://eventcatalog.event-catalog.int.otc.fts.d-3.de/schemas/analytics-track.yaml#/TrackEvent",
"eventType": "DatasetDeleted",
"properties": {},
"note": "This event uses only BaseEvent properties with no additional event-specific properties",
"components": {
"schemas": {
"ChartCreatedPayload": {
"allOf": [
{
"$ref": "https://eventcatalog.event-catalog.int.otc.fts.d-3.de/schemas/analytics-track.yaml#/TrackEvent"
},
{
"properties": {
"event": {
"const": "ChartCreated"
}
},
"title": "Specific event properties",
"type": "object"
}
]
},
"ChartDataLoadedPayload": {
"allOf": [
{
"$ref": "https://eventcatalog.event-catalog.int.otc.fts.d-3.de/schemas/analytics-track.yaml#/TrackEvent"
},
{
"properties": {
"event": {
"const": "ChartDataLoaded"
},
"properties": {
"properties": {
"chartId": {
"description": "Unique identifier of the chart in Superset.",
"example": 42,
"format": "int64",
"type": "integer"
},
"dashboardId": {
"description": "Unique identifier of the dashboard in Superset.",
"example": 7,
"format": "int64",
"type": "integer"
},
"vizType": {
"description": "Type of visualization (e.g., bar, line, pie) used in the chart.",
"example": "table",
"type": "string"
}
},
"type": "object"
}
},
"title": "Specific event properties",
"type": "object"
}
]
},
"ChartDeletedPayload": {
"allOf": [
{
"$ref": "https://eventcatalog.event-catalog.int.otc.fts.d-3.de/schemas/analytics-track.yaml#/TrackEvent"
},
{
"properties": {
"event": {
"const": "ChartDeleted"
},
"properties": {
"properties": {
"chartId": {
"description": "Unique identifier of the chart in Superset.",
"example": 42,
"format": "int64",
"type": "integer"
}
},
"type": "object"
}
},
"title": "Specific event properties",
"type": "object"
}
]
},
"ChartFavoritedPayload": {
"allOf": [
{
"$ref": "https://eventcatalog.event-catalog.int.otc.fts.d-3.de/schemas/analytics-track.yaml#/TrackEvent"
},
{
"properties": {
"event": {
"const": "ChartFavorited"
},
"properties": {
"properties": {
"chartId": {
"description": "Unique identifier of the chart in Superset.",
"example": 333,
"format": "int64",
"type": "integer"
}
},
"type": "object"
}
},
"title": "Specific event properties",
"type": "object"
}
]
},
"ChartUnfavoritedPayload": {
"allOf": [
{
"$ref": "https://eventcatalog.event-catalog.int.otc.fts.d-3.de/schemas/analytics-track.yaml#/TrackEvent"
},
{
"properties": {
"event": {
"const": "ChartUnfavorited"
},
"properties": {
"properties": {
"chartId": {
"description": "Unique identifier of the chart in Superset.",
"example": 42,
"format": "int64",
"type": "integer"
}
},
"type": "object"
}
},
"title": "Specific event properties",
"type": "object"
}
]
},
"ChartUpdatedPayload": {
"allOf": [
{
"$ref": "https://eventcatalog.event-catalog.int.otc.fts.d-3.de/schemas/analytics-track.yaml#/TrackEvent"
},
{
"properties": {
"event": {
"const": "ChartUpdated"
},
"properties": {
"properties": {
"chartId": {
"description": "Unique identifier of the chart in Superset.",
"example": 42,
"format": "int64",
"type": "integer"
}
},
"type": "object"
}
},
"title": "Specific event properties",
"type": "object"
}
]
},
"DashboardCreatedPayload": {
"allOf": [
{
"$ref": "https://eventcatalog.event-catalog.int.otc.fts.d-3.de/schemas/analytics-track.yaml#/TrackEvent"
},
{
"properties": {
"event": {
"const": "DashboardCreated"
},
"properties": {
"properties": {
"dashboardId": {
"description": "Unique identifier of the dashboard in Superset.",
"example": 7,
"format": "int64",
"type": "integer"
}
},
"type": "object"
}
},
"title": "Specific event properties",
"type": "object"
}
]
},
"DashboardDeletedPayload": {
"allOf": [
{
"$ref": "https://eventcatalog.event-catalog.int.otc.fts.d-3.de/schemas/analytics-track.yaml#/TrackEvent"
},
{
"properties": {
"event": {
"const": "DashboardDeleted"
},
"properties": {
"properties": {
"dashboardId": {
"description": "Unique identifier of the dashboard in Superset.",
"example": 7,
"format": "int64",
"type": "integer"
}
},
"type": "object"
}
},
"title": "Specific event properties",
"type": "object"
}
]
},
"DashboardFavoritedPayload": {
"allOf": [
{
"$ref": "https://eventcatalog.event-catalog.int.otc.fts.d-3.de/schemas/analytics-track.yaml#/TrackEvent"
},
{
"properties": {
"event": {
"const": "DashboardFavorited"
},
"properties": {
"properties": {
"dashboardId": {
"description": "Unique identifier of the dashboard in Superset.",
"example": 7,
"format": "int64",
"type": "integer"
}
},
"type": "object"
}
},
"title": "Specific event properties",
"type": "object"
}
]
},
"DashboardUnfavoritedPayload": {
"allOf": [
{
"$ref": "https://eventcatalog.event-catalog.int.otc.fts.d-3.de/schemas/analytics-track.yaml#/TrackEvent"
},
{
"properties": {
"event": {
"const": "DashboardUnfavorited"
},
"properties": {
"properties": {
"dashboardId": {
"description": "Unique identifier of the dashboard in Superset.",
"example": 7,
"format": "int64",
"type": "integer"
}
},
"type": "object"
}
},
"title": "Specific event properties",
"type": "object"
}
]
},
"DashboardUpdatedPayload": {
"allOf": [
{
"$ref": "https://eventcatalog.event-catalog.int.otc.fts.d-3.de/schemas/analytics-track.yaml#/TrackEvent"
},
{
"properties": {
"event": {
"const": "DashboardUpdated"
},
"properties": {
"properties": {
"dashboardId": {
"description": "Unique identifier of the dashboard in Superset.",
"example": 7,
"format": "int64",
"type": "integer"
}
},
"type": "object"
}
},
"title": "Specific event properties",
"type": "object"
}
]
},
"DashboardViewedPayload": {
"allOf": [
{
"$ref": "https://eventcatalog.event-catalog.int.otc.fts.d-3.de/schemas/analytics-track.yaml#/TrackEvent"
},
{
"properties": {
"event": {
"const": "DashboardViewed"
},
"properties": {
"properties": {
"dashboardId": {
"description": "Unique identifier of the dashboard in Superset.",
"example": 7,
"format": "int64",
"type": "integer"
}
},
"type": "object"
}
},
"title": "Specific event properties",
"type": "object"
}
]
},
"DatasetCreatedPayload": {
"allOf": [
{
"$ref": "https://eventcatalog.event-catalog.int.otc.fts.d-3.de/schemas/analytics-track.yaml#/TrackEvent"
},
{
"properties": {
"event": {
"const": "DatasetCreated"
}
},
"title": "Specific event properties",
"type": "object"
}
]
},
"DatasetDeletedPayload": {
"allOf": [
{
"$ref": "https://eventcatalog.event-catalog.int.otc.fts.d-3.de/schemas/analytics-track.yaml#/TrackEvent"
},
{
"properties": {
"event": {
"const": "DatasetDeleted"
}
},
"title": "Specific event properties",
"type": "object"
}
]
},
"SavedQueryCreatedPayload": {
"allOf": [
{
"$ref": "https://eventcatalog.event-catalog.int.otc.fts.d-3.de/schemas/analytics-track.yaml#/TrackEvent"
},
{
"properties": {
"event": {
"const": "SavedQueryCreated"
}
},
"title": "Specific event properties",
"type": "object"
}
]
},
"SqlLabQueryExecutionFailedPayload": {
"allOf": [
{
"$ref": "https://eventcatalog.event-catalog.int.otc.fts.d-3.de/schemas/analytics-track.yaml#/TrackEvent"
},
{
"properties": {
"event": {
"const": "SqlLabQueryExecutionFailed"
}
},
"title": "Specific event properties",
"type": "object"
}
]
},
"SqlLabQueryExecutionSucceededPayload": {
"allOf": [
{
"$ref": "https://eventcatalog.event-catalog.int.otc.fts.d-3.de/schemas/analytics-track.yaml#/TrackEvent"
},
{
"properties": {
"event": {
"const": "SqlLabQueryExecutionSucceeded"
},
"properties": {
"properties": {
"dashboardId": {
"description": "Unique identifier of the dashboard in Superset.",
"example": 12,
"format": "int64",
"type": "integer"
}
},
"type": "object"
}
},
"title": "Specific event properties",
"type": "object"
}
]
}
}
}
}
---
id: analytics-platform.SavedQueryCreated
name: SavedQueryCreated
version: 1.0.0
summary: "Indicates that a user has created a saved query in Superset"
producers:
- analytics-platform
consumers: []
schemaPath: 'schema.json'
---
# SavedQueryCreated
Indicates that a user has created a saved query in Superset
## Base Schema
All analytics events are based on the **TrackEvent** schema which provides common properties like `messageId`, `userId`, `context`, timestamps, and more.
**Base Schema Reference**: [analytics-track.yaml](https://event-catalog.prod.otc.fts.d-3.de/schemas/analytics-track.yaml)
## Event-Specific Properties
This schema shows only the event-specific properties that extend the base TrackEvent schema:
## Raw Schema:schema.json
{
"title": "Event-Specific Properties",
"type": "object",
"description": "Properties specific to this event type (extends BaseEvent)",
"extends": "https://eventcatalog.event-catalog.int.otc.fts.d-3.de/schemas/analytics-track.yaml#/TrackEvent",
"eventType": "SavedQueryCreated",
"properties": {},
"note": "This event uses only BaseEvent properties with no additional event-specific properties",
"components": {
"schemas": {
"ChartCreatedPayload": {
"allOf": [
{
"$ref": "https://eventcatalog.event-catalog.int.otc.fts.d-3.de/schemas/analytics-track.yaml#/TrackEvent"
},
{
"properties": {
"event": {
"const": "ChartCreated"
}
},
"title": "Specific event properties",
"type": "object"
}
]
},
"ChartDataLoadedPayload": {
"allOf": [
{
"$ref": "https://eventcatalog.event-catalog.int.otc.fts.d-3.de/schemas/analytics-track.yaml#/TrackEvent"
},
{
"properties": {
"event": {
"const": "ChartDataLoaded"
},
"properties": {
"properties": {
"chartId": {
"description": "Unique identifier of the chart in Superset.",
"example": 42,
"format": "int64",
"type": "integer"
},
"dashboardId": {
"description": "Unique identifier of the dashboard in Superset.",
"example": 7,
"format": "int64",
"type": "integer"
},
"vizType": {
"description": "Type of visualization (e.g., bar, line, pie) used in the chart.",
"example": "table",
"type": "string"
}
},
"type": "object"
}
},
"title": "Specific event properties",
"type": "object"
}
]
},
"ChartDeletedPayload": {
"allOf": [
{
"$ref": "https://eventcatalog.event-catalog.int.otc.fts.d-3.de/schemas/analytics-track.yaml#/TrackEvent"
},
{
"properties": {
"event": {
"const": "ChartDeleted"
},
"properties": {
"properties": {
"chartId": {
"description": "Unique identifier of the chart in Superset.",
"example": 42,
"format": "int64",
"type": "integer"
}
},
"type": "object"
}
},
"title": "Specific event properties",
"type": "object"
}
]
},
"ChartFavoritedPayload": {
"allOf": [
{
"$ref": "https://eventcatalog.event-catalog.int.otc.fts.d-3.de/schemas/analytics-track.yaml#/TrackEvent"
},
{
"properties": {
"event": {
"const": "ChartFavorited"
},
"properties": {
"properties": {
"chartId": {
"description": "Unique identifier of the chart in Superset.",
"example": 333,
"format": "int64",
"type": "integer"
}
},
"type": "object"
}
},
"title": "Specific event properties",
"type": "object"
}
]
},
"ChartUnfavoritedPayload": {
"allOf": [
{
"$ref": "https://eventcatalog.event-catalog.int.otc.fts.d-3.de/schemas/analytics-track.yaml#/TrackEvent"
},
{
"properties": {
"event": {
"const": "ChartUnfavorited"
},
"properties": {
"properties": {
"chartId": {
"description": "Unique identifier of the chart in Superset.",
"example": 42,
"format": "int64",
"type": "integer"
}
},
"type": "object"
}
},
"title": "Specific event properties",
"type": "object"
}
]
},
"ChartUpdatedPayload": {
"allOf": [
{
"$ref": "https://eventcatalog.event-catalog.int.otc.fts.d-3.de/schemas/analytics-track.yaml#/TrackEvent"
},
{
"properties": {
"event": {
"const": "ChartUpdated"
},
"properties": {
"properties": {
"chartId": {
"description": "Unique identifier of the chart in Superset.",
"example": 42,
"format": "int64",
"type": "integer"
}
},
"type": "object"
}
},
"title": "Specific event properties",
"type": "object"
}
]
},
"DashboardCreatedPayload": {
"allOf": [
{
"$ref": "https://eventcatalog.event-catalog.int.otc.fts.d-3.de/schemas/analytics-track.yaml#/TrackEvent"
},
{
"properties": {
"event": {
"const": "DashboardCreated"
},
"properties": {
"properties": {
"dashboardId": {
"description": "Unique identifier of the dashboard in Superset.",
"example": 7,
"format": "int64",
"type": "integer"
}
},
"type": "object"
}
},
"title": "Specific event properties",
"type": "object"
}
]
},
"DashboardDeletedPayload": {
"allOf": [
{
"$ref": "https://eventcatalog.event-catalog.int.otc.fts.d-3.de/schemas/analytics-track.yaml#/TrackEvent"
},
{
"properties": {
"event": {
"const": "DashboardDeleted"
},
"properties": {
"properties": {
"dashboardId": {
"description": "Unique identifier of the dashboard in Superset.",
"example": 7,
"format": "int64",
"type": "integer"
}
},
"type": "object"
}
},
"title": "Specific event properties",
"type": "object"
}
]
},
"DashboardFavoritedPayload": {
"allOf": [
{
"$ref": "https://eventcatalog.event-catalog.int.otc.fts.d-3.de/schemas/analytics-track.yaml#/TrackEvent"
},
{
"properties": {
"event": {
"const": "DashboardFavorited"
},
"properties": {
"properties": {
"dashboardId": {
"description": "Unique identifier of the dashboard in Superset.",
"example": 7,
"format": "int64",
"type": "integer"
}
},
"type": "object"
}
},
"title": "Specific event properties",
"type": "object"
}
]
},
"DashboardUnfavoritedPayload": {
"allOf": [
{
"$ref": "https://eventcatalog.event-catalog.int.otc.fts.d-3.de/schemas/analytics-track.yaml#/TrackEvent"
},
{
"properties": {
"event": {
"const": "DashboardUnfavorited"
},
"properties": {
"properties": {
"dashboardId": {
"description": "Unique identifier of the dashboard in Superset.",
"example": 7,
"format": "int64",
"type": "integer"
}
},
"type": "object"
}
},
"title": "Specific event properties",
"type": "object"
}
]
},
"DashboardUpdatedPayload": {
"allOf": [
{
"$ref": "https://eventcatalog.event-catalog.int.otc.fts.d-3.de/schemas/analytics-track.yaml#/TrackEvent"
},
{
"properties": {
"event": {
"const": "DashboardUpdated"
},
"properties": {
"properties": {
"dashboardId": {
"description": "Unique identifier of the dashboard in Superset.",
"example": 7,
"format": "int64",
"type": "integer"
}
},
"type": "object"
}
},
"title": "Specific event properties",
"type": "object"
}
]
},
"DashboardViewedPayload": {
"allOf": [
{
"$ref": "https://eventcatalog.event-catalog.int.otc.fts.d-3.de/schemas/analytics-track.yaml#/TrackEvent"
},
{
"properties": {
"event": {
"const": "DashboardViewed"
},
"properties": {
"properties": {
"dashboardId": {
"description": "Unique identifier of the dashboard in Superset.",
"example": 7,
"format": "int64",
"type": "integer"
}
},
"type": "object"
}
},
"title": "Specific event properties",
"type": "object"
}
]
},
"DatasetCreatedPayload": {
"allOf": [
{
"$ref": "https://eventcatalog.event-catalog.int.otc.fts.d-3.de/schemas/analytics-track.yaml#/TrackEvent"
},
{
"properties": {
"event": {
"const": "DatasetCreated"
}
},
"title": "Specific event properties",
"type": "object"
}
]
},
"DatasetDeletedPayload": {
"allOf": [
{
"$ref": "https://eventcatalog.event-catalog.int.otc.fts.d-3.de/schemas/analytics-track.yaml#/TrackEvent"
},
{
"properties": {
"event": {
"const": "DatasetDeleted"
}
},
"title": "Specific event properties",
"type": "object"
}
]
},
"SavedQueryCreatedPayload": {
"allOf": [
{
"$ref": "https://eventcatalog.event-catalog.int.otc.fts.d-3.de/schemas/analytics-track.yaml#/TrackEvent"
},
{
"properties": {
"event": {
"const": "SavedQueryCreated"
}
},
"title": "Specific event properties",
"type": "object"
}
]
},
"SqlLabQueryExecutionFailedPayload": {
"allOf": [
{
"$ref": "https://eventcatalog.event-catalog.int.otc.fts.d-3.de/schemas/analytics-track.yaml#/TrackEvent"
},
{
"properties": {
"event": {
"const": "SqlLabQueryExecutionFailed"
}
},
"title": "Specific event properties",
"type": "object"
}
]
},
"SqlLabQueryExecutionSucceededPayload": {
"allOf": [
{
"$ref": "https://eventcatalog.event-catalog.int.otc.fts.d-3.de/schemas/analytics-track.yaml#/TrackEvent"
},
{
"properties": {
"event": {
"const": "SqlLabQueryExecutionSucceeded"
},
"properties": {
"properties": {
"dashboardId": {
"description": "Unique identifier of the dashboard in Superset.",
"example": 12,
"format": "int64",
"type": "integer"
}
},
"type": "object"
}
},
"title": "Specific event properties",
"type": "object"
}
]
}
}
}
}
---
id: analytics-platform.SqlLabQueryExecutionFailed
name: SqlLabQueryExecutionFailed
version: 1.0.0
summary: "Indicates that a user has failed to execute a SQL Lab query in Superset"
producers:
- analytics-platform
consumers: []
schemaPath: 'schema.json'
---
# SqlLabQueryExecutionFailed
Indicates that a user has failed to execute a SQL Lab query in Superset
## Base Schema
All analytics events are based on the **TrackEvent** schema which provides common properties like `messageId`, `userId`, `context`, timestamps, and more.
**Base Schema Reference**: [analytics-track.yaml](https://event-catalog.prod.otc.fts.d-3.de/schemas/analytics-track.yaml)
## Event-Specific Properties
This schema shows only the event-specific properties that extend the base TrackEvent schema:
## Raw Schema:schema.json
{
"title": "Event-Specific Properties",
"type": "object",
"description": "Properties specific to this event type (extends BaseEvent)",
"extends": "https://eventcatalog.event-catalog.int.otc.fts.d-3.de/schemas/analytics-track.yaml#/TrackEvent",
"eventType": "SqlLabQueryExecutionFailed",
"properties": {},
"note": "This event uses only BaseEvent properties with no additional event-specific properties",
"components": {
"schemas": {
"ChartCreatedPayload": {
"allOf": [
{
"$ref": "https://eventcatalog.event-catalog.int.otc.fts.d-3.de/schemas/analytics-track.yaml#/TrackEvent"
},
{
"properties": {
"event": {
"const": "ChartCreated"
}
},
"title": "Specific event properties",
"type": "object"
}
]
},
"ChartDataLoadedPayload": {
"allOf": [
{
"$ref": "https://eventcatalog.event-catalog.int.otc.fts.d-3.de/schemas/analytics-track.yaml#/TrackEvent"
},
{
"properties": {
"event": {
"const": "ChartDataLoaded"
},
"properties": {
"properties": {
"chartId": {
"description": "Unique identifier of the chart in Superset.",
"example": 42,
"format": "int64",
"type": "integer"
},
"dashboardId": {
"description": "Unique identifier of the dashboard in Superset.",
"example": 7,
"format": "int64",
"type": "integer"
},
"vizType": {
"description": "Type of visualization (e.g., bar, line, pie) used in the chart.",
"example": "table",
"type": "string"
}
},
"type": "object"
}
},
"title": "Specific event properties",
"type": "object"
}
]
},
"ChartDeletedPayload": {
"allOf": [
{
"$ref": "https://eventcatalog.event-catalog.int.otc.fts.d-3.de/schemas/analytics-track.yaml#/TrackEvent"
},
{
"properties": {
"event": {
"const": "ChartDeleted"
},
"properties": {
"properties": {
"chartId": {
"description": "Unique identifier of the chart in Superset.",
"example": 42,
"format": "int64",
"type": "integer"
}
},
"type": "object"
}
},
"title": "Specific event properties",
"type": "object"
}
]
},
"ChartFavoritedPayload": {
"allOf": [
{
"$ref": "https://eventcatalog.event-catalog.int.otc.fts.d-3.de/schemas/analytics-track.yaml#/TrackEvent"
},
{
"properties": {
"event": {
"const": "ChartFavorited"
},
"properties": {
"properties": {
"chartId": {
"description": "Unique identifier of the chart in Superset.",
"example": 333,
"format": "int64",
"type": "integer"
}
},
"type": "object"
}
},
"title": "Specific event properties",
"type": "object"
}
]
},
"ChartUnfavoritedPayload": {
"allOf": [
{
"$ref": "https://eventcatalog.event-catalog.int.otc.fts.d-3.de/schemas/analytics-track.yaml#/TrackEvent"
},
{
"properties": {
"event": {
"const": "ChartUnfavorited"
},
"properties": {
"properties": {
"chartId": {
"description": "Unique identifier of the chart in Superset.",
"example": 42,
"format": "int64",
"type": "integer"
}
},
"type": "object"
}
},
"title": "Specific event properties",
"type": "object"
}
]
},
"ChartUpdatedPayload": {
"allOf": [
{
"$ref": "https://eventcatalog.event-catalog.int.otc.fts.d-3.de/schemas/analytics-track.yaml#/TrackEvent"
},
{
"properties": {
"event": {
"const": "ChartUpdated"
},
"properties": {
"properties": {
"chartId": {
"description": "Unique identifier of the chart in Superset.",
"example": 42,
"format": "int64",
"type": "integer"
}
},
"type": "object"
}
},
"title": "Specific event properties",
"type": "object"
}
]
},
"DashboardCreatedPayload": {
"allOf": [
{
"$ref": "https://eventcatalog.event-catalog.int.otc.fts.d-3.de/schemas/analytics-track.yaml#/TrackEvent"
},
{
"properties": {
"event": {
"const": "DashboardCreated"
},
"properties": {
"properties": {
"dashboardId": {
"description": "Unique identifier of the dashboard in Superset.",
"example": 7,
"format": "int64",
"type": "integer"
}
},
"type": "object"
}
},
"title": "Specific event properties",
"type": "object"
}
]
},
"DashboardDeletedPayload": {
"allOf": [
{
"$ref": "https://eventcatalog.event-catalog.int.otc.fts.d-3.de/schemas/analytics-track.yaml#/TrackEvent"
},
{
"properties": {
"event": {
"const": "DashboardDeleted"
},
"properties": {
"properties": {
"dashboardId": {
"description": "Unique identifier of the dashboard in Superset.",
"example": 7,
"format": "int64",
"type": "integer"
}
},
"type": "object"
}
},
"title": "Specific event properties",
"type": "object"
}
]
},
"DashboardFavoritedPayload": {
"allOf": [
{
"$ref": "https://eventcatalog.event-catalog.int.otc.fts.d-3.de/schemas/analytics-track.yaml#/TrackEvent"
},
{
"properties": {
"event": {
"const": "DashboardFavorited"
},
"properties": {
"properties": {
"dashboardId": {
"description": "Unique identifier of the dashboard in Superset.",
"example": 7,
"format": "int64",
"type": "integer"
}
},
"type": "object"
}
},
"title": "Specific event properties",
"type": "object"
}
]
},
"DashboardUnfavoritedPayload": {
"allOf": [
{
"$ref": "https://eventcatalog.event-catalog.int.otc.fts.d-3.de/schemas/analytics-track.yaml#/TrackEvent"
},
{
"properties": {
"event": {
"const": "DashboardUnfavorited"
},
"properties": {
"properties": {
"dashboardId": {
"description": "Unique identifier of the dashboard in Superset.",
"example": 7,
"format": "int64",
"type": "integer"
}
},
"type": "object"
}
},
"title": "Specific event properties",
"type": "object"
}
]
},
"DashboardUpdatedPayload": {
"allOf": [
{
"$ref": "https://eventcatalog.event-catalog.int.otc.fts.d-3.de/schemas/analytics-track.yaml#/TrackEvent"
},
{
"properties": {
"event": {
"const": "DashboardUpdated"
},
"properties": {
"properties": {
"dashboardId": {
"description": "Unique identifier of the dashboard in Superset.",
"example": 7,
"format": "int64",
"type": "integer"
}
},
"type": "object"
}
},
"title": "Specific event properties",
"type": "object"
}
]
},
"DashboardViewedPayload": {
"allOf": [
{
"$ref": "https://eventcatalog.event-catalog.int.otc.fts.d-3.de/schemas/analytics-track.yaml#/TrackEvent"
},
{
"properties": {
"event": {
"const": "DashboardViewed"
},
"properties": {
"properties": {
"dashboardId": {
"description": "Unique identifier of the dashboard in Superset.",
"example": 7,
"format": "int64",
"type": "integer"
}
},
"type": "object"
}
},
"title": "Specific event properties",
"type": "object"
}
]
},
"DatasetCreatedPayload": {
"allOf": [
{
"$ref": "https://eventcatalog.event-catalog.int.otc.fts.d-3.de/schemas/analytics-track.yaml#/TrackEvent"
},
{
"properties": {
"event": {
"const": "DatasetCreated"
}
},
"title": "Specific event properties",
"type": "object"
}
]
},
"DatasetDeletedPayload": {
"allOf": [
{
"$ref": "https://eventcatalog.event-catalog.int.otc.fts.d-3.de/schemas/analytics-track.yaml#/TrackEvent"
},
{
"properties": {
"event": {
"const": "DatasetDeleted"
}
},
"title": "Specific event properties",
"type": "object"
}
]
},
"SavedQueryCreatedPayload": {
"allOf": [
{
"$ref": "https://eventcatalog.event-catalog.int.otc.fts.d-3.de/schemas/analytics-track.yaml#/TrackEvent"
},
{
"properties": {
"event": {
"const": "SavedQueryCreated"
}
},
"title": "Specific event properties",
"type": "object"
}
]
},
"SqlLabQueryExecutionFailedPayload": {
"allOf": [
{
"$ref": "https://eventcatalog.event-catalog.int.otc.fts.d-3.de/schemas/analytics-track.yaml#/TrackEvent"
},
{
"properties": {
"event": {
"const": "SqlLabQueryExecutionFailed"
}
},
"title": "Specific event properties",
"type": "object"
}
]
},
"SqlLabQueryExecutionSucceededPayload": {
"allOf": [
{
"$ref": "https://eventcatalog.event-catalog.int.otc.fts.d-3.de/schemas/analytics-track.yaml#/TrackEvent"
},
{
"properties": {
"event": {
"const": "SqlLabQueryExecutionSucceeded"
},
"properties": {
"properties": {
"dashboardId": {
"description": "Unique identifier of the dashboard in Superset.",
"example": 12,
"format": "int64",
"type": "integer"
}
},
"type": "object"
}
},
"title": "Specific event properties",
"type": "object"
}
]
}
}
}
}
---
id: analytics-platform.SqlLabQueryExecutionSucceeded
name: SqlLabQueryExecutionSucceeded
version: 1.0.0
summary: "Indicates that a user has successfully executed a SQL Lab query in Superset"
producers:
- analytics-platform
consumers: []
schemaPath: 'schema.json'
---
# SqlLabQueryExecutionSucceeded
Indicates that a user has successfully executed a SQL Lab query in Superset
## Base Schema
All analytics events are based on the **TrackEvent** schema which provides common properties like `messageId`, `userId`, `context`, timestamps, and more.
**Base Schema Reference**: [analytics-track.yaml](https://event-catalog.prod.otc.fts.d-3.de/schemas/analytics-track.yaml)
## Event-Specific Properties
This schema shows only the event-specific properties that extend the base TrackEvent schema:
## Raw Schema:schema.json
{
"title": "Event-Specific Properties",
"type": "object",
"description": "Properties specific to this event type (extends BaseEvent)",
"extends": "https://eventcatalog.event-catalog.int.otc.fts.d-3.de/schemas/analytics-track.yaml#/TrackEvent",
"eventType": "SqlLabQueryExecutionSucceeded",
"properties": {
"dashboardId": {
"description": "Unique identifier of the dashboard in Superset.",
"example": 12,
"format": "int64",
"type": "integer"
}
},
"components": {
"schemas": {
"ChartCreatedPayload": {
"allOf": [
{
"$ref": "https://eventcatalog.event-catalog.int.otc.fts.d-3.de/schemas/analytics-track.yaml#/TrackEvent"
},
{
"properties": {
"event": {
"const": "ChartCreated"
}
},
"title": "Specific event properties",
"type": "object"
}
]
},
"ChartDataLoadedPayload": {
"allOf": [
{
"$ref": "https://eventcatalog.event-catalog.int.otc.fts.d-3.de/schemas/analytics-track.yaml#/TrackEvent"
},
{
"properties": {
"event": {
"const": "ChartDataLoaded"
},
"properties": {
"properties": {
"chartId": {
"description": "Unique identifier of the chart in Superset.",
"example": 42,
"format": "int64",
"type": "integer"
},
"dashboardId": {
"description": "Unique identifier of the dashboard in Superset.",
"example": 7,
"format": "int64",
"type": "integer"
},
"vizType": {
"description": "Type of visualization (e.g., bar, line, pie) used in the chart.",
"example": "table",
"type": "string"
}
},
"type": "object"
}
},
"title": "Specific event properties",
"type": "object"
}
]
},
"ChartDeletedPayload": {
"allOf": [
{
"$ref": "https://eventcatalog.event-catalog.int.otc.fts.d-3.de/schemas/analytics-track.yaml#/TrackEvent"
},
{
"properties": {
"event": {
"const": "ChartDeleted"
},
"properties": {
"properties": {
"chartId": {
"description": "Unique identifier of the chart in Superset.",
"example": 42,
"format": "int64",
"type": "integer"
}
},
"type": "object"
}
},
"title": "Specific event properties",
"type": "object"
}
]
},
"ChartFavoritedPayload": {
"allOf": [
{
"$ref": "https://eventcatalog.event-catalog.int.otc.fts.d-3.de/schemas/analytics-track.yaml#/TrackEvent"
},
{
"properties": {
"event": {
"const": "ChartFavorited"
},
"properties": {
"properties": {
"chartId": {
"description": "Unique identifier of the chart in Superset.",
"example": 333,
"format": "int64",
"type": "integer"
}
},
"type": "object"
}
},
"title": "Specific event properties",
"type": "object"
}
]
},
"ChartUnfavoritedPayload": {
"allOf": [
{
"$ref": "https://eventcatalog.event-catalog.int.otc.fts.d-3.de/schemas/analytics-track.yaml#/TrackEvent"
},
{
"properties": {
"event": {
"const": "ChartUnfavorited"
},
"properties": {
"properties": {
"chartId": {
"description": "Unique identifier of the chart in Superset.",
"example": 42,
"format": "int64",
"type": "integer"
}
},
"type": "object"
}
},
"title": "Specific event properties",
"type": "object"
}
]
},
"ChartUpdatedPayload": {
"allOf": [
{
"$ref": "https://eventcatalog.event-catalog.int.otc.fts.d-3.de/schemas/analytics-track.yaml#/TrackEvent"
},
{
"properties": {
"event": {
"const": "ChartUpdated"
},
"properties": {
"properties": {
"chartId": {
"description": "Unique identifier of the chart in Superset.",
"example": 42,
"format": "int64",
"type": "integer"
}
},
"type": "object"
}
},
"title": "Specific event properties",
"type": "object"
}
]
},
"DashboardCreatedPayload": {
"allOf": [
{
"$ref": "https://eventcatalog.event-catalog.int.otc.fts.d-3.de/schemas/analytics-track.yaml#/TrackEvent"
},
{
"properties": {
"event": {
"const": "DashboardCreated"
},
"properties": {
"properties": {
"dashboardId": {
"description": "Unique identifier of the dashboard in Superset.",
"example": 7,
"format": "int64",
"type": "integer"
}
},
"type": "object"
}
},
"title": "Specific event properties",
"type": "object"
}
]
},
"DashboardDeletedPayload": {
"allOf": [
{
"$ref": "https://eventcatalog.event-catalog.int.otc.fts.d-3.de/schemas/analytics-track.yaml#/TrackEvent"
},
{
"properties": {
"event": {
"const": "DashboardDeleted"
},
"properties": {
"properties": {
"dashboardId": {
"description": "Unique identifier of the dashboard in Superset.",
"example": 7,
"format": "int64",
"type": "integer"
}
},
"type": "object"
}
},
"title": "Specific event properties",
"type": "object"
}
]
},
"DashboardFavoritedPayload": {
"allOf": [
{
"$ref": "https://eventcatalog.event-catalog.int.otc.fts.d-3.de/schemas/analytics-track.yaml#/TrackEvent"
},
{
"properties": {
"event": {
"const": "DashboardFavorited"
},
"properties": {
"properties": {
"dashboardId": {
"description": "Unique identifier of the dashboard in Superset.",
"example": 7,
"format": "int64",
"type": "integer"
}
},
"type": "object"
}
},
"title": "Specific event properties",
"type": "object"
}
]
},
"DashboardUnfavoritedPayload": {
"allOf": [
{
"$ref": "https://eventcatalog.event-catalog.int.otc.fts.d-3.de/schemas/analytics-track.yaml#/TrackEvent"
},
{
"properties": {
"event": {
"const": "DashboardUnfavorited"
},
"properties": {
"properties": {
"dashboardId": {
"description": "Unique identifier of the dashboard in Superset.",
"example": 7,
"format": "int64",
"type": "integer"
}
},
"type": "object"
}
},
"title": "Specific event properties",
"type": "object"
}
]
},
"DashboardUpdatedPayload": {
"allOf": [
{
"$ref": "https://eventcatalog.event-catalog.int.otc.fts.d-3.de/schemas/analytics-track.yaml#/TrackEvent"
},
{
"properties": {
"event": {
"const": "DashboardUpdated"
},
"properties": {
"properties": {
"dashboardId": {
"description": "Unique identifier of the dashboard in Superset.",
"example": 7,
"format": "int64",
"type": "integer"
}
},
"type": "object"
}
},
"title": "Specific event properties",
"type": "object"
}
]
},
"DashboardViewedPayload": {
"allOf": [
{
"$ref": "https://eventcatalog.event-catalog.int.otc.fts.d-3.de/schemas/analytics-track.yaml#/TrackEvent"
},
{
"properties": {
"event": {
"const": "DashboardViewed"
},
"properties": {
"properties": {
"dashboardId": {
"description": "Unique identifier of the dashboard in Superset.",
"example": 7,
"format": "int64",
"type": "integer"
}
},
"type": "object"
}
},
"title": "Specific event properties",
"type": "object"
}
]
},
"DatasetCreatedPayload": {
"allOf": [
{
"$ref": "https://eventcatalog.event-catalog.int.otc.fts.d-3.de/schemas/analytics-track.yaml#/TrackEvent"
},
{
"properties": {
"event": {
"const": "DatasetCreated"
}
},
"title": "Specific event properties",
"type": "object"
}
]
},
"DatasetDeletedPayload": {
"allOf": [
{
"$ref": "https://eventcatalog.event-catalog.int.otc.fts.d-3.de/schemas/analytics-track.yaml#/TrackEvent"
},
{
"properties": {
"event": {
"const": "DatasetDeleted"
}
},
"title": "Specific event properties",
"type": "object"
}
]
},
"SavedQueryCreatedPayload": {
"allOf": [
{
"$ref": "https://eventcatalog.event-catalog.int.otc.fts.d-3.de/schemas/analytics-track.yaml#/TrackEvent"
},
{
"properties": {
"event": {
"const": "SavedQueryCreated"
}
},
"title": "Specific event properties",
"type": "object"
}
]
},
"SqlLabQueryExecutionFailedPayload": {
"allOf": [
{
"$ref": "https://eventcatalog.event-catalog.int.otc.fts.d-3.de/schemas/analytics-track.yaml#/TrackEvent"
},
{
"properties": {
"event": {
"const": "SqlLabQueryExecutionFailed"
}
},
"title": "Specific event properties",
"type": "object"
}
]
},
"SqlLabQueryExecutionSucceededPayload": {
"allOf": [
{
"$ref": "https://eventcatalog.event-catalog.int.otc.fts.d-3.de/schemas/analytics-track.yaml#/TrackEvent"
},
{
"properties": {
"event": {
"const": "SqlLabQueryExecutionSucceeded"
},
"properties": {
"properties": {
"dashboardId": {
"description": "Unique identifier of the dashboard in Superset.",
"example": 12,
"format": "int64",
"type": "integer"
}
},
"type": "object"
}
},
"title": "Specific event properties",
"type": "object"
}
]
}
}
}
}
---
id: businessobjects.AppPurgeReceived
name: AppPurgeReceived
version: 1.0.0
summary: "Indicates that a purge request has been received"
producers:
- businessobjects
consumers: []
schemaPath: 'schema.json'
---
# AppPurgeReceived
Indicates that a purge request has been received
## Base Schema
All analytics events are based on the **TrackEvent** schema which provides common properties like `messageId`, `userId`, `context`, timestamps, and more.
**Base Schema Reference**: [analytics-track.yaml](https://event-catalog.prod.otc.fts.d-3.de/schemas/analytics-track.yaml)
## Event-Specific Properties
This schema shows only the event-specific properties that extend the base TrackEvent schema:
## Raw Schema:schema.json
{
"title": "Event-Specific Properties",
"type": "object",
"description": "Properties specific to this event type (extends BaseEvent)",
"extends": "https://event-catalog.int.otc.fts.d-3.de/schemas/analytics-track.yaml#/TrackEvent",
"eventType": "AppPurgeReceived",
"properties": {
"referenceId": {
"description": "Unique reference identifier of this event instance",
"example": "01JZAGPG76SXYC523XJAA7XNM7",
"type": "string"
},
"comment": {
"description": "Information that the event was backfilled",
"example": "backfilled",
"type": "string"
},
"tn": {
"description": "Unique identifier of the tenant for which the purge request was received",
"example": "3b1",
"type": "string"
},
"baseUri": {
"description": "Base URL of the tenant's cloud environment",
"example": "https://example.d-velop.cloud",
"format": "uri",
"type": "string"
},
"received": {
"description": "Timestamp indicating when the purge request was received",
"example": "2025-07-08T10:31:11.311Z",
"format": "date-time",
"type": "string"
}
},
"components": {
"schemas": {
"AppPurgeReceivedPayload": {
"allOf": [
{
"$ref": "https://event-catalog.int.otc.fts.d-3.de/schemas/analytics-track.yaml#/TrackEvent"
},
{
"properties": {
"event": {
"const": "AppPurgeReceived"
},
"properties": {
"properties": {
"baseUri": {
"description": "Base URL of the tenant's cloud environment",
"example": "https://example.d-velop.cloud",
"format": "uri",
"type": "string"
},
"comment": {
"description": "Information that the event was backfilled",
"example": "backfilled",
"type": "string"
},
"received": {
"description": "Timestamp indicating when the purge request was received",
"example": "2025-07-08T10:31:11.311Z",
"format": "date-time",
"type": "string"
},
"referenceId": {
"description": "Unique reference identifier of this event instance",
"example": "01JZAGPG76SXYC523XJAA7XNM7",
"type": "string"
},
"tn": {
"description": "Unique identifier of the tenant for which the purge request was received",
"example": "3b1",
"type": "string"
}
},
"type": "object"
}
},
"title": "Specific event properties",
"type": "object"
}
]
},
"AppResubscribedPayload": {
"allOf": [
{
"$ref": "https://event-catalog.int.otc.fts.d-3.de/schemas/analytics-track.yaml#/TrackEvent"
},
{
"properties": {
"event": {
"const": "AppResubscribed"
},
"properties": {
"properties": {
"baseUri": {
"description": "Base URL of the tenant's cloud environment",
"example": "https://example.d-velop.cloud",
"format": "uri",
"type": "string"
},
"comment": {
"description": "Information that the event was backfilled",
"example": "backfilled",
"type": "string"
},
"received": {
"description": "Timestamp indicating when the tenant's app re-subscription was received",
"example": "2025-07-08T10:31:11.311Z",
"format": "date-time",
"type": "string"
},
"referenceId": {
"description": "Unique reference identifier of this event instance",
"example": "01JZAGPG76SXYC523XJAA7XNM7",
"type": "string"
},
"tn": {
"description": "Unique identifier of the re-subscribing tenant",
"example": "3b1",
"type": "string"
}
},
"type": "object"
}
},
"title": "Specific event properties",
"type": "object"
}
]
},
"AppSubscribedPayload": {
"allOf": [
{
"$ref": "https://event-catalog.int.otc.fts.d-3.de/schemas/analytics-track.yaml#/TrackEvent"
},
{
"properties": {
"event": {
"const": "AppSubscribed"
},
"properties": {
"properties": {
"baseUri": {
"description": "Base URL of the tenant's cloud environment",
"example": "https://example.d-velop.cloud",
"format": "uri",
"type": "string"
},
"comment": {
"description": "Information that the event was backfilled",
"example": "backfilled",
"type": "string"
},
"received": {
"description": "Timestamp indicating when the tenant's app subscription was received",
"example": "2025-07-08T10:31:11.311Z",
"format": "date-time",
"type": "string"
},
"referenceId": {
"description": "Unique reference identifier of this event instance",
"example": "01JZAGPG76SXYC523XJAA7XNM7",
"type": "string"
},
"tn": {
"description": "Unique identifier of the subscribing tenant",
"example": "3b1",
"type": "string"
}
},
"type": "object"
}
},
"title": "Specific event properties",
"type": "object"
}
]
},
"AppUnsubscribedPayload": {
"allOf": [
{
"$ref": "https://event-catalog.int.otc.fts.d-3.de/schemas/analytics-track.yaml#/TrackEvent"
},
{
"properties": {
"event": {
"const": "AppUnsubscribed"
},
"properties": {
"properties": {
"baseUri": {
"description": "Base URL of the tenant's cloud environment",
"example": "https://example.d-velop.cloud",
"format": "uri",
"type": "string"
},
"comment": {
"description": "Information that the event was backfilled",
"example": "backfilled",
"type": "string"
},
"received": {
"description": "Timestamp indicating when the tenant's app unsubscription was received",
"example": "2025-07-08T10:31:11.311Z",
"format": "date-time",
"type": "string"
},
"referenceId": {
"description": "Unique reference identifier of this event instance",
"example": "01JZAGPG76SXYC523XJAA7XNM7",
"type": "string"
},
"tn": {
"description": "Unique identifier of the unsubscribing tenant",
"example": "3b1",
"type": "string"
}
},
"type": "object"
}
},
"title": "Specific event properties",
"type": "object"
}
]
},
"DatabaseStatisticsBuiltPayload": {
"allOf": [
{
"$ref": "https://event-catalog.int.otc.fts.d-3.de/schemas/analytics-track.yaml#/TrackEvent"
},
{
"properties": {
"event": {
"const": "DatabaseStatisticsBuilt"
},
"properties": {
"properties": {
"comment": {
"description": "Information that the event was backfilled",
"example": "backfilled",
"type": "string"
},
"created": {
"description": "The time the statistics were created",
"example": "2025-11-03T10:31:11.311Z",
"format": "date-time",
"type": "string"
},
"dataSize": {
"description": "The total size of the data in use (KiB)",
"example": 1572864,
"format": "int64",
"type": "integer"
},
"entityCount": {
"description": "The total number of entities in use",
"example": 40000,
"format": "int64",
"type": "integer"
},
"entitySetCount": {
"description": "The total number of entity sets in use",
"example": 1200,
"format": "int64",
"type": "integer"
},
"entityTypeCount": {
"description": "The total number of (custom) entity types in use",
"example": 150,
"format": "int64",
"type": "integer"
},
"id": {
"description": "The unique identifier under which the statistics is stored",
"example": "01JZAGPG76SXYC523XJAA7XNM7",
"type": "string"
},
"indexCount": {
"description": "The total number of indexes in use",
"example": 240,
"format": "int64",
"type": "integer"
},
"indexSize": {
"description": "The total size of all indexes in use (KiB)",
"example": 102400,
"format": "int64",
"type": "integer"
},
"modelCount": {
"description": "The total number of custom models in use",
"example": 25,
"format": "int64",
"type": "integer"
},
"orphanedDataSize": {
"description": "The total size of the orphaned data (KiB)",
"example": 262144,
"format": "int64",
"type": "integer"
},
"orphanedEntityCount": {
"description": "The total number of entities that are orphaned",
"example": 2000,
"format": "int64",
"type": "integer"
},
"orphanedEntitySetCount": {
"description": "The total number of entity sets that are orphaned",
"example": 100,
"format": "int64",
"type": "integer"
},
"orphanedIndexCount": {
"description": "The total number of indexes that are orphaned",
"example": 20,
"format": "int64",
"type": "integer"
},
"orphanedIndexSize": {
"description": "The total size of all orphaned indexes (KiB)",
"example": 12288,
"format": "int64",
"type": "integer"
},
"referenceId": {
"description": "Unique reference identifier of this event instance",
"example": "01JZAGPG76SXYC523XJAA7XNM7",
"type": "string"
},
"tenantCount": {
"description": "The number of tenants included in the statistics",
"example": 150,
"format": "int64",
"type": "integer"
},
"totalDataSize": {
"description": "The total size of the data held in the database (KiB)",
"example": 2097152,
"format": "int64",
"type": "integer"
},
"totalEntityCount": {
"description": "The total number of entities",
"example": 50000,
"format": "int64",
"type": "integer"
},
"totalEntitySetCount": {
"description": "The total number of entity sets",
"example": 1500,
"format": "int64",
"type": "integer"
},
"totalIndexCount": {
"description": "The total number of indexes",
"example": 300,
"format": "int64",
"type": "integer"
},
"totalIndexSize": {
"description": "The total size of all indexes (KiB)",
"example": 131072,
"format": "int64",
"type": "integer"
},
"trashedDataSize": {
"description": "The total size of the data for which the related entity types were moved to the trash (KiB)",
"example": 262144,
"format": "int64",
"type": "integer"
},
"trashedEntityCount": {
"description": "The total number of entities for which the related entity types were moved to the trash",
"example": 8000,
"format": "int64",
"type": "integer"
},
"trashedEntitySetCount": {
"description": "The total number of entity sets for which the related entity types were moved to the trash",
"example": 200,
"format": "int64",
"type": "integer"
},
"trashedEntityTypeCount": {
"description": "The total number of (custom) entity types that were moved to the trash",
"example": 20,
"format": "int64",
"type": "integer"
},
"trashedIndexCount": {
"description": "The total number of indexes for which the related entity types were moved to the trash",
"example": 40,
"format": "int64",
"type": "integer"
},
"trashedIndexSize": {
"description": "The total size of all indexes for which the related entity types were moved to the trash (KiB)",
"example": 16384,
"format": "int64",
"type": "integer"
},
"trashedModelCount": {
"description": "The total number of custom models that were moved to the trash",
"example": 3,
"format": "int64",
"type": "integer"
}
},
"type": "object"
}
},
"title": "Database statistics that summarize the database statistics for all tenants",
"type": "object"
}
]
},
"EntitySetQueryMetricsAggregatedPayload": {
"allOf": [
{
"$ref": "https://event-catalog.int.otc.fts.d-3.de/schemas/analytics-track.yaml#/TrackEvent"
},
{
"description": "This event is emitted after queries have been executed against an entity set and their usage metrics have been aggregated. Aggregation is based on processing time. Metrics are grouped into fixed aggregation windows defined by `aggregationWindowStart` (inclusive) and `aggregationWindowEnd` (exclusive). Queries occurring near window boundaries may be assigned to either adjacent window.\n",
"properties": {
"event": {
"const": "EntitySetQueryMetricsAggregated"
},
"properties": {
"properties": {
"aggregationInterval": {
"description": "Duration of the aggregation window used for this event. Typically equals `aggregationWindowEnd` minus `aggregationWindowStart`. Must be an ISO 8601 duration (e.g. PT30S, PT5M, PT1H).\n",
"example": "PT30S",
"type": "string"
},
"aggregationWindowEnd": {
"description": "End timestamp (exclusive) of the aggregation window.\n",
"example": "2026-02-24T10:00:30Z",
"format": "date-time",
"type": "string"
},
"aggregationWindowStart": {
"description": "Start timestamp (inclusive) of the aggregation window.\n",
"example": "2026-02-24T10:00:00Z",
"format": "date-time",
"type": "string"
},
"dataSource": {
"description": "Identifier of the logical context or model against which the entity set query was executed. A data source groups multiple related entity types and entity sets and represents the functional context of that query.\n",
"example": "crm",
"type": "string"
},
"entitiesReturned": {
"description": "Total number of entities returned across all executed queries for this entity set within the measured scope.\n",
"example": 12509,
"minimum": 0,
"type": "integer"
},
"entitySet": {
"description": "Name of the entity set that was queried.",
"example": "customers",
"type": "string"
},
"functionCounts": {
"description": "Counter array representing how often specific query functions were used. The array index corresponds to the internal FunctionFeatures flag position. Index 0 represents queries without functions. The array contains 41 entries, one for each defined function feature bit, including the `None` and `Unknown` flags.\n",
"example": [
10,
0,
2,
1,
0,
0,
3,
5,
0,
0,
0,
1,
0,
0,
0,
0,
0,
0,
0,
0,
0,
0,
0,
0,
0,
0,
0,
0,
0,
0,
0,
0,
0,
0,
0,
0,
0,
0,
0,
0,
0
],
"items": {
"minimum": 0,
"type": "integer"
},
"maxItems": 41,
"minItems": 41,
"type": "array"
},
"operatorCounts": {
"description": "Counter array representing how often specific filter operators were used. The array index corresponds to the internal OperatorFeatures flag position. Index 0 represents queries without operators. The array contains 19 entries, one for each defined operator feature bit, including the `None` and `Unknown` flags.\n",
"example": [
2,
0,
0,
4,
1,
0,
0,
3,
0,
0,
0,
1,
0,
0,
0,
0,
0,
0,
0
],
"items": {
"minimum": 0,
"type": "integer"
},
"maxItems": 19,
"minItems": 19,
"type": "array"
},
"queryCount": {
"description": "Total number of queries executed for this entity set within the measured scope.",
"example": 133,
"minimum": 0,
"type": "integer"
},
"queryOptionCounts": {
"description": "Counter array representing how often specific query options were used. The array index corresponds to the internal QueryOptionFeatures flag position. Index 0 represents queries without any query options. The array contains 17 entries, one for each defined query option feature bit, including the `None` and `Unknown` flags.\n",
"example": [
5,
0,
3,
0,
1,
0,
0,
2,
0,
0,
0,
1,
0,
0,
0,
0,
0
],
"items": {
"minimum": 0,
"type": "integer"
},
"maxItems": 17,
"minItems": 17,
"type": "array"
},
"schemaNamespace": {
"description": "Logical namespace of the schema in which the queried entity set is defined. Indicates whether the schema is system-provided (e.g. `core`) or tenant-specific (`custom`).\n",
"example": "custom",
"type": "string"
}
},
"type": "object"
}
},
"title": "Entity Set Query Metrics Aggregated Event",
"type": "object"
}
]
},
"EntitySetStatisticsBuiltPayload": {
"allOf": [
{
"$ref": "https://event-catalog.int.otc.fts.d-3.de/schemas/analytics-track.yaml#/TrackEvent"
},
{
"properties": {
"event": {
"const": "EntitySetStatisticsBuilt"
},
"properties": {
"properties": {
"averageEntitySize": {
"description": "The average size of an entity in the entity set",
"example": 2,
"format": "int64",
"type": "integer"
},
"comment": {
"description": "Information that the event was backfilled",
"example": "backfilled",
"type": "string"
},
"dataSize": {
"description": "The size of the data in the entity set (KiB)",
"example": 1024,
"format": "int64",
"type": "integer"
},
"entityCount": {
"description": "The number of entities in the entity set",
"example": 500,
"format": "int64",
"type": "integer"
},
"indexCount": {
"description": "The number of indexes",
"example": 3,
"format": "int64",
"type": "integer"
},
"indexSize": {
"description": "The size of the indexes (KiB)",
"example": 128,
"format": "int64",
"type": "integer"
},
"kind": {
"description": "The kind of the entity set (e.g., trashed, active)",
"example": "active",
"type": "string"
},
"name": {
"description": "The (logical) name of the entity set",
"example": "Products",
"type": "string"
},
"physicalName": {
"description": "The physical name of the entity set",
"example": "products_3b1_collection",
"type": "string"
},
"referenceId": {
"description": "Unique reference identifier of this event instance",
"example": "01JZAGPG76SXYC523XJAA7XNM7",
"type": "string"
},
"tn": {
"description": "Unique identifier of the tenant",
"example": "3b1",
"type": "string"
},
"typeName": {
"description": "The type name of the entities in the entity set",
"example": "Product",
"type": "string"
}
},
"type": "object"
}
},
"title": "The statistics of a tenant entity set",
"type": "object"
}
]
},
"TenantComputedTierChangedPayload": {
"allOf": [
{
"$ref": "https://event-catalog.int.otc.fts.d-3.de/schemas/analytics-track.yaml#/TrackEvent"
},
{
"properties": {
"event": {
"const": "TenantComputedTierChanged"
},
"properties": {
"properties": {
"newTier": {
"description": "The new computed tier of the tenant",
"example": "basic",
"type": "string"
},
"oldTier": {
"description": "The previous computed tier of the tenant",
"example": "standard",
"type": "string"
},
"tierDeterminants": {
"description": "The factors that determined the new tier calculation",
"example": "TotalEntityCount: 925, EntitySetMaxEntityCount: 382",
"type": "string"
},
"tn": {
"description": "Unique identifier of the tenant",
"example": "3b1",
"type": "string"
}
},
"type": "object"
}
},
"title": "Tenant computed tier change event",
"type": "object"
}
]
},
"TenantDatabaseStatisticsBuiltPayload": {
"allOf": [
{
"$ref": "https://event-catalog.int.otc.fts.d-3.de/schemas/analytics-track.yaml#/TrackEvent"
},
{
"properties": {
"event": {
"const": "TenantDatabaseStatisticsBuilt"
},
"properties": {
"properties": {
"created": {
"description": "The time the statistics were created",
"example": "2025-11-03T10:31:11.311Z",
"format": "date-time",
"type": "string"
},
"dataSize": {
"description": "The total size of the data in use (KiB)",
"example": 786432,
"format": "int64",
"type": "integer"
},
"entityCount": {
"description": "The total number of entities in use",
"example": 20000,
"format": "int64",
"type": "integer"
},
"entitySetCount": {
"description": "The total number of entity sets in use",
"example": 120,
"format": "int64",
"type": "integer"
},
"entityTypeCount": {
"description": "The total number of (custom) entity types in use",
"example": 45,
"format": "int64",
"type": "integer"
},
"id": {
"description": "The unique identifier under which the statistics is stored",
"example": "01JZAGPG76SXYC523XJAA7XNM7",
"type": "string"
},
"indexCount": {
"description": "The total number of indexes in use",
"example": 60,
"format": "int64",
"type": "integer"
},
"indexSize": {
"description": "The total size of all indexes in use (KiB)",
"example": 51200,
"format": "int64",
"type": "integer"
},
"modelCount": {
"description": "The total number of custom models in use",
"example": 12,
"format": "int64",
"type": "integer"
},
"orphanedDataSize": {
"description": "The total size of the orphaned data (KiB)",
"example": 131072,
"format": "int64",
"type": "integer"
},
"orphanedEntityCount": {
"description": "The total number of entities that are orphaned",
"example": 1000,
"format": "int64",
"type": "integer"
},
"orphanedEntitySetCount": {
"description": "The total number of entity sets that are orphaned",
"example": 10,
"format": "int64",
"type": "integer"
},
"orphanedIndexCount": {
"description": "The total number of indexes that are orphaned",
"example": 5,
"format": "int64",
"type": "integer"
},
"orphanedIndexSize": {
"description": "The total size of all orphaned indexes (KiB)",
"example": 6144,
"format": "int64",
"type": "integer"
},
"referenceId": {
"description": "Unique reference identifier of this event instance",
"example": "01JZAGPG76SXYC523XJAA7XNM7",
"type": "string"
},
"tenantDatabaseName": {
"description": "The name of the tenant database",
"example": "t_10qg",
"type": "string"
},
"tn": {
"description": "Unique identifier of the tenant",
"example": "3b1",
"type": "string"
},
"totalDataSize": {
"description": "The total size of the data held in the database (KiB)",
"example": 1048576,
"format": "int64",
"type": "integer"
},
"totalEntityCount": {
"description": "The total number of entities",
"example": 25000,
"format": "int64",
"type": "integer"
},
"totalEntitySetCount": {
"description": "The total number of entity sets",
"example": 150,
"format": "int64",
"type": "integer"
},
"totalIndexCount": {
"description": "The total number of indexes",
"example": 75,
"format": "int64",
"type": "integer"
},
"totalIndexSize": {
"description": "The total size of all indexes (KiB)",
"example": 65536,
"format": "int64",
"type": "integer"
},
"trashedDataSize": {
"description": "The total size of the data for which the related entity types were moved to the trash (KiB)",
"example": 131072,
"format": "int64",
"type": "integer"
},
"trashedEntityCount": {
"description": "The total number of entities for which the related entity types were moved to the trash",
"example": 4000,
"format": "int64",
"type": "integer"
},
"trashedEntitySetCount": {
"description": "The total number of entity sets for which the related entity types were moved to the trash",
"example": 20,
"format": "int64",
"type": "integer"
},
"trashedEntityTypeCount": {
"description": "The total number of (custom) entity types that were moved to the trash",
"example": 8,
"format": "int64",
"type": "integer"
},
"trashedIndexCount": {
"description": "The total number of indexes for which the related entity types were moved to the trash",
"example": 10,
"format": "int64",
"type": "integer"
},
"trashedIndexSize": {
"description": "The total size of all indexes for which the related entity types were moved to the trash (KiB)",
"example": 8192,
"format": "int64",
"type": "integer"
},
"trashedModelCount": {
"description": "The total number of custom models that were moved to the trash",
"example": 2,
"format": "int64",
"type": "integer"
}
},
"type": "object"
}
},
"title": "The statistics of a tenant database",
"type": "object"
}
]
}
}
}
}
---
id: businessobjects.AppResubscribed
name: AppResubscribed
version: 1.0.0
summary: "Indicates that a tenant has re-subscribed to Business Objects"
producers:
- businessobjects
consumers: []
schemaPath: 'schema.json'
---
# AppResubscribed
Indicates that a tenant has re-subscribed to Business Objects
## Base Schema
All analytics events are based on the **TrackEvent** schema which provides common properties like `messageId`, `userId`, `context`, timestamps, and more.
**Base Schema Reference**: [analytics-track.yaml](https://event-catalog.prod.otc.fts.d-3.de/schemas/analytics-track.yaml)
## Event-Specific Properties
This schema shows only the event-specific properties that extend the base TrackEvent schema:
## Raw Schema:schema.json
{
"title": "Event-Specific Properties",
"type": "object",
"description": "Properties specific to this event type (extends BaseEvent)",
"extends": "https://event-catalog.int.otc.fts.d-3.de/schemas/analytics-track.yaml#/TrackEvent",
"eventType": "AppResubscribed",
"properties": {
"referenceId": {
"description": "Unique reference identifier of this event instance",
"example": "01JZAGPG76SXYC523XJAA7XNM7",
"type": "string"
},
"comment": {
"description": "Information that the event was backfilled",
"example": "backfilled",
"type": "string"
},
"tn": {
"description": "Unique identifier of the re-subscribing tenant",
"example": "3b1",
"type": "string"
},
"baseUri": {
"description": "Base URL of the tenant's cloud environment",
"example": "https://example.d-velop.cloud",
"format": "uri",
"type": "string"
},
"received": {
"description": "Timestamp indicating when the tenant's app re-subscription was received",
"example": "2025-07-08T10:31:11.311Z",
"format": "date-time",
"type": "string"
}
},
"components": {
"schemas": {
"AppPurgeReceivedPayload": {
"allOf": [
{
"$ref": "https://event-catalog.int.otc.fts.d-3.de/schemas/analytics-track.yaml#/TrackEvent"
},
{
"properties": {
"event": {
"const": "AppPurgeReceived"
},
"properties": {
"properties": {
"baseUri": {
"description": "Base URL of the tenant's cloud environment",
"example": "https://example.d-velop.cloud",
"format": "uri",
"type": "string"
},
"comment": {
"description": "Information that the event was backfilled",
"example": "backfilled",
"type": "string"
},
"received": {
"description": "Timestamp indicating when the purge request was received",
"example": "2025-07-08T10:31:11.311Z",
"format": "date-time",
"type": "string"
},
"referenceId": {
"description": "Unique reference identifier of this event instance",
"example": "01JZAGPG76SXYC523XJAA7XNM7",
"type": "string"
},
"tn": {
"description": "Unique identifier of the tenant for which the purge request was received",
"example": "3b1",
"type": "string"
}
},
"type": "object"
}
},
"title": "Specific event properties",
"type": "object"
}
]
},
"AppResubscribedPayload": {
"allOf": [
{
"$ref": "https://event-catalog.int.otc.fts.d-3.de/schemas/analytics-track.yaml#/TrackEvent"
},
{
"properties": {
"event": {
"const": "AppResubscribed"
},
"properties": {
"properties": {
"baseUri": {
"description": "Base URL of the tenant's cloud environment",
"example": "https://example.d-velop.cloud",
"format": "uri",
"type": "string"
},
"comment": {
"description": "Information that the event was backfilled",
"example": "backfilled",
"type": "string"
},
"received": {
"description": "Timestamp indicating when the tenant's app re-subscription was received",
"example": "2025-07-08T10:31:11.311Z",
"format": "date-time",
"type": "string"
},
"referenceId": {
"description": "Unique reference identifier of this event instance",
"example": "01JZAGPG76SXYC523XJAA7XNM7",
"type": "string"
},
"tn": {
"description": "Unique identifier of the re-subscribing tenant",
"example": "3b1",
"type": "string"
}
},
"type": "object"
}
},
"title": "Specific event properties",
"type": "object"
}
]
},
"AppSubscribedPayload": {
"allOf": [
{
"$ref": "https://event-catalog.int.otc.fts.d-3.de/schemas/analytics-track.yaml#/TrackEvent"
},
{
"properties": {
"event": {
"const": "AppSubscribed"
},
"properties": {
"properties": {
"baseUri": {
"description": "Base URL of the tenant's cloud environment",
"example": "https://example.d-velop.cloud",
"format": "uri",
"type": "string"
},
"comment": {
"description": "Information that the event was backfilled",
"example": "backfilled",
"type": "string"
},
"received": {
"description": "Timestamp indicating when the tenant's app subscription was received",
"example": "2025-07-08T10:31:11.311Z",
"format": "date-time",
"type": "string"
},
"referenceId": {
"description": "Unique reference identifier of this event instance",
"example": "01JZAGPG76SXYC523XJAA7XNM7",
"type": "string"
},
"tn": {
"description": "Unique identifier of the subscribing tenant",
"example": "3b1",
"type": "string"
}
},
"type": "object"
}
},
"title": "Specific event properties",
"type": "object"
}
]
},
"AppUnsubscribedPayload": {
"allOf": [
{
"$ref": "https://event-catalog.int.otc.fts.d-3.de/schemas/analytics-track.yaml#/TrackEvent"
},
{
"properties": {
"event": {
"const": "AppUnsubscribed"
},
"properties": {
"properties": {
"baseUri": {
"description": "Base URL of the tenant's cloud environment",
"example": "https://example.d-velop.cloud",
"format": "uri",
"type": "string"
},
"comment": {
"description": "Information that the event was backfilled",
"example": "backfilled",
"type": "string"
},
"received": {
"description": "Timestamp indicating when the tenant's app unsubscription was received",
"example": "2025-07-08T10:31:11.311Z",
"format": "date-time",
"type": "string"
},
"referenceId": {
"description": "Unique reference identifier of this event instance",
"example": "01JZAGPG76SXYC523XJAA7XNM7",
"type": "string"
},
"tn": {
"description": "Unique identifier of the unsubscribing tenant",
"example": "3b1",
"type": "string"
}
},
"type": "object"
}
},
"title": "Specific event properties",
"type": "object"
}
]
},
"DatabaseStatisticsBuiltPayload": {
"allOf": [
{
"$ref": "https://event-catalog.int.otc.fts.d-3.de/schemas/analytics-track.yaml#/TrackEvent"
},
{
"properties": {
"event": {
"const": "DatabaseStatisticsBuilt"
},
"properties": {
"properties": {
"comment": {
"description": "Information that the event was backfilled",
"example": "backfilled",
"type": "string"
},
"created": {
"description": "The time the statistics were created",
"example": "2025-11-03T10:31:11.311Z",
"format": "date-time",
"type": "string"
},
"dataSize": {
"description": "The total size of the data in use (KiB)",
"example": 1572864,
"format": "int64",
"type": "integer"
},
"entityCount": {
"description": "The total number of entities in use",
"example": 40000,
"format": "int64",
"type": "integer"
},
"entitySetCount": {
"description": "The total number of entity sets in use",
"example": 1200,
"format": "int64",
"type": "integer"
},
"entityTypeCount": {
"description": "The total number of (custom) entity types in use",
"example": 150,
"format": "int64",
"type": "integer"
},
"id": {
"description": "The unique identifier under which the statistics is stored",
"example": "01JZAGPG76SXYC523XJAA7XNM7",
"type": "string"
},
"indexCount": {
"description": "The total number of indexes in use",
"example": 240,
"format": "int64",
"type": "integer"
},
"indexSize": {
"description": "The total size of all indexes in use (KiB)",
"example": 102400,
"format": "int64",
"type": "integer"
},
"modelCount": {
"description": "The total number of custom models in use",
"example": 25,
"format": "int64",
"type": "integer"
},
"orphanedDataSize": {
"description": "The total size of the orphaned data (KiB)",
"example": 262144,
"format": "int64",
"type": "integer"
},
"orphanedEntityCount": {
"description": "The total number of entities that are orphaned",
"example": 2000,
"format": "int64",
"type": "integer"
},
"orphanedEntitySetCount": {
"description": "The total number of entity sets that are orphaned",
"example": 100,
"format": "int64",
"type": "integer"
},
"orphanedIndexCount": {
"description": "The total number of indexes that are orphaned",
"example": 20,
"format": "int64",
"type": "integer"
},
"orphanedIndexSize": {
"description": "The total size of all orphaned indexes (KiB)",
"example": 12288,
"format": "int64",
"type": "integer"
},
"referenceId": {
"description": "Unique reference identifier of this event instance",
"example": "01JZAGPG76SXYC523XJAA7XNM7",
"type": "string"
},
"tenantCount": {
"description": "The number of tenants included in the statistics",
"example": 150,
"format": "int64",
"type": "integer"
},
"totalDataSize": {
"description": "The total size of the data held in the database (KiB)",
"example": 2097152,
"format": "int64",
"type": "integer"
},
"totalEntityCount": {
"description": "The total number of entities",
"example": 50000,
"format": "int64",
"type": "integer"
},
"totalEntitySetCount": {
"description": "The total number of entity sets",
"example": 1500,
"format": "int64",
"type": "integer"
},
"totalIndexCount": {
"description": "The total number of indexes",
"example": 300,
"format": "int64",
"type": "integer"
},
"totalIndexSize": {
"description": "The total size of all indexes (KiB)",
"example": 131072,
"format": "int64",
"type": "integer"
},
"trashedDataSize": {
"description": "The total size of the data for which the related entity types were moved to the trash (KiB)",
"example": 262144,
"format": "int64",
"type": "integer"
},
"trashedEntityCount": {
"description": "The total number of entities for which the related entity types were moved to the trash",
"example": 8000,
"format": "int64",
"type": "integer"
},
"trashedEntitySetCount": {
"description": "The total number of entity sets for which the related entity types were moved to the trash",
"example": 200,
"format": "int64",
"type": "integer"
},
"trashedEntityTypeCount": {
"description": "The total number of (custom) entity types that were moved to the trash",
"example": 20,
"format": "int64",
"type": "integer"
},
"trashedIndexCount": {
"description": "The total number of indexes for which the related entity types were moved to the trash",
"example": 40,
"format": "int64",
"type": "integer"
},
"trashedIndexSize": {
"description": "The total size of all indexes for which the related entity types were moved to the trash (KiB)",
"example": 16384,
"format": "int64",
"type": "integer"
},
"trashedModelCount": {
"description": "The total number of custom models that were moved to the trash",
"example": 3,
"format": "int64",
"type": "integer"
}
},
"type": "object"
}
},
"title": "Database statistics that summarize the database statistics for all tenants",
"type": "object"
}
]
},
"EntitySetQueryMetricsAggregatedPayload": {
"allOf": [
{
"$ref": "https://event-catalog.int.otc.fts.d-3.de/schemas/analytics-track.yaml#/TrackEvent"
},
{
"description": "This event is emitted after queries have been executed against an entity set and their usage metrics have been aggregated. Aggregation is based on processing time. Metrics are grouped into fixed aggregation windows defined by `aggregationWindowStart` (inclusive) and `aggregationWindowEnd` (exclusive). Queries occurring near window boundaries may be assigned to either adjacent window.\n",
"properties": {
"event": {
"const": "EntitySetQueryMetricsAggregated"
},
"properties": {
"properties": {
"aggregationInterval": {
"description": "Duration of the aggregation window used for this event. Typically equals `aggregationWindowEnd` minus `aggregationWindowStart`. Must be an ISO 8601 duration (e.g. PT30S, PT5M, PT1H).\n",
"example": "PT30S",
"type": "string"
},
"aggregationWindowEnd": {
"description": "End timestamp (exclusive) of the aggregation window.\n",
"example": "2026-02-24T10:00:30Z",
"format": "date-time",
"type": "string"
},
"aggregationWindowStart": {
"description": "Start timestamp (inclusive) of the aggregation window.\n",
"example": "2026-02-24T10:00:00Z",
"format": "date-time",
"type": "string"
},
"dataSource": {
"description": "Identifier of the logical context or model against which the entity set query was executed. A data source groups multiple related entity types and entity sets and represents the functional context of that query.\n",
"example": "crm",
"type": "string"
},
"entitiesReturned": {
"description": "Total number of entities returned across all executed queries for this entity set within the measured scope.\n",
"example": 12509,
"minimum": 0,
"type": "integer"
},
"entitySet": {
"description": "Name of the entity set that was queried.",
"example": "customers",
"type": "string"
},
"functionCounts": {
"description": "Counter array representing how often specific query functions were used. The array index corresponds to the internal FunctionFeatures flag position. Index 0 represents queries without functions. The array contains 41 entries, one for each defined function feature bit, including the `None` and `Unknown` flags.\n",
"example": [
10,
0,
2,
1,
0,
0,
3,
5,
0,
0,
0,
1,
0,
0,
0,
0,
0,
0,
0,
0,
0,
0,
0,
0,
0,
0,
0,
0,
0,
0,
0,
0,
0,
0,
0,
0,
0,
0,
0,
0,
0
],
"items": {
"minimum": 0,
"type": "integer"
},
"maxItems": 41,
"minItems": 41,
"type": "array"
},
"operatorCounts": {
"description": "Counter array representing how often specific filter operators were used. The array index corresponds to the internal OperatorFeatures flag position. Index 0 represents queries without operators. The array contains 19 entries, one for each defined operator feature bit, including the `None` and `Unknown` flags.\n",
"example": [
2,
0,
0,
4,
1,
0,
0,
3,
0,
0,
0,
1,
0,
0,
0,
0,
0,
0,
0
],
"items": {
"minimum": 0,
"type": "integer"
},
"maxItems": 19,
"minItems": 19,
"type": "array"
},
"queryCount": {
"description": "Total number of queries executed for this entity set within the measured scope.",
"example": 133,
"minimum": 0,
"type": "integer"
},
"queryOptionCounts": {
"description": "Counter array representing how often specific query options were used. The array index corresponds to the internal QueryOptionFeatures flag position. Index 0 represents queries without any query options. The array contains 17 entries, one for each defined query option feature bit, including the `None` and `Unknown` flags.\n",
"example": [
5,
0,
3,
0,
1,
0,
0,
2,
0,
0,
0,
1,
0,
0,
0,
0,
0
],
"items": {
"minimum": 0,
"type": "integer"
},
"maxItems": 17,
"minItems": 17,
"type": "array"
},
"schemaNamespace": {
"description": "Logical namespace of the schema in which the queried entity set is defined. Indicates whether the schema is system-provided (e.g. `core`) or tenant-specific (`custom`).\n",
"example": "custom",
"type": "string"
}
},
"type": "object"
}
},
"title": "Entity Set Query Metrics Aggregated Event",
"type": "object"
}
]
},
"EntitySetStatisticsBuiltPayload": {
"allOf": [
{
"$ref": "https://event-catalog.int.otc.fts.d-3.de/schemas/analytics-track.yaml#/TrackEvent"
},
{
"properties": {
"event": {
"const": "EntitySetStatisticsBuilt"
},
"properties": {
"properties": {
"averageEntitySize": {
"description": "The average size of an entity in the entity set",
"example": 2,
"format": "int64",
"type": "integer"
},
"comment": {
"description": "Information that the event was backfilled",
"example": "backfilled",
"type": "string"
},
"dataSize": {
"description": "The size of the data in the entity set (KiB)",
"example": 1024,
"format": "int64",
"type": "integer"
},
"entityCount": {
"description": "The number of entities in the entity set",
"example": 500,
"format": "int64",
"type": "integer"
},
"indexCount": {
"description": "The number of indexes",
"example": 3,
"format": "int64",
"type": "integer"
},
"indexSize": {
"description": "The size of the indexes (KiB)",
"example": 128,
"format": "int64",
"type": "integer"
},
"kind": {
"description": "The kind of the entity set (e.g., trashed, active)",
"example": "active",
"type": "string"
},
"name": {
"description": "The (logical) name of the entity set",
"example": "Products",
"type": "string"
},
"physicalName": {
"description": "The physical name of the entity set",
"example": "products_3b1_collection",
"type": "string"
},
"referenceId": {
"description": "Unique reference identifier of this event instance",
"example": "01JZAGPG76SXYC523XJAA7XNM7",
"type": "string"
},
"tn": {
"description": "Unique identifier of the tenant",
"example": "3b1",
"type": "string"
},
"typeName": {
"description": "The type name of the entities in the entity set",
"example": "Product",
"type": "string"
}
},
"type": "object"
}
},
"title": "The statistics of a tenant entity set",
"type": "object"
}
]
},
"TenantComputedTierChangedPayload": {
"allOf": [
{
"$ref": "https://event-catalog.int.otc.fts.d-3.de/schemas/analytics-track.yaml#/TrackEvent"
},
{
"properties": {
"event": {
"const": "TenantComputedTierChanged"
},
"properties": {
"properties": {
"newTier": {
"description": "The new computed tier of the tenant",
"example": "basic",
"type": "string"
},
"oldTier": {
"description": "The previous computed tier of the tenant",
"example": "standard",
"type": "string"
},
"tierDeterminants": {
"description": "The factors that determined the new tier calculation",
"example": "TotalEntityCount: 925, EntitySetMaxEntityCount: 382",
"type": "string"
},
"tn": {
"description": "Unique identifier of the tenant",
"example": "3b1",
"type": "string"
}
},
"type": "object"
}
},
"title": "Tenant computed tier change event",
"type": "object"
}
]
},
"TenantDatabaseStatisticsBuiltPayload": {
"allOf": [
{
"$ref": "https://event-catalog.int.otc.fts.d-3.de/schemas/analytics-track.yaml#/TrackEvent"
},
{
"properties": {
"event": {
"const": "TenantDatabaseStatisticsBuilt"
},
"properties": {
"properties": {
"created": {
"description": "The time the statistics were created",
"example": "2025-11-03T10:31:11.311Z",
"format": "date-time",
"type": "string"
},
"dataSize": {
"description": "The total size of the data in use (KiB)",
"example": 786432,
"format": "int64",
"type": "integer"
},
"entityCount": {
"description": "The total number of entities in use",
"example": 20000,
"format": "int64",
"type": "integer"
},
"entitySetCount": {
"description": "The total number of entity sets in use",
"example": 120,
"format": "int64",
"type": "integer"
},
"entityTypeCount": {
"description": "The total number of (custom) entity types in use",
"example": 45,
"format": "int64",
"type": "integer"
},
"id": {
"description": "The unique identifier under which the statistics is stored",
"example": "01JZAGPG76SXYC523XJAA7XNM7",
"type": "string"
},
"indexCount": {
"description": "The total number of indexes in use",
"example": 60,
"format": "int64",
"type": "integer"
},
"indexSize": {
"description": "The total size of all indexes in use (KiB)",
"example": 51200,
"format": "int64",
"type": "integer"
},
"modelCount": {
"description": "The total number of custom models in use",
"example": 12,
"format": "int64",
"type": "integer"
},
"orphanedDataSize": {
"description": "The total size of the orphaned data (KiB)",
"example": 131072,
"format": "int64",
"type": "integer"
},
"orphanedEntityCount": {
"description": "The total number of entities that are orphaned",
"example": 1000,
"format": "int64",
"type": "integer"
},
"orphanedEntitySetCount": {
"description": "The total number of entity sets that are orphaned",
"example": 10,
"format": "int64",
"type": "integer"
},
"orphanedIndexCount": {
"description": "The total number of indexes that are orphaned",
"example": 5,
"format": "int64",
"type": "integer"
},
"orphanedIndexSize": {
"description": "The total size of all orphaned indexes (KiB)",
"example": 6144,
"format": "int64",
"type": "integer"
},
"referenceId": {
"description": "Unique reference identifier of this event instance",
"example": "01JZAGPG76SXYC523XJAA7XNM7",
"type": "string"
},
"tenantDatabaseName": {
"description": "The name of the tenant database",
"example": "t_10qg",
"type": "string"
},
"tn": {
"description": "Unique identifier of the tenant",
"example": "3b1",
"type": "string"
},
"totalDataSize": {
"description": "The total size of the data held in the database (KiB)",
"example": 1048576,
"format": "int64",
"type": "integer"
},
"totalEntityCount": {
"description": "The total number of entities",
"example": 25000,
"format": "int64",
"type": "integer"
},
"totalEntitySetCount": {
"description": "The total number of entity sets",
"example": 150,
"format": "int64",
"type": "integer"
},
"totalIndexCount": {
"description": "The total number of indexes",
"example": 75,
"format": "int64",
"type": "integer"
},
"totalIndexSize": {
"description": "The total size of all indexes (KiB)",
"example": 65536,
"format": "int64",
"type": "integer"
},
"trashedDataSize": {
"description": "The total size of the data for which the related entity types were moved to the trash (KiB)",
"example": 131072,
"format": "int64",
"type": "integer"
},
"trashedEntityCount": {
"description": "The total number of entities for which the related entity types were moved to the trash",
"example": 4000,
"format": "int64",
"type": "integer"
},
"trashedEntitySetCount": {
"description": "The total number of entity sets for which the related entity types were moved to the trash",
"example": 20,
"format": "int64",
"type": "integer"
},
"trashedEntityTypeCount": {
"description": "The total number of (custom) entity types that were moved to the trash",
"example": 8,
"format": "int64",
"type": "integer"
},
"trashedIndexCount": {
"description": "The total number of indexes for which the related entity types were moved to the trash",
"example": 10,
"format": "int64",
"type": "integer"
},
"trashedIndexSize": {
"description": "The total size of all indexes for which the related entity types were moved to the trash (KiB)",
"example": 8192,
"format": "int64",
"type": "integer"
},
"trashedModelCount": {
"description": "The total number of custom models that were moved to the trash",
"example": 2,
"format": "int64",
"type": "integer"
}
},
"type": "object"
}
},
"title": "The statistics of a tenant database",
"type": "object"
}
]
}
}
}
}
---
id: businessobjects.AppSubscribed
name: AppSubscribed
version: 1.0.0
summary: "Indicates that a tenant has successfully subscribed to Business Objects"
producers:
- businessobjects
consumers: []
schemaPath: 'schema.json'
---
# AppSubscribed
Indicates that a tenant has successfully subscribed to Business Objects
## Base Schema
All analytics events are based on the **TrackEvent** schema which provides common properties like `messageId`, `userId`, `context`, timestamps, and more.
**Base Schema Reference**: [analytics-track.yaml](https://event-catalog.prod.otc.fts.d-3.de/schemas/analytics-track.yaml)
## Event-Specific Properties
This schema shows only the event-specific properties that extend the base TrackEvent schema:
## Raw Schema:schema.json
{
"title": "Event-Specific Properties",
"type": "object",
"description": "Properties specific to this event type (extends BaseEvent)",
"extends": "https://event-catalog.int.otc.fts.d-3.de/schemas/analytics-track.yaml#/TrackEvent",
"eventType": "AppSubscribed",
"properties": {
"tn": {
"description": "Unique identifier of the subscribing tenant",
"example": "3b1",
"type": "string"
},
"baseUri": {
"description": "Base URL of the tenant's cloud environment",
"example": "https://example.d-velop.cloud",
"format": "uri",
"type": "string"
},
"received": {
"description": "Timestamp indicating when the tenant's app subscription was received",
"example": "2025-07-08T10:31:11.311Z",
"format": "date-time",
"type": "string"
},
"referenceId": {
"description": "Unique reference identifier of this event instance",
"example": "01JZAGPG76SXYC523XJAA7XNM7",
"type": "string"
},
"comment": {
"description": "Information that the event was backfilled",
"example": "backfilled",
"type": "string"
}
},
"components": {
"schemas": {
"AppPurgeReceivedPayload": {
"allOf": [
{
"$ref": "https://event-catalog.int.otc.fts.d-3.de/schemas/analytics-track.yaml#/TrackEvent"
},
{
"properties": {
"event": {
"const": "AppPurgeReceived"
},
"properties": {
"properties": {
"baseUri": {
"description": "Base URL of the tenant's cloud environment",
"example": "https://example.d-velop.cloud",
"format": "uri",
"type": "string"
},
"comment": {
"description": "Information that the event was backfilled",
"example": "backfilled",
"type": "string"
},
"received": {
"description": "Timestamp indicating when the purge request was received",
"example": "2025-07-08T10:31:11.311Z",
"format": "date-time",
"type": "string"
},
"referenceId": {
"description": "Unique reference identifier of this event instance",
"example": "01JZAGPG76SXYC523XJAA7XNM7",
"type": "string"
},
"tn": {
"description": "Unique identifier of the tenant for which the purge request was received",
"example": "3b1",
"type": "string"
}
},
"type": "object"
}
},
"title": "Specific event properties",
"type": "object"
}
]
},
"AppResubscribedPayload": {
"allOf": [
{
"$ref": "https://event-catalog.int.otc.fts.d-3.de/schemas/analytics-track.yaml#/TrackEvent"
},
{
"properties": {
"event": {
"const": "AppResubscribed"
},
"properties": {
"properties": {
"baseUri": {
"description": "Base URL of the tenant's cloud environment",
"example": "https://example.d-velop.cloud",
"format": "uri",
"type": "string"
},
"comment": {
"description": "Information that the event was backfilled",
"example": "backfilled",
"type": "string"
},
"received": {
"description": "Timestamp indicating when the tenant's app re-subscription was received",
"example": "2025-07-08T10:31:11.311Z",
"format": "date-time",
"type": "string"
},
"referenceId": {
"description": "Unique reference identifier of this event instance",
"example": "01JZAGPG76SXYC523XJAA7XNM7",
"type": "string"
},
"tn": {
"description": "Unique identifier of the re-subscribing tenant",
"example": "3b1",
"type": "string"
}
},
"type": "object"
}
},
"title": "Specific event properties",
"type": "object"
}
]
},
"AppSubscribedPayload": {
"allOf": [
{
"$ref": "https://event-catalog.int.otc.fts.d-3.de/schemas/analytics-track.yaml#/TrackEvent"
},
{
"properties": {
"event": {
"const": "AppSubscribed"
},
"properties": {
"properties": {
"baseUri": {
"description": "Base URL of the tenant's cloud environment",
"example": "https://example.d-velop.cloud",
"format": "uri",
"type": "string"
},
"comment": {
"description": "Information that the event was backfilled",
"example": "backfilled",
"type": "string"
},
"received": {
"description": "Timestamp indicating when the tenant's app subscription was received",
"example": "2025-07-08T10:31:11.311Z",
"format": "date-time",
"type": "string"
},
"referenceId": {
"description": "Unique reference identifier of this event instance",
"example": "01JZAGPG76SXYC523XJAA7XNM7",
"type": "string"
},
"tn": {
"description": "Unique identifier of the subscribing tenant",
"example": "3b1",
"type": "string"
}
},
"type": "object"
}
},
"title": "Specific event properties",
"type": "object"
}
]
},
"AppUnsubscribedPayload": {
"allOf": [
{
"$ref": "https://event-catalog.int.otc.fts.d-3.de/schemas/analytics-track.yaml#/TrackEvent"
},
{
"properties": {
"event": {
"const": "AppUnsubscribed"
},
"properties": {
"properties": {
"baseUri": {
"description": "Base URL of the tenant's cloud environment",
"example": "https://example.d-velop.cloud",
"format": "uri",
"type": "string"
},
"comment": {
"description": "Information that the event was backfilled",
"example": "backfilled",
"type": "string"
},
"received": {
"description": "Timestamp indicating when the tenant's app unsubscription was received",
"example": "2025-07-08T10:31:11.311Z",
"format": "date-time",
"type": "string"
},
"referenceId": {
"description": "Unique reference identifier of this event instance",
"example": "01JZAGPG76SXYC523XJAA7XNM7",
"type": "string"
},
"tn": {
"description": "Unique identifier of the unsubscribing tenant",
"example": "3b1",
"type": "string"
}
},
"type": "object"
}
},
"title": "Specific event properties",
"type": "object"
}
]
},
"DatabaseStatisticsBuiltPayload": {
"allOf": [
{
"$ref": "https://event-catalog.int.otc.fts.d-3.de/schemas/analytics-track.yaml#/TrackEvent"
},
{
"properties": {
"event": {
"const": "DatabaseStatisticsBuilt"
},
"properties": {
"properties": {
"comment": {
"description": "Information that the event was backfilled",
"example": "backfilled",
"type": "string"
},
"created": {
"description": "The time the statistics were created",
"example": "2025-11-03T10:31:11.311Z",
"format": "date-time",
"type": "string"
},
"dataSize": {
"description": "The total size of the data in use (KiB)",
"example": 1572864,
"format": "int64",
"type": "integer"
},
"entityCount": {
"description": "The total number of entities in use",
"example": 40000,
"format": "int64",
"type": "integer"
},
"entitySetCount": {
"description": "The total number of entity sets in use",
"example": 1200,
"format": "int64",
"type": "integer"
},
"entityTypeCount": {
"description": "The total number of (custom) entity types in use",
"example": 150,
"format": "int64",
"type": "integer"
},
"id": {
"description": "The unique identifier under which the statistics is stored",
"example": "01JZAGPG76SXYC523XJAA7XNM7",
"type": "string"
},
"indexCount": {
"description": "The total number of indexes in use",
"example": 240,
"format": "int64",
"type": "integer"
},
"indexSize": {
"description": "The total size of all indexes in use (KiB)",
"example": 102400,
"format": "int64",
"type": "integer"
},
"modelCount": {
"description": "The total number of custom models in use",
"example": 25,
"format": "int64",
"type": "integer"
},
"orphanedDataSize": {
"description": "The total size of the orphaned data (KiB)",
"example": 262144,
"format": "int64",
"type": "integer"
},
"orphanedEntityCount": {
"description": "The total number of entities that are orphaned",
"example": 2000,
"format": "int64",
"type": "integer"
},
"orphanedEntitySetCount": {
"description": "The total number of entity sets that are orphaned",
"example": 100,
"format": "int64",
"type": "integer"
},
"orphanedIndexCount": {
"description": "The total number of indexes that are orphaned",
"example": 20,
"format": "int64",
"type": "integer"
},
"orphanedIndexSize": {
"description": "The total size of all orphaned indexes (KiB)",
"example": 12288,
"format": "int64",
"type": "integer"
},
"referenceId": {
"description": "Unique reference identifier of this event instance",
"example": "01JZAGPG76SXYC523XJAA7XNM7",
"type": "string"
},
"tenantCount": {
"description": "The number of tenants included in the statistics",
"example": 150,
"format": "int64",
"type": "integer"
},
"totalDataSize": {
"description": "The total size of the data held in the database (KiB)",
"example": 2097152,
"format": "int64",
"type": "integer"
},
"totalEntityCount": {
"description": "The total number of entities",
"example": 50000,
"format": "int64",
"type": "integer"
},
"totalEntitySetCount": {
"description": "The total number of entity sets",
"example": 1500,
"format": "int64",
"type": "integer"
},
"totalIndexCount": {
"description": "The total number of indexes",
"example": 300,
"format": "int64",
"type": "integer"
},
"totalIndexSize": {
"description": "The total size of all indexes (KiB)",
"example": 131072,
"format": "int64",
"type": "integer"
},
"trashedDataSize": {
"description": "The total size of the data for which the related entity types were moved to the trash (KiB)",
"example": 262144,
"format": "int64",
"type": "integer"
},
"trashedEntityCount": {
"description": "The total number of entities for which the related entity types were moved to the trash",
"example": 8000,
"format": "int64",
"type": "integer"
},
"trashedEntitySetCount": {
"description": "The total number of entity sets for which the related entity types were moved to the trash",
"example": 200,
"format": "int64",
"type": "integer"
},
"trashedEntityTypeCount": {
"description": "The total number of (custom) entity types that were moved to the trash",
"example": 20,
"format": "int64",
"type": "integer"
},
"trashedIndexCount": {
"description": "The total number of indexes for which the related entity types were moved to the trash",
"example": 40,
"format": "int64",
"type": "integer"
},
"trashedIndexSize": {
"description": "The total size of all indexes for which the related entity types were moved to the trash (KiB)",
"example": 16384,
"format": "int64",
"type": "integer"
},
"trashedModelCount": {
"description": "The total number of custom models that were moved to the trash",
"example": 3,
"format": "int64",
"type": "integer"
}
},
"type": "object"
}
},
"title": "Database statistics that summarize the database statistics for all tenants",
"type": "object"
}
]
},
"EntitySetQueryMetricsAggregatedPayload": {
"allOf": [
{
"$ref": "https://event-catalog.int.otc.fts.d-3.de/schemas/analytics-track.yaml#/TrackEvent"
},
{
"description": "This event is emitted after queries have been executed against an entity set and their usage metrics have been aggregated. Aggregation is based on processing time. Metrics are grouped into fixed aggregation windows defined by `aggregationWindowStart` (inclusive) and `aggregationWindowEnd` (exclusive). Queries occurring near window boundaries may be assigned to either adjacent window.\n",
"properties": {
"event": {
"const": "EntitySetQueryMetricsAggregated"
},
"properties": {
"properties": {
"aggregationInterval": {
"description": "Duration of the aggregation window used for this event. Typically equals `aggregationWindowEnd` minus `aggregationWindowStart`. Must be an ISO 8601 duration (e.g. PT30S, PT5M, PT1H).\n",
"example": "PT30S",
"type": "string"
},
"aggregationWindowEnd": {
"description": "End timestamp (exclusive) of the aggregation window.\n",
"example": "2026-02-24T10:00:30Z",
"format": "date-time",
"type": "string"
},
"aggregationWindowStart": {
"description": "Start timestamp (inclusive) of the aggregation window.\n",
"example": "2026-02-24T10:00:00Z",
"format": "date-time",
"type": "string"
},
"dataSource": {
"description": "Identifier of the logical context or model against which the entity set query was executed. A data source groups multiple related entity types and entity sets and represents the functional context of that query.\n",
"example": "crm",
"type": "string"
},
"entitiesReturned": {
"description": "Total number of entities returned across all executed queries for this entity set within the measured scope.\n",
"example": 12509,
"minimum": 0,
"type": "integer"
},
"entitySet": {
"description": "Name of the entity set that was queried.",
"example": "customers",
"type": "string"
},
"functionCounts": {
"description": "Counter array representing how often specific query functions were used. The array index corresponds to the internal FunctionFeatures flag position. Index 0 represents queries without functions. The array contains 41 entries, one for each defined function feature bit, including the `None` and `Unknown` flags.\n",
"example": [
10,
0,
2,
1,
0,
0,
3,
5,
0,
0,
0,
1,
0,
0,
0,
0,
0,
0,
0,
0,
0,
0,
0,
0,
0,
0,
0,
0,
0,
0,
0,
0,
0,
0,
0,
0,
0,
0,
0,
0,
0
],
"items": {
"minimum": 0,
"type": "integer"
},
"maxItems": 41,
"minItems": 41,
"type": "array"
},
"operatorCounts": {
"description": "Counter array representing how often specific filter operators were used. The array index corresponds to the internal OperatorFeatures flag position. Index 0 represents queries without operators. The array contains 19 entries, one for each defined operator feature bit, including the `None` and `Unknown` flags.\n",
"example": [
2,
0,
0,
4,
1,
0,
0,
3,
0,
0,
0,
1,
0,
0,
0,
0,
0,
0,
0
],
"items": {
"minimum": 0,
"type": "integer"
},
"maxItems": 19,
"minItems": 19,
"type": "array"
},
"queryCount": {
"description": "Total number of queries executed for this entity set within the measured scope.",
"example": 133,
"minimum": 0,
"type": "integer"
},
"queryOptionCounts": {
"description": "Counter array representing how often specific query options were used. The array index corresponds to the internal QueryOptionFeatures flag position. Index 0 represents queries without any query options. The array contains 17 entries, one for each defined query option feature bit, including the `None` and `Unknown` flags.\n",
"example": [
5,
0,
3,
0,
1,
0,
0,
2,
0,
0,
0,
1,
0,
0,
0,
0,
0
],
"items": {
"minimum": 0,
"type": "integer"
},
"maxItems": 17,
"minItems": 17,
"type": "array"
},
"schemaNamespace": {
"description": "Logical namespace of the schema in which the queried entity set is defined. Indicates whether the schema is system-provided (e.g. `core`) or tenant-specific (`custom`).\n",
"example": "custom",
"type": "string"
}
},
"type": "object"
}
},
"title": "Entity Set Query Metrics Aggregated Event",
"type": "object"
}
]
},
"EntitySetStatisticsBuiltPayload": {
"allOf": [
{
"$ref": "https://event-catalog.int.otc.fts.d-3.de/schemas/analytics-track.yaml#/TrackEvent"
},
{
"properties": {
"event": {
"const": "EntitySetStatisticsBuilt"
},
"properties": {
"properties": {
"averageEntitySize": {
"description": "The average size of an entity in the entity set",
"example": 2,
"format": "int64",
"type": "integer"
},
"comment": {
"description": "Information that the event was backfilled",
"example": "backfilled",
"type": "string"
},
"dataSize": {
"description": "The size of the data in the entity set (KiB)",
"example": 1024,
"format": "int64",
"type": "integer"
},
"entityCount": {
"description": "The number of entities in the entity set",
"example": 500,
"format": "int64",
"type": "integer"
},
"indexCount": {
"description": "The number of indexes",
"example": 3,
"format": "int64",
"type": "integer"
},
"indexSize": {
"description": "The size of the indexes (KiB)",
"example": 128,
"format": "int64",
"type": "integer"
},
"kind": {
"description": "The kind of the entity set (e.g., trashed, active)",
"example": "active",
"type": "string"
},
"name": {
"description": "The (logical) name of the entity set",
"example": "Products",
"type": "string"
},
"physicalName": {
"description": "The physical name of the entity set",
"example": "products_3b1_collection",
"type": "string"
},
"referenceId": {
"description": "Unique reference identifier of this event instance",
"example": "01JZAGPG76SXYC523XJAA7XNM7",
"type": "string"
},
"tn": {
"description": "Unique identifier of the tenant",
"example": "3b1",
"type": "string"
},
"typeName": {
"description": "The type name of the entities in the entity set",
"example": "Product",
"type": "string"
}
},
"type": "object"
}
},
"title": "The statistics of a tenant entity set",
"type": "object"
}
]
},
"TenantComputedTierChangedPayload": {
"allOf": [
{
"$ref": "https://event-catalog.int.otc.fts.d-3.de/schemas/analytics-track.yaml#/TrackEvent"
},
{
"properties": {
"event": {
"const": "TenantComputedTierChanged"
},
"properties": {
"properties": {
"newTier": {
"description": "The new computed tier of the tenant",
"example": "basic",
"type": "string"
},
"oldTier": {
"description": "The previous computed tier of the tenant",
"example": "standard",
"type": "string"
},
"tierDeterminants": {
"description": "The factors that determined the new tier calculation",
"example": "TotalEntityCount: 925, EntitySetMaxEntityCount: 382",
"type": "string"
},
"tn": {
"description": "Unique identifier of the tenant",
"example": "3b1",
"type": "string"
}
},
"type": "object"
}
},
"title": "Tenant computed tier change event",
"type": "object"
}
]
},
"TenantDatabaseStatisticsBuiltPayload": {
"allOf": [
{
"$ref": "https://event-catalog.int.otc.fts.d-3.de/schemas/analytics-track.yaml#/TrackEvent"
},
{
"properties": {
"event": {
"const": "TenantDatabaseStatisticsBuilt"
},
"properties": {
"properties": {
"created": {
"description": "The time the statistics were created",
"example": "2025-11-03T10:31:11.311Z",
"format": "date-time",
"type": "string"
},
"dataSize": {
"description": "The total size of the data in use (KiB)",
"example": 786432,
"format": "int64",
"type": "integer"
},
"entityCount": {
"description": "The total number of entities in use",
"example": 20000,
"format": "int64",
"type": "integer"
},
"entitySetCount": {
"description": "The total number of entity sets in use",
"example": 120,
"format": "int64",
"type": "integer"
},
"entityTypeCount": {
"description": "The total number of (custom) entity types in use",
"example": 45,
"format": "int64",
"type": "integer"
},
"id": {
"description": "The unique identifier under which the statistics is stored",
"example": "01JZAGPG76SXYC523XJAA7XNM7",
"type": "string"
},
"indexCount": {
"description": "The total number of indexes in use",
"example": 60,
"format": "int64",
"type": "integer"
},
"indexSize": {
"description": "The total size of all indexes in use (KiB)",
"example": 51200,
"format": "int64",
"type": "integer"
},
"modelCount": {
"description": "The total number of custom models in use",
"example": 12,
"format": "int64",
"type": "integer"
},
"orphanedDataSize": {
"description": "The total size of the orphaned data (KiB)",
"example": 131072,
"format": "int64",
"type": "integer"
},
"orphanedEntityCount": {
"description": "The total number of entities that are orphaned",
"example": 1000,
"format": "int64",
"type": "integer"
},
"orphanedEntitySetCount": {
"description": "The total number of entity sets that are orphaned",
"example": 10,
"format": "int64",
"type": "integer"
},
"orphanedIndexCount": {
"description": "The total number of indexes that are orphaned",
"example": 5,
"format": "int64",
"type": "integer"
},
"orphanedIndexSize": {
"description": "The total size of all orphaned indexes (KiB)",
"example": 6144,
"format": "int64",
"type": "integer"
},
"referenceId": {
"description": "Unique reference identifier of this event instance",
"example": "01JZAGPG76SXYC523XJAA7XNM7",
"type": "string"
},
"tenantDatabaseName": {
"description": "The name of the tenant database",
"example": "t_10qg",
"type": "string"
},
"tn": {
"description": "Unique identifier of the tenant",
"example": "3b1",
"type": "string"
},
"totalDataSize": {
"description": "The total size of the data held in the database (KiB)",
"example": 1048576,
"format": "int64",
"type": "integer"
},
"totalEntityCount": {
"description": "The total number of entities",
"example": 25000,
"format": "int64",
"type": "integer"
},
"totalEntitySetCount": {
"description": "The total number of entity sets",
"example": 150,
"format": "int64",
"type": "integer"
},
"totalIndexCount": {
"description": "The total number of indexes",
"example": 75,
"format": "int64",
"type": "integer"
},
"totalIndexSize": {
"description": "The total size of all indexes (KiB)",
"example": 65536,
"format": "int64",
"type": "integer"
},
"trashedDataSize": {
"description": "The total size of the data for which the related entity types were moved to the trash (KiB)",
"example": 131072,
"format": "int64",
"type": "integer"
},
"trashedEntityCount": {
"description": "The total number of entities for which the related entity types were moved to the trash",
"example": 4000,
"format": "int64",
"type": "integer"
},
"trashedEntitySetCount": {
"description": "The total number of entity sets for which the related entity types were moved to the trash",
"example": 20,
"format": "int64",
"type": "integer"
},
"trashedEntityTypeCount": {
"description": "The total number of (custom) entity types that were moved to the trash",
"example": 8,
"format": "int64",
"type": "integer"
},
"trashedIndexCount": {
"description": "The total number of indexes for which the related entity types were moved to the trash",
"example": 10,
"format": "int64",
"type": "integer"
},
"trashedIndexSize": {
"description": "The total size of all indexes for which the related entity types were moved to the trash (KiB)",
"example": 8192,
"format": "int64",
"type": "integer"
},
"trashedModelCount": {
"description": "The total number of custom models that were moved to the trash",
"example": 2,
"format": "int64",
"type": "integer"
}
},
"type": "object"
}
},
"title": "The statistics of a tenant database",
"type": "object"
}
]
}
}
}
}
---
id: businessobjects.AppUnsubscribed
name: AppUnsubscribed
version: 1.0.0
summary: "Indicates that a tenant has unsubscribed from Business Objects"
producers:
- businessobjects
consumers: []
schemaPath: 'schema.json'
---
# AppUnsubscribed
Indicates that a tenant has unsubscribed from Business Objects
## Base Schema
All analytics events are based on the **TrackEvent** schema which provides common properties like `messageId`, `userId`, `context`, timestamps, and more.
**Base Schema Reference**: [analytics-track.yaml](https://event-catalog.prod.otc.fts.d-3.de/schemas/analytics-track.yaml)
## Event-Specific Properties
This schema shows only the event-specific properties that extend the base TrackEvent schema:
## Raw Schema:schema.json
{
"title": "Event-Specific Properties",
"type": "object",
"description": "Properties specific to this event type (extends BaseEvent)",
"extends": "https://event-catalog.int.otc.fts.d-3.de/schemas/analytics-track.yaml#/TrackEvent",
"eventType": "AppUnsubscribed",
"properties": {
"tn": {
"description": "Unique identifier of the unsubscribing tenant",
"example": "3b1",
"type": "string"
},
"baseUri": {
"description": "Base URL of the tenant's cloud environment",
"example": "https://example.d-velop.cloud",
"format": "uri",
"type": "string"
},
"received": {
"description": "Timestamp indicating when the tenant's app unsubscription was received",
"example": "2025-07-08T10:31:11.311Z",
"format": "date-time",
"type": "string"
},
"referenceId": {
"description": "Unique reference identifier of this event instance",
"example": "01JZAGPG76SXYC523XJAA7XNM7",
"type": "string"
},
"comment": {
"description": "Information that the event was backfilled",
"example": "backfilled",
"type": "string"
}
},
"components": {
"schemas": {
"AppPurgeReceivedPayload": {
"allOf": [
{
"$ref": "https://event-catalog.int.otc.fts.d-3.de/schemas/analytics-track.yaml#/TrackEvent"
},
{
"properties": {
"event": {
"const": "AppPurgeReceived"
},
"properties": {
"properties": {
"baseUri": {
"description": "Base URL of the tenant's cloud environment",
"example": "https://example.d-velop.cloud",
"format": "uri",
"type": "string"
},
"comment": {
"description": "Information that the event was backfilled",
"example": "backfilled",
"type": "string"
},
"received": {
"description": "Timestamp indicating when the purge request was received",
"example": "2025-07-08T10:31:11.311Z",
"format": "date-time",
"type": "string"
},
"referenceId": {
"description": "Unique reference identifier of this event instance",
"example": "01JZAGPG76SXYC523XJAA7XNM7",
"type": "string"
},
"tn": {
"description": "Unique identifier of the tenant for which the purge request was received",
"example": "3b1",
"type": "string"
}
},
"type": "object"
}
},
"title": "Specific event properties",
"type": "object"
}
]
},
"AppResubscribedPayload": {
"allOf": [
{
"$ref": "https://event-catalog.int.otc.fts.d-3.de/schemas/analytics-track.yaml#/TrackEvent"
},
{
"properties": {
"event": {
"const": "AppResubscribed"
},
"properties": {
"properties": {
"baseUri": {
"description": "Base URL of the tenant's cloud environment",
"example": "https://example.d-velop.cloud",
"format": "uri",
"type": "string"
},
"comment": {
"description": "Information that the event was backfilled",
"example": "backfilled",
"type": "string"
},
"received": {
"description": "Timestamp indicating when the tenant's app re-subscription was received",
"example": "2025-07-08T10:31:11.311Z",
"format": "date-time",
"type": "string"
},
"referenceId": {
"description": "Unique reference identifier of this event instance",
"example": "01JZAGPG76SXYC523XJAA7XNM7",
"type": "string"
},
"tn": {
"description": "Unique identifier of the re-subscribing tenant",
"example": "3b1",
"type": "string"
}
},
"type": "object"
}
},
"title": "Specific event properties",
"type": "object"
}
]
},
"AppSubscribedPayload": {
"allOf": [
{
"$ref": "https://event-catalog.int.otc.fts.d-3.de/schemas/analytics-track.yaml#/TrackEvent"
},
{
"properties": {
"event": {
"const": "AppSubscribed"
},
"properties": {
"properties": {
"baseUri": {
"description": "Base URL of the tenant's cloud environment",
"example": "https://example.d-velop.cloud",
"format": "uri",
"type": "string"
},
"comment": {
"description": "Information that the event was backfilled",
"example": "backfilled",
"type": "string"
},
"received": {
"description": "Timestamp indicating when the tenant's app subscription was received",
"example": "2025-07-08T10:31:11.311Z",
"format": "date-time",
"type": "string"
},
"referenceId": {
"description": "Unique reference identifier of this event instance",
"example": "01JZAGPG76SXYC523XJAA7XNM7",
"type": "string"
},
"tn": {
"description": "Unique identifier of the subscribing tenant",
"example": "3b1",
"type": "string"
}
},
"type": "object"
}
},
"title": "Specific event properties",
"type": "object"
}
]
},
"AppUnsubscribedPayload": {
"allOf": [
{
"$ref": "https://event-catalog.int.otc.fts.d-3.de/schemas/analytics-track.yaml#/TrackEvent"
},
{
"properties": {
"event": {
"const": "AppUnsubscribed"
},
"properties": {
"properties": {
"baseUri": {
"description": "Base URL of the tenant's cloud environment",
"example": "https://example.d-velop.cloud",
"format": "uri",
"type": "string"
},
"comment": {
"description": "Information that the event was backfilled",
"example": "backfilled",
"type": "string"
},
"received": {
"description": "Timestamp indicating when the tenant's app unsubscription was received",
"example": "2025-07-08T10:31:11.311Z",
"format": "date-time",
"type": "string"
},
"referenceId": {
"description": "Unique reference identifier of this event instance",
"example": "01JZAGPG76SXYC523XJAA7XNM7",
"type": "string"
},
"tn": {
"description": "Unique identifier of the unsubscribing tenant",
"example": "3b1",
"type": "string"
}
},
"type": "object"
}
},
"title": "Specific event properties",
"type": "object"
}
]
},
"DatabaseStatisticsBuiltPayload": {
"allOf": [
{
"$ref": "https://event-catalog.int.otc.fts.d-3.de/schemas/analytics-track.yaml#/TrackEvent"
},
{
"properties": {
"event": {
"const": "DatabaseStatisticsBuilt"
},
"properties": {
"properties": {
"comment": {
"description": "Information that the event was backfilled",
"example": "backfilled",
"type": "string"
},
"created": {
"description": "The time the statistics were created",
"example": "2025-11-03T10:31:11.311Z",
"format": "date-time",
"type": "string"
},
"dataSize": {
"description": "The total size of the data in use (KiB)",
"example": 1572864,
"format": "int64",
"type": "integer"
},
"entityCount": {
"description": "The total number of entities in use",
"example": 40000,
"format": "int64",
"type": "integer"
},
"entitySetCount": {
"description": "The total number of entity sets in use",
"example": 1200,
"format": "int64",
"type": "integer"
},
"entityTypeCount": {
"description": "The total number of (custom) entity types in use",
"example": 150,
"format": "int64",
"type": "integer"
},
"id": {
"description": "The unique identifier under which the statistics is stored",
"example": "01JZAGPG76SXYC523XJAA7XNM7",
"type": "string"
},
"indexCount": {
"description": "The total number of indexes in use",
"example": 240,
"format": "int64",
"type": "integer"
},
"indexSize": {
"description": "The total size of all indexes in use (KiB)",
"example": 102400,
"format": "int64",
"type": "integer"
},
"modelCount": {
"description": "The total number of custom models in use",
"example": 25,
"format": "int64",
"type": "integer"
},
"orphanedDataSize": {
"description": "The total size of the orphaned data (KiB)",
"example": 262144,
"format": "int64",
"type": "integer"
},
"orphanedEntityCount": {
"description": "The total number of entities that are orphaned",
"example": 2000,
"format": "int64",
"type": "integer"
},
"orphanedEntitySetCount": {
"description": "The total number of entity sets that are orphaned",
"example": 100,
"format": "int64",
"type": "integer"
},
"orphanedIndexCount": {
"description": "The total number of indexes that are orphaned",
"example": 20,
"format": "int64",
"type": "integer"
},
"orphanedIndexSize": {
"description": "The total size of all orphaned indexes (KiB)",
"example": 12288,
"format": "int64",
"type": "integer"
},
"referenceId": {
"description": "Unique reference identifier of this event instance",
"example": "01JZAGPG76SXYC523XJAA7XNM7",
"type": "string"
},
"tenantCount": {
"description": "The number of tenants included in the statistics",
"example": 150,
"format": "int64",
"type": "integer"
},
"totalDataSize": {
"description": "The total size of the data held in the database (KiB)",
"example": 2097152,
"format": "int64",
"type": "integer"
},
"totalEntityCount": {
"description": "The total number of entities",
"example": 50000,
"format": "int64",
"type": "integer"
},
"totalEntitySetCount": {
"description": "The total number of entity sets",
"example": 1500,
"format": "int64",
"type": "integer"
},
"totalIndexCount": {
"description": "The total number of indexes",
"example": 300,
"format": "int64",
"type": "integer"
},
"totalIndexSize": {
"description": "The total size of all indexes (KiB)",
"example": 131072,
"format": "int64",
"type": "integer"
},
"trashedDataSize": {
"description": "The total size of the data for which the related entity types were moved to the trash (KiB)",
"example": 262144,
"format": "int64",
"type": "integer"
},
"trashedEntityCount": {
"description": "The total number of entities for which the related entity types were moved to the trash",
"example": 8000,
"format": "int64",
"type": "integer"
},
"trashedEntitySetCount": {
"description": "The total number of entity sets for which the related entity types were moved to the trash",
"example": 200,
"format": "int64",
"type": "integer"
},
"trashedEntityTypeCount": {
"description": "The total number of (custom) entity types that were moved to the trash",
"example": 20,
"format": "int64",
"type": "integer"
},
"trashedIndexCount": {
"description": "The total number of indexes for which the related entity types were moved to the trash",
"example": 40,
"format": "int64",
"type": "integer"
},
"trashedIndexSize": {
"description": "The total size of all indexes for which the related entity types were moved to the trash (KiB)",
"example": 16384,
"format": "int64",
"type": "integer"
},
"trashedModelCount": {
"description": "The total number of custom models that were moved to the trash",
"example": 3,
"format": "int64",
"type": "integer"
}
},
"type": "object"
}
},
"title": "Database statistics that summarize the database statistics for all tenants",
"type": "object"
}
]
},
"EntitySetQueryMetricsAggregatedPayload": {
"allOf": [
{
"$ref": "https://event-catalog.int.otc.fts.d-3.de/schemas/analytics-track.yaml#/TrackEvent"
},
{
"description": "This event is emitted after queries have been executed against an entity set and their usage metrics have been aggregated. Aggregation is based on processing time. Metrics are grouped into fixed aggregation windows defined by `aggregationWindowStart` (inclusive) and `aggregationWindowEnd` (exclusive). Queries occurring near window boundaries may be assigned to either adjacent window.\n",
"properties": {
"event": {
"const": "EntitySetQueryMetricsAggregated"
},
"properties": {
"properties": {
"aggregationInterval": {
"description": "Duration of the aggregation window used for this event. Typically equals `aggregationWindowEnd` minus `aggregationWindowStart`. Must be an ISO 8601 duration (e.g. PT30S, PT5M, PT1H).\n",
"example": "PT30S",
"type": "string"
},
"aggregationWindowEnd": {
"description": "End timestamp (exclusive) of the aggregation window.\n",
"example": "2026-02-24T10:00:30Z",
"format": "date-time",
"type": "string"
},
"aggregationWindowStart": {
"description": "Start timestamp (inclusive) of the aggregation window.\n",
"example": "2026-02-24T10:00:00Z",
"format": "date-time",
"type": "string"
},
"dataSource": {
"description": "Identifier of the logical context or model against which the entity set query was executed. A data source groups multiple related entity types and entity sets and represents the functional context of that query.\n",
"example": "crm",
"type": "string"
},
"entitiesReturned": {
"description": "Total number of entities returned across all executed queries for this entity set within the measured scope.\n",
"example": 12509,
"minimum": 0,
"type": "integer"
},
"entitySet": {
"description": "Name of the entity set that was queried.",
"example": "customers",
"type": "string"
},
"functionCounts": {
"description": "Counter array representing how often specific query functions were used. The array index corresponds to the internal FunctionFeatures flag position. Index 0 represents queries without functions. The array contains 41 entries, one for each defined function feature bit, including the `None` and `Unknown` flags.\n",
"example": [
10,
0,
2,
1,
0,
0,
3,
5,
0,
0,
0,
1,
0,
0,
0,
0,
0,
0,
0,
0,
0,
0,
0,
0,
0,
0,
0,
0,
0,
0,
0,
0,
0,
0,
0,
0,
0,
0,
0,
0,
0
],
"items": {
"minimum": 0,
"type": "integer"
},
"maxItems": 41,
"minItems": 41,
"type": "array"
},
"operatorCounts": {
"description": "Counter array representing how often specific filter operators were used. The array index corresponds to the internal OperatorFeatures flag position. Index 0 represents queries without operators. The array contains 19 entries, one for each defined operator feature bit, including the `None` and `Unknown` flags.\n",
"example": [
2,
0,
0,
4,
1,
0,
0,
3,
0,
0,
0,
1,
0,
0,
0,
0,
0,
0,
0
],
"items": {
"minimum": 0,
"type": "integer"
},
"maxItems": 19,
"minItems": 19,
"type": "array"
},
"queryCount": {
"description": "Total number of queries executed for this entity set within the measured scope.",
"example": 133,
"minimum": 0,
"type": "integer"
},
"queryOptionCounts": {
"description": "Counter array representing how often specific query options were used. The array index corresponds to the internal QueryOptionFeatures flag position. Index 0 represents queries without any query options. The array contains 17 entries, one for each defined query option feature bit, including the `None` and `Unknown` flags.\n",
"example": [
5,
0,
3,
0,
1,
0,
0,
2,
0,
0,
0,
1,
0,
0,
0,
0,
0
],
"items": {
"minimum": 0,
"type": "integer"
},
"maxItems": 17,
"minItems": 17,
"type": "array"
},
"schemaNamespace": {
"description": "Logical namespace of the schema in which the queried entity set is defined. Indicates whether the schema is system-provided (e.g. `core`) or tenant-specific (`custom`).\n",
"example": "custom",
"type": "string"
}
},
"type": "object"
}
},
"title": "Entity Set Query Metrics Aggregated Event",
"type": "object"
}
]
},
"EntitySetStatisticsBuiltPayload": {
"allOf": [
{
"$ref": "https://event-catalog.int.otc.fts.d-3.de/schemas/analytics-track.yaml#/TrackEvent"
},
{
"properties": {
"event": {
"const": "EntitySetStatisticsBuilt"
},
"properties": {
"properties": {
"averageEntitySize": {
"description": "The average size of an entity in the entity set",
"example": 2,
"format": "int64",
"type": "integer"
},
"comment": {
"description": "Information that the event was backfilled",
"example": "backfilled",
"type": "string"
},
"dataSize": {
"description": "The size of the data in the entity set (KiB)",
"example": 1024,
"format": "int64",
"type": "integer"
},
"entityCount": {
"description": "The number of entities in the entity set",
"example": 500,
"format": "int64",
"type": "integer"
},
"indexCount": {
"description": "The number of indexes",
"example": 3,
"format": "int64",
"type": "integer"
},
"indexSize": {
"description": "The size of the indexes (KiB)",
"example": 128,
"format": "int64",
"type": "integer"
},
"kind": {
"description": "The kind of the entity set (e.g., trashed, active)",
"example": "active",
"type": "string"
},
"name": {
"description": "The (logical) name of the entity set",
"example": "Products",
"type": "string"
},
"physicalName": {
"description": "The physical name of the entity set",
"example": "products_3b1_collection",
"type": "string"
},
"referenceId": {
"description": "Unique reference identifier of this event instance",
"example": "01JZAGPG76SXYC523XJAA7XNM7",
"type": "string"
},
"tn": {
"description": "Unique identifier of the tenant",
"example": "3b1",
"type": "string"
},
"typeName": {
"description": "The type name of the entities in the entity set",
"example": "Product",
"type": "string"
}
},
"type": "object"
}
},
"title": "The statistics of a tenant entity set",
"type": "object"
}
]
},
"TenantComputedTierChangedPayload": {
"allOf": [
{
"$ref": "https://event-catalog.int.otc.fts.d-3.de/schemas/analytics-track.yaml#/TrackEvent"
},
{
"properties": {
"event": {
"const": "TenantComputedTierChanged"
},
"properties": {
"properties": {
"newTier": {
"description": "The new computed tier of the tenant",
"example": "basic",
"type": "string"
},
"oldTier": {
"description": "The previous computed tier of the tenant",
"example": "standard",
"type": "string"
},
"tierDeterminants": {
"description": "The factors that determined the new tier calculation",
"example": "TotalEntityCount: 925, EntitySetMaxEntityCount: 382",
"type": "string"
},
"tn": {
"description": "Unique identifier of the tenant",
"example": "3b1",
"type": "string"
}
},
"type": "object"
}
},
"title": "Tenant computed tier change event",
"type": "object"
}
]
},
"TenantDatabaseStatisticsBuiltPayload": {
"allOf": [
{
"$ref": "https://event-catalog.int.otc.fts.d-3.de/schemas/analytics-track.yaml#/TrackEvent"
},
{
"properties": {
"event": {
"const": "TenantDatabaseStatisticsBuilt"
},
"properties": {
"properties": {
"created": {
"description": "The time the statistics were created",
"example": "2025-11-03T10:31:11.311Z",
"format": "date-time",
"type": "string"
},
"dataSize": {
"description": "The total size of the data in use (KiB)",
"example": 786432,
"format": "int64",
"type": "integer"
},
"entityCount": {
"description": "The total number of entities in use",
"example": 20000,
"format": "int64",
"type": "integer"
},
"entitySetCount": {
"description": "The total number of entity sets in use",
"example": 120,
"format": "int64",
"type": "integer"
},
"entityTypeCount": {
"description": "The total number of (custom) entity types in use",
"example": 45,
"format": "int64",
"type": "integer"
},
"id": {
"description": "The unique identifier under which the statistics is stored",
"example": "01JZAGPG76SXYC523XJAA7XNM7",
"type": "string"
},
"indexCount": {
"description": "The total number of indexes in use",
"example": 60,
"format": "int64",
"type": "integer"
},
"indexSize": {
"description": "The total size of all indexes in use (KiB)",
"example": 51200,
"format": "int64",
"type": "integer"
},
"modelCount": {
"description": "The total number of custom models in use",
"example": 12,
"format": "int64",
"type": "integer"
},
"orphanedDataSize": {
"description": "The total size of the orphaned data (KiB)",
"example": 131072,
"format": "int64",
"type": "integer"
},
"orphanedEntityCount": {
"description": "The total number of entities that are orphaned",
"example": 1000,
"format": "int64",
"type": "integer"
},
"orphanedEntitySetCount": {
"description": "The total number of entity sets that are orphaned",
"example": 10,
"format": "int64",
"type": "integer"
},
"orphanedIndexCount": {
"description": "The total number of indexes that are orphaned",
"example": 5,
"format": "int64",
"type": "integer"
},
"orphanedIndexSize": {
"description": "The total size of all orphaned indexes (KiB)",
"example": 6144,
"format": "int64",
"type": "integer"
},
"referenceId": {
"description": "Unique reference identifier of this event instance",
"example": "01JZAGPG76SXYC523XJAA7XNM7",
"type": "string"
},
"tenantDatabaseName": {
"description": "The name of the tenant database",
"example": "t_10qg",
"type": "string"
},
"tn": {
"description": "Unique identifier of the tenant",
"example": "3b1",
"type": "string"
},
"totalDataSize": {
"description": "The total size of the data held in the database (KiB)",
"example": 1048576,
"format": "int64",
"type": "integer"
},
"totalEntityCount": {
"description": "The total number of entities",
"example": 25000,
"format": "int64",
"type": "integer"
},
"totalEntitySetCount": {
"description": "The total number of entity sets",
"example": 150,
"format": "int64",
"type": "integer"
},
"totalIndexCount": {
"description": "The total number of indexes",
"example": 75,
"format": "int64",
"type": "integer"
},
"totalIndexSize": {
"description": "The total size of all indexes (KiB)",
"example": 65536,
"format": "int64",
"type": "integer"
},
"trashedDataSize": {
"description": "The total size of the data for which the related entity types were moved to the trash (KiB)",
"example": 131072,
"format": "int64",
"type": "integer"
},
"trashedEntityCount": {
"description": "The total number of entities for which the related entity types were moved to the trash",
"example": 4000,
"format": "int64",
"type": "integer"
},
"trashedEntitySetCount": {
"description": "The total number of entity sets for which the related entity types were moved to the trash",
"example": 20,
"format": "int64",
"type": "integer"
},
"trashedEntityTypeCount": {
"description": "The total number of (custom) entity types that were moved to the trash",
"example": 8,
"format": "int64",
"type": "integer"
},
"trashedIndexCount": {
"description": "The total number of indexes for which the related entity types were moved to the trash",
"example": 10,
"format": "int64",
"type": "integer"
},
"trashedIndexSize": {
"description": "The total size of all indexes for which the related entity types were moved to the trash (KiB)",
"example": 8192,
"format": "int64",
"type": "integer"
},
"trashedModelCount": {
"description": "The total number of custom models that were moved to the trash",
"example": 2,
"format": "int64",
"type": "integer"
}
},
"type": "object"
}
},
"title": "The statistics of a tenant database",
"type": "object"
}
]
}
}
}
}
---
id: businessobjects.DatabaseStatisticsBuilt
name: DatabaseStatisticsBuilt
version: 1.0.0
summary: "Indicates that database statistics have been successfully built"
producers:
- businessobjects
consumers: []
schemaPath: 'schema.json'
---
# DatabaseStatisticsBuilt
Indicates that database statistics have been successfully built
## Base Schema
All analytics events are based on the **TrackEvent** schema which provides common properties like `messageId`, `userId`, `context`, timestamps, and more.
**Base Schema Reference**: [analytics-track.yaml](https://event-catalog.prod.otc.fts.d-3.de/schemas/analytics-track.yaml)
## Event-Specific Properties
This schema shows only the event-specific properties that extend the base TrackEvent schema:
## Raw Schema:schema.json
{
"title": "Event-Specific Properties",
"type": "object",
"description": "Properties specific to this event type (extends BaseEvent)",
"extends": "https://event-catalog.int.otc.fts.d-3.de/schemas/analytics-track.yaml#/TrackEvent",
"eventType": "DatabaseStatisticsBuilt",
"properties": {
"trashedEntitySetCount": {
"description": "The total number of entity sets for which the related entity types were moved to the trash",
"example": 200,
"format": "int64",
"type": "integer"
},
"orphanedEntitySetCount": {
"description": "The total number of entity sets that are orphaned",
"example": 100,
"format": "int64",
"type": "integer"
},
"totalEntityCount": {
"description": "The total number of entities",
"example": 50000,
"format": "int64",
"type": "integer"
},
"entitySetCount": {
"description": "The total number of entity sets in use",
"example": 1200,
"format": "int64",
"type": "integer"
},
"indexSize": {
"description": "The total size of all indexes in use (KiB)",
"example": 102400,
"format": "int64",
"type": "integer"
},
"comment": {
"description": "Information that the event was backfilled",
"example": "backfilled",
"type": "string"
},
"totalIndexCount": {
"description": "The total number of indexes",
"example": 300,
"format": "int64",
"type": "integer"
},
"modelCount": {
"description": "The total number of custom models in use",
"example": 25,
"format": "int64",
"type": "integer"
},
"orphanedDataSize": {
"description": "The total size of the orphaned data (KiB)",
"example": 262144,
"format": "int64",
"type": "integer"
},
"totalEntitySetCount": {
"description": "The total number of entity sets",
"example": 1500,
"format": "int64",
"type": "integer"
},
"entityTypeCount": {
"description": "The total number of (custom) entity types in use",
"example": 150,
"format": "int64",
"type": "integer"
},
"entityCount": {
"description": "The total number of entities in use",
"example": 40000,
"format": "int64",
"type": "integer"
},
"dataSize": {
"description": "The total size of the data in use (KiB)",
"example": 1572864,
"format": "int64",
"type": "integer"
},
"trashedModelCount": {
"description": "The total number of custom models that were moved to the trash",
"example": 3,
"format": "int64",
"type": "integer"
},
"trashedDataSize": {
"description": "The total size of the data for which the related entity types were moved to the trash (KiB)",
"example": 262144,
"format": "int64",
"type": "integer"
},
"trashedIndexSize": {
"description": "The total size of all indexes for which the related entity types were moved to the trash (KiB)",
"example": 16384,
"format": "int64",
"type": "integer"
},
"trashedIndexCount": {
"description": "The total number of indexes for which the related entity types were moved to the trash",
"example": 40,
"format": "int64",
"type": "integer"
},
"orphanedIndexCount": {
"description": "The total number of indexes that are orphaned",
"example": 20,
"format": "int64",
"type": "integer"
},
"trashedEntityTypeCount": {
"description": "The total number of (custom) entity types that were moved to the trash",
"example": 20,
"format": "int64",
"type": "integer"
},
"referenceId": {
"description": "Unique reference identifier of this event instance",
"example": "01JZAGPG76SXYC523XJAA7XNM7",
"type": "string"
},
"created": {
"description": "The time the statistics were created",
"example": "2025-11-03T10:31:11.311Z",
"format": "date-time",
"type": "string"
},
"tenantCount": {
"description": "The number of tenants included in the statistics",
"example": 150,
"format": "int64",
"type": "integer"
},
"indexCount": {
"description": "The total number of indexes in use",
"example": 240,
"format": "int64",
"type": "integer"
},
"orphanedEntityCount": {
"description": "The total number of entities that are orphaned",
"example": 2000,
"format": "int64",
"type": "integer"
},
"id": {
"description": "The unique identifier under which the statistics is stored",
"example": "01JZAGPG76SXYC523XJAA7XNM7",
"type": "string"
},
"totalDataSize": {
"description": "The total size of the data held in the database (KiB)",
"example": 2097152,
"format": "int64",
"type": "integer"
},
"trashedEntityCount": {
"description": "The total number of entities for which the related entity types were moved to the trash",
"example": 8000,
"format": "int64",
"type": "integer"
},
"orphanedIndexSize": {
"description": "The total size of all orphaned indexes (KiB)",
"example": 12288,
"format": "int64",
"type": "integer"
},
"totalIndexSize": {
"description": "The total size of all indexes (KiB)",
"example": 131072,
"format": "int64",
"type": "integer"
}
},
"components": {
"schemas": {
"AppPurgeReceivedPayload": {
"allOf": [
{
"$ref": "https://event-catalog.int.otc.fts.d-3.de/schemas/analytics-track.yaml#/TrackEvent"
},
{
"properties": {
"event": {
"const": "AppPurgeReceived"
},
"properties": {
"properties": {
"baseUri": {
"description": "Base URL of the tenant's cloud environment",
"example": "https://example.d-velop.cloud",
"format": "uri",
"type": "string"
},
"comment": {
"description": "Information that the event was backfilled",
"example": "backfilled",
"type": "string"
},
"received": {
"description": "Timestamp indicating when the purge request was received",
"example": "2025-07-08T10:31:11.311Z",
"format": "date-time",
"type": "string"
},
"referenceId": {
"description": "Unique reference identifier of this event instance",
"example": "01JZAGPG76SXYC523XJAA7XNM7",
"type": "string"
},
"tn": {
"description": "Unique identifier of the tenant for which the purge request was received",
"example": "3b1",
"type": "string"
}
},
"type": "object"
}
},
"title": "Specific event properties",
"type": "object"
}
]
},
"AppResubscribedPayload": {
"allOf": [
{
"$ref": "https://event-catalog.int.otc.fts.d-3.de/schemas/analytics-track.yaml#/TrackEvent"
},
{
"properties": {
"event": {
"const": "AppResubscribed"
},
"properties": {
"properties": {
"baseUri": {
"description": "Base URL of the tenant's cloud environment",
"example": "https://example.d-velop.cloud",
"format": "uri",
"type": "string"
},
"comment": {
"description": "Information that the event was backfilled",
"example": "backfilled",
"type": "string"
},
"received": {
"description": "Timestamp indicating when the tenant's app re-subscription was received",
"example": "2025-07-08T10:31:11.311Z",
"format": "date-time",
"type": "string"
},
"referenceId": {
"description": "Unique reference identifier of this event instance",
"example": "01JZAGPG76SXYC523XJAA7XNM7",
"type": "string"
},
"tn": {
"description": "Unique identifier of the re-subscribing tenant",
"example": "3b1",
"type": "string"
}
},
"type": "object"
}
},
"title": "Specific event properties",
"type": "object"
}
]
},
"AppSubscribedPayload": {
"allOf": [
{
"$ref": "https://event-catalog.int.otc.fts.d-3.de/schemas/analytics-track.yaml#/TrackEvent"
},
{
"properties": {
"event": {
"const": "AppSubscribed"
},
"properties": {
"properties": {
"baseUri": {
"description": "Base URL of the tenant's cloud environment",
"example": "https://example.d-velop.cloud",
"format": "uri",
"type": "string"
},
"comment": {
"description": "Information that the event was backfilled",
"example": "backfilled",
"type": "string"
},
"received": {
"description": "Timestamp indicating when the tenant's app subscription was received",
"example": "2025-07-08T10:31:11.311Z",
"format": "date-time",
"type": "string"
},
"referenceId": {
"description": "Unique reference identifier of this event instance",
"example": "01JZAGPG76SXYC523XJAA7XNM7",
"type": "string"
},
"tn": {
"description": "Unique identifier of the subscribing tenant",
"example": "3b1",
"type": "string"
}
},
"type": "object"
}
},
"title": "Specific event properties",
"type": "object"
}
]
},
"AppUnsubscribedPayload": {
"allOf": [
{
"$ref": "https://event-catalog.int.otc.fts.d-3.de/schemas/analytics-track.yaml#/TrackEvent"
},
{
"properties": {
"event": {
"const": "AppUnsubscribed"
},
"properties": {
"properties": {
"baseUri": {
"description": "Base URL of the tenant's cloud environment",
"example": "https://example.d-velop.cloud",
"format": "uri",
"type": "string"
},
"comment": {
"description": "Information that the event was backfilled",
"example": "backfilled",
"type": "string"
},
"received": {
"description": "Timestamp indicating when the tenant's app unsubscription was received",
"example": "2025-07-08T10:31:11.311Z",
"format": "date-time",
"type": "string"
},
"referenceId": {
"description": "Unique reference identifier of this event instance",
"example": "01JZAGPG76SXYC523XJAA7XNM7",
"type": "string"
},
"tn": {
"description": "Unique identifier of the unsubscribing tenant",
"example": "3b1",
"type": "string"
}
},
"type": "object"
}
},
"title": "Specific event properties",
"type": "object"
}
]
},
"DatabaseStatisticsBuiltPayload": {
"allOf": [
{
"$ref": "https://event-catalog.int.otc.fts.d-3.de/schemas/analytics-track.yaml#/TrackEvent"
},
{
"properties": {
"event": {
"const": "DatabaseStatisticsBuilt"
},
"properties": {
"properties": {
"comment": {
"description": "Information that the event was backfilled",
"example": "backfilled",
"type": "string"
},
"created": {
"description": "The time the statistics were created",
"example": "2025-11-03T10:31:11.311Z",
"format": "date-time",
"type": "string"
},
"dataSize": {
"description": "The total size of the data in use (KiB)",
"example": 1572864,
"format": "int64",
"type": "integer"
},
"entityCount": {
"description": "The total number of entities in use",
"example": 40000,
"format": "int64",
"type": "integer"
},
"entitySetCount": {
"description": "The total number of entity sets in use",
"example": 1200,
"format": "int64",
"type": "integer"
},
"entityTypeCount": {
"description": "The total number of (custom) entity types in use",
"example": 150,
"format": "int64",
"type": "integer"
},
"id": {
"description": "The unique identifier under which the statistics is stored",
"example": "01JZAGPG76SXYC523XJAA7XNM7",
"type": "string"
},
"indexCount": {
"description": "The total number of indexes in use",
"example": 240,
"format": "int64",
"type": "integer"
},
"indexSize": {
"description": "The total size of all indexes in use (KiB)",
"example": 102400,
"format": "int64",
"type": "integer"
},
"modelCount": {
"description": "The total number of custom models in use",
"example": 25,
"format": "int64",
"type": "integer"
},
"orphanedDataSize": {
"description": "The total size of the orphaned data (KiB)",
"example": 262144,
"format": "int64",
"type": "integer"
},
"orphanedEntityCount": {
"description": "The total number of entities that are orphaned",
"example": 2000,
"format": "int64",
"type": "integer"
},
"orphanedEntitySetCount": {
"description": "The total number of entity sets that are orphaned",
"example": 100,
"format": "int64",
"type": "integer"
},
"orphanedIndexCount": {
"description": "The total number of indexes that are orphaned",
"example": 20,
"format": "int64",
"type": "integer"
},
"orphanedIndexSize": {
"description": "The total size of all orphaned indexes (KiB)",
"example": 12288,
"format": "int64",
"type": "integer"
},
"referenceId": {
"description": "Unique reference identifier of this event instance",
"example": "01JZAGPG76SXYC523XJAA7XNM7",
"type": "string"
},
"tenantCount": {
"description": "The number of tenants included in the statistics",
"example": 150,
"format": "int64",
"type": "integer"
},
"totalDataSize": {
"description": "The total size of the data held in the database (KiB)",
"example": 2097152,
"format": "int64",
"type": "integer"
},
"totalEntityCount": {
"description": "The total number of entities",
"example": 50000,
"format": "int64",
"type": "integer"
},
"totalEntitySetCount": {
"description": "The total number of entity sets",
"example": 1500,
"format": "int64",
"type": "integer"
},
"totalIndexCount": {
"description": "The total number of indexes",
"example": 300,
"format": "int64",
"type": "integer"
},
"totalIndexSize": {
"description": "The total size of all indexes (KiB)",
"example": 131072,
"format": "int64",
"type": "integer"
},
"trashedDataSize": {
"description": "The total size of the data for which the related entity types were moved to the trash (KiB)",
"example": 262144,
"format": "int64",
"type": "integer"
},
"trashedEntityCount": {
"description": "The total number of entities for which the related entity types were moved to the trash",
"example": 8000,
"format": "int64",
"type": "integer"
},
"trashedEntitySetCount": {
"description": "The total number of entity sets for which the related entity types were moved to the trash",
"example": 200,
"format": "int64",
"type": "integer"
},
"trashedEntityTypeCount": {
"description": "The total number of (custom) entity types that were moved to the trash",
"example": 20,
"format": "int64",
"type": "integer"
},
"trashedIndexCount": {
"description": "The total number of indexes for which the related entity types were moved to the trash",
"example": 40,
"format": "int64",
"type": "integer"
},
"trashedIndexSize": {
"description": "The total size of all indexes for which the related entity types were moved to the trash (KiB)",
"example": 16384,
"format": "int64",
"type": "integer"
},
"trashedModelCount": {
"description": "The total number of custom models that were moved to the trash",
"example": 3,
"format": "int64",
"type": "integer"
}
},
"type": "object"
}
},
"title": "Database statistics that summarize the database statistics for all tenants",
"type": "object"
}
]
},
"EntitySetQueryMetricsAggregatedPayload": {
"allOf": [
{
"$ref": "https://event-catalog.int.otc.fts.d-3.de/schemas/analytics-track.yaml#/TrackEvent"
},
{
"description": "This event is emitted after queries have been executed against an entity set and their usage metrics have been aggregated. Aggregation is based on processing time. Metrics are grouped into fixed aggregation windows defined by `aggregationWindowStart` (inclusive) and `aggregationWindowEnd` (exclusive). Queries occurring near window boundaries may be assigned to either adjacent window.\n",
"properties": {
"event": {
"const": "EntitySetQueryMetricsAggregated"
},
"properties": {
"properties": {
"aggregationInterval": {
"description": "Duration of the aggregation window used for this event. Typically equals `aggregationWindowEnd` minus `aggregationWindowStart`. Must be an ISO 8601 duration (e.g. PT30S, PT5M, PT1H).\n",
"example": "PT30S",
"type": "string"
},
"aggregationWindowEnd": {
"description": "End timestamp (exclusive) of the aggregation window.\n",
"example": "2026-02-24T10:00:30Z",
"format": "date-time",
"type": "string"
},
"aggregationWindowStart": {
"description": "Start timestamp (inclusive) of the aggregation window.\n",
"example": "2026-02-24T10:00:00Z",
"format": "date-time",
"type": "string"
},
"dataSource": {
"description": "Identifier of the logical context or model against which the entity set query was executed. A data source groups multiple related entity types and entity sets and represents the functional context of that query.\n",
"example": "crm",
"type": "string"
},
"entitiesReturned": {
"description": "Total number of entities returned across all executed queries for this entity set within the measured scope.\n",
"example": 12509,
"minimum": 0,
"type": "integer"
},
"entitySet": {
"description": "Name of the entity set that was queried.",
"example": "customers",
"type": "string"
},
"functionCounts": {
"description": "Counter array representing how often specific query functions were used. The array index corresponds to the internal FunctionFeatures flag position. Index 0 represents queries without functions. The array contains 41 entries, one for each defined function feature bit, including the `None` and `Unknown` flags.\n",
"example": [
10,
0,
2,
1,
0,
0,
3,
5,
0,
0,
0,
1,
0,
0,
0,
0,
0,
0,
0,
0,
0,
0,
0,
0,
0,
0,
0,
0,
0,
0,
0,
0,
0,
0,
0,
0,
0,
0,
0,
0,
0
],
"items": {
"minimum": 0,
"type": "integer"
},
"maxItems": 41,
"minItems": 41,
"type": "array"
},
"operatorCounts": {
"description": "Counter array representing how often specific filter operators were used. The array index corresponds to the internal OperatorFeatures flag position. Index 0 represents queries without operators. The array contains 19 entries, one for each defined operator feature bit, including the `None` and `Unknown` flags.\n",
"example": [
2,
0,
0,
4,
1,
0,
0,
3,
0,
0,
0,
1,
0,
0,
0,
0,
0,
0,
0
],
"items": {
"minimum": 0,
"type": "integer"
},
"maxItems": 19,
"minItems": 19,
"type": "array"
},
"queryCount": {
"description": "Total number of queries executed for this entity set within the measured scope.",
"example": 133,
"minimum": 0,
"type": "integer"
},
"queryOptionCounts": {
"description": "Counter array representing how often specific query options were used. The array index corresponds to the internal QueryOptionFeatures flag position. Index 0 represents queries without any query options. The array contains 17 entries, one for each defined query option feature bit, including the `None` and `Unknown` flags.\n",
"example": [
5,
0,
3,
0,
1,
0,
0,
2,
0,
0,
0,
1,
0,
0,
0,
0,
0
],
"items": {
"minimum": 0,
"type": "integer"
},
"maxItems": 17,
"minItems": 17,
"type": "array"
},
"schemaNamespace": {
"description": "Logical namespace of the schema in which the queried entity set is defined. Indicates whether the schema is system-provided (e.g. `core`) or tenant-specific (`custom`).\n",
"example": "custom",
"type": "string"
}
},
"type": "object"
}
},
"title": "Entity Set Query Metrics Aggregated Event",
"type": "object"
}
]
},
"EntitySetStatisticsBuiltPayload": {
"allOf": [
{
"$ref": "https://event-catalog.int.otc.fts.d-3.de/schemas/analytics-track.yaml#/TrackEvent"
},
{
"properties": {
"event": {
"const": "EntitySetStatisticsBuilt"
},
"properties": {
"properties": {
"averageEntitySize": {
"description": "The average size of an entity in the entity set",
"example": 2,
"format": "int64",
"type": "integer"
},
"comment": {
"description": "Information that the event was backfilled",
"example": "backfilled",
"type": "string"
},
"dataSize": {
"description": "The size of the data in the entity set (KiB)",
"example": 1024,
"format": "int64",
"type": "integer"
},
"entityCount": {
"description": "The number of entities in the entity set",
"example": 500,
"format": "int64",
"type": "integer"
},
"indexCount": {
"description": "The number of indexes",
"example": 3,
"format": "int64",
"type": "integer"
},
"indexSize": {
"description": "The size of the indexes (KiB)",
"example": 128,
"format": "int64",
"type": "integer"
},
"kind": {
"description": "The kind of the entity set (e.g., trashed, active)",
"example": "active",
"type": "string"
},
"name": {
"description": "The (logical) name of the entity set",
"example": "Products",
"type": "string"
},
"physicalName": {
"description": "The physical name of the entity set",
"example": "products_3b1_collection",
"type": "string"
},
"referenceId": {
"description": "Unique reference identifier of this event instance",
"example": "01JZAGPG76SXYC523XJAA7XNM7",
"type": "string"
},
"tn": {
"description": "Unique identifier of the tenant",
"example": "3b1",
"type": "string"
},
"typeName": {
"description": "The type name of the entities in the entity set",
"example": "Product",
"type": "string"
}
},
"type": "object"
}
},
"title": "The statistics of a tenant entity set",
"type": "object"
}
]
},
"TenantComputedTierChangedPayload": {
"allOf": [
{
"$ref": "https://event-catalog.int.otc.fts.d-3.de/schemas/analytics-track.yaml#/TrackEvent"
},
{
"properties": {
"event": {
"const": "TenantComputedTierChanged"
},
"properties": {
"properties": {
"newTier": {
"description": "The new computed tier of the tenant",
"example": "basic",
"type": "string"
},
"oldTier": {
"description": "The previous computed tier of the tenant",
"example": "standard",
"type": "string"
},
"tierDeterminants": {
"description": "The factors that determined the new tier calculation",
"example": "TotalEntityCount: 925, EntitySetMaxEntityCount: 382",
"type": "string"
},
"tn": {
"description": "Unique identifier of the tenant",
"example": "3b1",
"type": "string"
}
},
"type": "object"
}
},
"title": "Tenant computed tier change event",
"type": "object"
}
]
},
"TenantDatabaseStatisticsBuiltPayload": {
"allOf": [
{
"$ref": "https://event-catalog.int.otc.fts.d-3.de/schemas/analytics-track.yaml#/TrackEvent"
},
{
"properties": {
"event": {
"const": "TenantDatabaseStatisticsBuilt"
},
"properties": {
"properties": {
"created": {
"description": "The time the statistics were created",
"example": "2025-11-03T10:31:11.311Z",
"format": "date-time",
"type": "string"
},
"dataSize": {
"description": "The total size of the data in use (KiB)",
"example": 786432,
"format": "int64",
"type": "integer"
},
"entityCount": {
"description": "The total number of entities in use",
"example": 20000,
"format": "int64",
"type": "integer"
},
"entitySetCount": {
"description": "The total number of entity sets in use",
"example": 120,
"format": "int64",
"type": "integer"
},
"entityTypeCount": {
"description": "The total number of (custom) entity types in use",
"example": 45,
"format": "int64",
"type": "integer"
},
"id": {
"description": "The unique identifier under which the statistics is stored",
"example": "01JZAGPG76SXYC523XJAA7XNM7",
"type": "string"
},
"indexCount": {
"description": "The total number of indexes in use",
"example": 60,
"format": "int64",
"type": "integer"
},
"indexSize": {
"description": "The total size of all indexes in use (KiB)",
"example": 51200,
"format": "int64",
"type": "integer"
},
"modelCount": {
"description": "The total number of custom models in use",
"example": 12,
"format": "int64",
"type": "integer"
},
"orphanedDataSize": {
"description": "The total size of the orphaned data (KiB)",
"example": 131072,
"format": "int64",
"type": "integer"
},
"orphanedEntityCount": {
"description": "The total number of entities that are orphaned",
"example": 1000,
"format": "int64",
"type": "integer"
},
"orphanedEntitySetCount": {
"description": "The total number of entity sets that are orphaned",
"example": 10,
"format": "int64",
"type": "integer"
},
"orphanedIndexCount": {
"description": "The total number of indexes that are orphaned",
"example": 5,
"format": "int64",
"type": "integer"
},
"orphanedIndexSize": {
"description": "The total size of all orphaned indexes (KiB)",
"example": 6144,
"format": "int64",
"type": "integer"
},
"referenceId": {
"description": "Unique reference identifier of this event instance",
"example": "01JZAGPG76SXYC523XJAA7XNM7",
"type": "string"
},
"tenantDatabaseName": {
"description": "The name of the tenant database",
"example": "t_10qg",
"type": "string"
},
"tn": {
"description": "Unique identifier of the tenant",
"example": "3b1",
"type": "string"
},
"totalDataSize": {
"description": "The total size of the data held in the database (KiB)",
"example": 1048576,
"format": "int64",
"type": "integer"
},
"totalEntityCount": {
"description": "The total number of entities",
"example": 25000,
"format": "int64",
"type": "integer"
},
"totalEntitySetCount": {
"description": "The total number of entity sets",
"example": 150,
"format": "int64",
"type": "integer"
},
"totalIndexCount": {
"description": "The total number of indexes",
"example": 75,
"format": "int64",
"type": "integer"
},
"totalIndexSize": {
"description": "The total size of all indexes (KiB)",
"example": 65536,
"format": "int64",
"type": "integer"
},
"trashedDataSize": {
"description": "The total size of the data for which the related entity types were moved to the trash (KiB)",
"example": 131072,
"format": "int64",
"type": "integer"
},
"trashedEntityCount": {
"description": "The total number of entities for which the related entity types were moved to the trash",
"example": 4000,
"format": "int64",
"type": "integer"
},
"trashedEntitySetCount": {
"description": "The total number of entity sets for which the related entity types were moved to the trash",
"example": 20,
"format": "int64",
"type": "integer"
},
"trashedEntityTypeCount": {
"description": "The total number of (custom) entity types that were moved to the trash",
"example": 8,
"format": "int64",
"type": "integer"
},
"trashedIndexCount": {
"description": "The total number of indexes for which the related entity types were moved to the trash",
"example": 10,
"format": "int64",
"type": "integer"
},
"trashedIndexSize": {
"description": "The total size of all indexes for which the related entity types were moved to the trash (KiB)",
"example": 8192,
"format": "int64",
"type": "integer"
},
"trashedModelCount": {
"description": "The total number of custom models that were moved to the trash",
"example": 2,
"format": "int64",
"type": "integer"
}
},
"type": "object"
}
},
"title": "The statistics of a tenant database",
"type": "object"
}
]
}
}
}
}
---
id: businessobjects.EntitySetQueryMetricsAggregated
name: EntitySetQueryMetricsAggregated
version: 1.0.0
summary: "Emitted after query metrics for an entity set have been aggregated."
producers:
- businessobjects
consumers: []
schemaPath: 'schema.json'
---
# EntitySetQueryMetricsAggregated
Emitted after query metrics for an entity set have been aggregated.
## Base Schema
All analytics events are based on the **TrackEvent** schema which provides common properties like `messageId`, `userId`, `context`, timestamps, and more.
**Base Schema Reference**: [analytics-track.yaml](https://event-catalog.prod.otc.fts.d-3.de/schemas/analytics-track.yaml)
## Event-Specific Properties
This schema shows only the event-specific properties that extend the base TrackEvent schema:
## Raw Schema:schema.json
{
"title": "Event-Specific Properties",
"type": "object",
"description": "Properties specific to this event type (extends BaseEvent)",
"extends": "https://event-catalog.int.otc.fts.d-3.de/schemas/analytics-track.yaml#/TrackEvent",
"eventType": "EntitySetQueryMetricsAggregated",
"properties": {
"operatorCounts": {
"description": "Counter array representing how often specific filter operators were used. The array index corresponds to the internal OperatorFeatures flag position. Index 0 represents queries without operators. The array contains 19 entries, one for each defined operator feature bit, including the `None` and `Unknown` flags.\n",
"example": [
2,
0,
0,
4,
1,
0,
0,
3,
0,
0,
0,
1,
0,
0,
0,
0,
0,
0,
0
],
"items": {
"minimum": 0,
"type": "integer"
},
"maxItems": 19,
"minItems": 19,
"type": "array"
},
"entitiesReturned": {
"description": "Total number of entities returned across all executed queries for this entity set within the measured scope.\n",
"example": 12509,
"minimum": 0,
"type": "integer"
},
"queryCount": {
"description": "Total number of queries executed for this entity set within the measured scope.",
"example": 133,
"minimum": 0,
"type": "integer"
},
"aggregationInterval": {
"description": "Duration of the aggregation window used for this event. Typically equals `aggregationWindowEnd` minus `aggregationWindowStart`. Must be an ISO 8601 duration (e.g. PT30S, PT5M, PT1H).\n",
"example": "PT30S",
"type": "string"
},
"schemaNamespace": {
"description": "Logical namespace of the schema in which the queried entity set is defined. Indicates whether the schema is system-provided (e.g. `core`) or tenant-specific (`custom`).\n",
"example": "custom",
"type": "string"
},
"dataSource": {
"description": "Identifier of the logical context or model against which the entity set query was executed. A data source groups multiple related entity types and entity sets and represents the functional context of that query.\n",
"example": "crm",
"type": "string"
},
"entitySet": {
"description": "Name of the entity set that was queried.",
"example": "customers",
"type": "string"
},
"functionCounts": {
"description": "Counter array representing how often specific query functions were used. The array index corresponds to the internal FunctionFeatures flag position. Index 0 represents queries without functions. The array contains 41 entries, one for each defined function feature bit, including the `None` and `Unknown` flags.\n",
"example": [
10,
0,
2,
1,
0,
0,
3,
5,
0,
0,
0,
1,
0,
0,
0,
0,
0,
0,
0,
0,
0,
0,
0,
0,
0,
0,
0,
0,
0,
0,
0,
0,
0,
0,
0,
0,
0,
0,
0,
0,
0
],
"items": {
"minimum": 0,
"type": "integer"
},
"maxItems": 41,
"minItems": 41,
"type": "array"
},
"aggregationWindowStart": {
"description": "Start timestamp (inclusive) of the aggregation window.\n",
"example": "2026-02-24T10:00:00Z",
"format": "date-time",
"type": "string"
},
"aggregationWindowEnd": {
"description": "End timestamp (exclusive) of the aggregation window.\n",
"example": "2026-02-24T10:00:30Z",
"format": "date-time",
"type": "string"
},
"queryOptionCounts": {
"description": "Counter array representing how often specific query options were used. The array index corresponds to the internal QueryOptionFeatures flag position. Index 0 represents queries without any query options. The array contains 17 entries, one for each defined query option feature bit, including the `None` and `Unknown` flags.\n",
"example": [
5,
0,
3,
0,
1,
0,
0,
2,
0,
0,
0,
1,
0,
0,
0,
0,
0
],
"items": {
"minimum": 0,
"type": "integer"
},
"maxItems": 17,
"minItems": 17,
"type": "array"
}
},
"components": {
"schemas": {
"AppPurgeReceivedPayload": {
"allOf": [
{
"$ref": "https://event-catalog.int.otc.fts.d-3.de/schemas/analytics-track.yaml#/TrackEvent"
},
{
"properties": {
"event": {
"const": "AppPurgeReceived"
},
"properties": {
"properties": {
"baseUri": {
"description": "Base URL of the tenant's cloud environment",
"example": "https://example.d-velop.cloud",
"format": "uri",
"type": "string"
},
"comment": {
"description": "Information that the event was backfilled",
"example": "backfilled",
"type": "string"
},
"received": {
"description": "Timestamp indicating when the purge request was received",
"example": "2025-07-08T10:31:11.311Z",
"format": "date-time",
"type": "string"
},
"referenceId": {
"description": "Unique reference identifier of this event instance",
"example": "01JZAGPG76SXYC523XJAA7XNM7",
"type": "string"
},
"tn": {
"description": "Unique identifier of the tenant for which the purge request was received",
"example": "3b1",
"type": "string"
}
},
"type": "object"
}
},
"title": "Specific event properties",
"type": "object"
}
]
},
"AppResubscribedPayload": {
"allOf": [
{
"$ref": "https://event-catalog.int.otc.fts.d-3.de/schemas/analytics-track.yaml#/TrackEvent"
},
{
"properties": {
"event": {
"const": "AppResubscribed"
},
"properties": {
"properties": {
"baseUri": {
"description": "Base URL of the tenant's cloud environment",
"example": "https://example.d-velop.cloud",
"format": "uri",
"type": "string"
},
"comment": {
"description": "Information that the event was backfilled",
"example": "backfilled",
"type": "string"
},
"received": {
"description": "Timestamp indicating when the tenant's app re-subscription was received",
"example": "2025-07-08T10:31:11.311Z",
"format": "date-time",
"type": "string"
},
"referenceId": {
"description": "Unique reference identifier of this event instance",
"example": "01JZAGPG76SXYC523XJAA7XNM7",
"type": "string"
},
"tn": {
"description": "Unique identifier of the re-subscribing tenant",
"example": "3b1",
"type": "string"
}
},
"type": "object"
}
},
"title": "Specific event properties",
"type": "object"
}
]
},
"AppSubscribedPayload": {
"allOf": [
{
"$ref": "https://event-catalog.int.otc.fts.d-3.de/schemas/analytics-track.yaml#/TrackEvent"
},
{
"properties": {
"event": {
"const": "AppSubscribed"
},
"properties": {
"properties": {
"baseUri": {
"description": "Base URL of the tenant's cloud environment",
"example": "https://example.d-velop.cloud",
"format": "uri",
"type": "string"
},
"comment": {
"description": "Information that the event was backfilled",
"example": "backfilled",
"type": "string"
},
"received": {
"description": "Timestamp indicating when the tenant's app subscription was received",
"example": "2025-07-08T10:31:11.311Z",
"format": "date-time",
"type": "string"
},
"referenceId": {
"description": "Unique reference identifier of this event instance",
"example": "01JZAGPG76SXYC523XJAA7XNM7",
"type": "string"
},
"tn": {
"description": "Unique identifier of the subscribing tenant",
"example": "3b1",
"type": "string"
}
},
"type": "object"
}
},
"title": "Specific event properties",
"type": "object"
}
]
},
"AppUnsubscribedPayload": {
"allOf": [
{
"$ref": "https://event-catalog.int.otc.fts.d-3.de/schemas/analytics-track.yaml#/TrackEvent"
},
{
"properties": {
"event": {
"const": "AppUnsubscribed"
},
"properties": {
"properties": {
"baseUri": {
"description": "Base URL of the tenant's cloud environment",
"example": "https://example.d-velop.cloud",
"format": "uri",
"type": "string"
},
"comment": {
"description": "Information that the event was backfilled",
"example": "backfilled",
"type": "string"
},
"received": {
"description": "Timestamp indicating when the tenant's app unsubscription was received",
"example": "2025-07-08T10:31:11.311Z",
"format": "date-time",
"type": "string"
},
"referenceId": {
"description": "Unique reference identifier of this event instance",
"example": "01JZAGPG76SXYC523XJAA7XNM7",
"type": "string"
},
"tn": {
"description": "Unique identifier of the unsubscribing tenant",
"example": "3b1",
"type": "string"
}
},
"type": "object"
}
},
"title": "Specific event properties",
"type": "object"
}
]
},
"DatabaseStatisticsBuiltPayload": {
"allOf": [
{
"$ref": "https://event-catalog.int.otc.fts.d-3.de/schemas/analytics-track.yaml#/TrackEvent"
},
{
"properties": {
"event": {
"const": "DatabaseStatisticsBuilt"
},
"properties": {
"properties": {
"comment": {
"description": "Information that the event was backfilled",
"example": "backfilled",
"type": "string"
},
"created": {
"description": "The time the statistics were created",
"example": "2025-11-03T10:31:11.311Z",
"format": "date-time",
"type": "string"
},
"dataSize": {
"description": "The total size of the data in use (KiB)",
"example": 1572864,
"format": "int64",
"type": "integer"
},
"entityCount": {
"description": "The total number of entities in use",
"example": 40000,
"format": "int64",
"type": "integer"
},
"entitySetCount": {
"description": "The total number of entity sets in use",
"example": 1200,
"format": "int64",
"type": "integer"
},
"entityTypeCount": {
"description": "The total number of (custom) entity types in use",
"example": 150,
"format": "int64",
"type": "integer"
},
"id": {
"description": "The unique identifier under which the statistics is stored",
"example": "01JZAGPG76SXYC523XJAA7XNM7",
"type": "string"
},
"indexCount": {
"description": "The total number of indexes in use",
"example": 240,
"format": "int64",
"type": "integer"
},
"indexSize": {
"description": "The total size of all indexes in use (KiB)",
"example": 102400,
"format": "int64",
"type": "integer"
},
"modelCount": {
"description": "The total number of custom models in use",
"example": 25,
"format": "int64",
"type": "integer"
},
"orphanedDataSize": {
"description": "The total size of the orphaned data (KiB)",
"example": 262144,
"format": "int64",
"type": "integer"
},
"orphanedEntityCount": {
"description": "The total number of entities that are orphaned",
"example": 2000,
"format": "int64",
"type": "integer"
},
"orphanedEntitySetCount": {
"description": "The total number of entity sets that are orphaned",
"example": 100,
"format": "int64",
"type": "integer"
},
"orphanedIndexCount": {
"description": "The total number of indexes that are orphaned",
"example": 20,
"format": "int64",
"type": "integer"
},
"orphanedIndexSize": {
"description": "The total size of all orphaned indexes (KiB)",
"example": 12288,
"format": "int64",
"type": "integer"
},
"referenceId": {
"description": "Unique reference identifier of this event instance",
"example": "01JZAGPG76SXYC523XJAA7XNM7",
"type": "string"
},
"tenantCount": {
"description": "The number of tenants included in the statistics",
"example": 150,
"format": "int64",
"type": "integer"
},
"totalDataSize": {
"description": "The total size of the data held in the database (KiB)",
"example": 2097152,
"format": "int64",
"type": "integer"
},
"totalEntityCount": {
"description": "The total number of entities",
"example": 50000,
"format": "int64",
"type": "integer"
},
"totalEntitySetCount": {
"description": "The total number of entity sets",
"example": 1500,
"format": "int64",
"type": "integer"
},
"totalIndexCount": {
"description": "The total number of indexes",
"example": 300,
"format": "int64",
"type": "integer"
},
"totalIndexSize": {
"description": "The total size of all indexes (KiB)",
"example": 131072,
"format": "int64",
"type": "integer"
},
"trashedDataSize": {
"description": "The total size of the data for which the related entity types were moved to the trash (KiB)",
"example": 262144,
"format": "int64",
"type": "integer"
},
"trashedEntityCount": {
"description": "The total number of entities for which the related entity types were moved to the trash",
"example": 8000,
"format": "int64",
"type": "integer"
},
"trashedEntitySetCount": {
"description": "The total number of entity sets for which the related entity types were moved to the trash",
"example": 200,
"format": "int64",
"type": "integer"
},
"trashedEntityTypeCount": {
"description": "The total number of (custom) entity types that were moved to the trash",
"example": 20,
"format": "int64",
"type": "integer"
},
"trashedIndexCount": {
"description": "The total number of indexes for which the related entity types were moved to the trash",
"example": 40,
"format": "int64",
"type": "integer"
},
"trashedIndexSize": {
"description": "The total size of all indexes for which the related entity types were moved to the trash (KiB)",
"example": 16384,
"format": "int64",
"type": "integer"
},
"trashedModelCount": {
"description": "The total number of custom models that were moved to the trash",
"example": 3,
"format": "int64",
"type": "integer"
}
},
"type": "object"
}
},
"title": "Database statistics that summarize the database statistics for all tenants",
"type": "object"
}
]
},
"EntitySetQueryMetricsAggregatedPayload": {
"allOf": [
{
"$ref": "https://event-catalog.int.otc.fts.d-3.de/schemas/analytics-track.yaml#/TrackEvent"
},
{
"description": "This event is emitted after queries have been executed against an entity set and their usage metrics have been aggregated. Aggregation is based on processing time. Metrics are grouped into fixed aggregation windows defined by `aggregationWindowStart` (inclusive) and `aggregationWindowEnd` (exclusive). Queries occurring near window boundaries may be assigned to either adjacent window.\n",
"properties": {
"event": {
"const": "EntitySetQueryMetricsAggregated"
},
"properties": {
"properties": {
"aggregationInterval": {
"description": "Duration of the aggregation window used for this event. Typically equals `aggregationWindowEnd` minus `aggregationWindowStart`. Must be an ISO 8601 duration (e.g. PT30S, PT5M, PT1H).\n",
"example": "PT30S",
"type": "string"
},
"aggregationWindowEnd": {
"description": "End timestamp (exclusive) of the aggregation window.\n",
"example": "2026-02-24T10:00:30Z",
"format": "date-time",
"type": "string"
},
"aggregationWindowStart": {
"description": "Start timestamp (inclusive) of the aggregation window.\n",
"example": "2026-02-24T10:00:00Z",
"format": "date-time",
"type": "string"
},
"dataSource": {
"description": "Identifier of the logical context or model against which the entity set query was executed. A data source groups multiple related entity types and entity sets and represents the functional context of that query.\n",
"example": "crm",
"type": "string"
},
"entitiesReturned": {
"description": "Total number of entities returned across all executed queries for this entity set within the measured scope.\n",
"example": 12509,
"minimum": 0,
"type": "integer"
},
"entitySet": {
"description": "Name of the entity set that was queried.",
"example": "customers",
"type": "string"
},
"functionCounts": {
"description": "Counter array representing how often specific query functions were used. The array index corresponds to the internal FunctionFeatures flag position. Index 0 represents queries without functions. The array contains 41 entries, one for each defined function feature bit, including the `None` and `Unknown` flags.\n",
"example": [
10,
0,
2,
1,
0,
0,
3,
5,
0,
0,
0,
1,
0,
0,
0,
0,
0,
0,
0,
0,
0,
0,
0,
0,
0,
0,
0,
0,
0,
0,
0,
0,
0,
0,
0,
0,
0,
0,
0,
0,
0
],
"items": {
"minimum": 0,
"type": "integer"
},
"maxItems": 41,
"minItems": 41,
"type": "array"
},
"operatorCounts": {
"description": "Counter array representing how often specific filter operators were used. The array index corresponds to the internal OperatorFeatures flag position. Index 0 represents queries without operators. The array contains 19 entries, one for each defined operator feature bit, including the `None` and `Unknown` flags.\n",
"example": [
2,
0,
0,
4,
1,
0,
0,
3,
0,
0,
0,
1,
0,
0,
0,
0,
0,
0,
0
],
"items": {
"minimum": 0,
"type": "integer"
},
"maxItems": 19,
"minItems": 19,
"type": "array"
},
"queryCount": {
"description": "Total number of queries executed for this entity set within the measured scope.",
"example": 133,
"minimum": 0,
"type": "integer"
},
"queryOptionCounts": {
"description": "Counter array representing how often specific query options were used. The array index corresponds to the internal QueryOptionFeatures flag position. Index 0 represents queries without any query options. The array contains 17 entries, one for each defined query option feature bit, including the `None` and `Unknown` flags.\n",
"example": [
5,
0,
3,
0,
1,
0,
0,
2,
0,
0,
0,
1,
0,
0,
0,
0,
0
],
"items": {
"minimum": 0,
"type": "integer"
},
"maxItems": 17,
"minItems": 17,
"type": "array"
},
"schemaNamespace": {
"description": "Logical namespace of the schema in which the queried entity set is defined. Indicates whether the schema is system-provided (e.g. `core`) or tenant-specific (`custom`).\n",
"example": "custom",
"type": "string"
}
},
"type": "object"
}
},
"title": "Entity Set Query Metrics Aggregated Event",
"type": "object"
}
]
},
"EntitySetStatisticsBuiltPayload": {
"allOf": [
{
"$ref": "https://event-catalog.int.otc.fts.d-3.de/schemas/analytics-track.yaml#/TrackEvent"
},
{
"properties": {
"event": {
"const": "EntitySetStatisticsBuilt"
},
"properties": {
"properties": {
"averageEntitySize": {
"description": "The average size of an entity in the entity set",
"example": 2,
"format": "int64",
"type": "integer"
},
"comment": {
"description": "Information that the event was backfilled",
"example": "backfilled",
"type": "string"
},
"dataSize": {
"description": "The size of the data in the entity set (KiB)",
"example": 1024,
"format": "int64",
"type": "integer"
},
"entityCount": {
"description": "The number of entities in the entity set",
"example": 500,
"format": "int64",
"type": "integer"
},
"indexCount": {
"description": "The number of indexes",
"example": 3,
"format": "int64",
"type": "integer"
},
"indexSize": {
"description": "The size of the indexes (KiB)",
"example": 128,
"format": "int64",
"type": "integer"
},
"kind": {
"description": "The kind of the entity set (e.g., trashed, active)",
"example": "active",
"type": "string"
},
"name": {
"description": "The (logical) name of the entity set",
"example": "Products",
"type": "string"
},
"physicalName": {
"description": "The physical name of the entity set",
"example": "products_3b1_collection",
"type": "string"
},
"referenceId": {
"description": "Unique reference identifier of this event instance",
"example": "01JZAGPG76SXYC523XJAA7XNM7",
"type": "string"
},
"tn": {
"description": "Unique identifier of the tenant",
"example": "3b1",
"type": "string"
},
"typeName": {
"description": "The type name of the entities in the entity set",
"example": "Product",
"type": "string"
}
},
"type": "object"
}
},
"title": "The statistics of a tenant entity set",
"type": "object"
}
]
},
"TenantComputedTierChangedPayload": {
"allOf": [
{
"$ref": "https://event-catalog.int.otc.fts.d-3.de/schemas/analytics-track.yaml#/TrackEvent"
},
{
"properties": {
"event": {
"const": "TenantComputedTierChanged"
},
"properties": {
"properties": {
"newTier": {
"description": "The new computed tier of the tenant",
"example": "basic",
"type": "string"
},
"oldTier": {
"description": "The previous computed tier of the tenant",
"example": "standard",
"type": "string"
},
"tierDeterminants": {
"description": "The factors that determined the new tier calculation",
"example": "TotalEntityCount: 925, EntitySetMaxEntityCount: 382",
"type": "string"
},
"tn": {
"description": "Unique identifier of the tenant",
"example": "3b1",
"type": "string"
}
},
"type": "object"
}
},
"title": "Tenant computed tier change event",
"type": "object"
}
]
},
"TenantDatabaseStatisticsBuiltPayload": {
"allOf": [
{
"$ref": "https://event-catalog.int.otc.fts.d-3.de/schemas/analytics-track.yaml#/TrackEvent"
},
{
"properties": {
"event": {
"const": "TenantDatabaseStatisticsBuilt"
},
"properties": {
"properties": {
"created": {
"description": "The time the statistics were created",
"example": "2025-11-03T10:31:11.311Z",
"format": "date-time",
"type": "string"
},
"dataSize": {
"description": "The total size of the data in use (KiB)",
"example": 786432,
"format": "int64",
"type": "integer"
},
"entityCount": {
"description": "The total number of entities in use",
"example": 20000,
"format": "int64",
"type": "integer"
},
"entitySetCount": {
"description": "The total number of entity sets in use",
"example": 120,
"format": "int64",
"type": "integer"
},
"entityTypeCount": {
"description": "The total number of (custom) entity types in use",
"example": 45,
"format": "int64",
"type": "integer"
},
"id": {
"description": "The unique identifier under which the statistics is stored",
"example": "01JZAGPG76SXYC523XJAA7XNM7",
"type": "string"
},
"indexCount": {
"description": "The total number of indexes in use",
"example": 60,
"format": "int64",
"type": "integer"
},
"indexSize": {
"description": "The total size of all indexes in use (KiB)",
"example": 51200,
"format": "int64",
"type": "integer"
},
"modelCount": {
"description": "The total number of custom models in use",
"example": 12,
"format": "int64",
"type": "integer"
},
"orphanedDataSize": {
"description": "The total size of the orphaned data (KiB)",
"example": 131072,
"format": "int64",
"type": "integer"
},
"orphanedEntityCount": {
"description": "The total number of entities that are orphaned",
"example": 1000,
"format": "int64",
"type": "integer"
},
"orphanedEntitySetCount": {
"description": "The total number of entity sets that are orphaned",
"example": 10,
"format": "int64",
"type": "integer"
},
"orphanedIndexCount": {
"description": "The total number of indexes that are orphaned",
"example": 5,
"format": "int64",
"type": "integer"
},
"orphanedIndexSize": {
"description": "The total size of all orphaned indexes (KiB)",
"example": 6144,
"format": "int64",
"type": "integer"
},
"referenceId": {
"description": "Unique reference identifier of this event instance",
"example": "01JZAGPG76SXYC523XJAA7XNM7",
"type": "string"
},
"tenantDatabaseName": {
"description": "The name of the tenant database",
"example": "t_10qg",
"type": "string"
},
"tn": {
"description": "Unique identifier of the tenant",
"example": "3b1",
"type": "string"
},
"totalDataSize": {
"description": "The total size of the data held in the database (KiB)",
"example": 1048576,
"format": "int64",
"type": "integer"
},
"totalEntityCount": {
"description": "The total number of entities",
"example": 25000,
"format": "int64",
"type": "integer"
},
"totalEntitySetCount": {
"description": "The total number of entity sets",
"example": 150,
"format": "int64",
"type": "integer"
},
"totalIndexCount": {
"description": "The total number of indexes",
"example": 75,
"format": "int64",
"type": "integer"
},
"totalIndexSize": {
"description": "The total size of all indexes (KiB)",
"example": 65536,
"format": "int64",
"type": "integer"
},
"trashedDataSize": {
"description": "The total size of the data for which the related entity types were moved to the trash (KiB)",
"example": 131072,
"format": "int64",
"type": "integer"
},
"trashedEntityCount": {
"description": "The total number of entities for which the related entity types were moved to the trash",
"example": 4000,
"format": "int64",
"type": "integer"
},
"trashedEntitySetCount": {
"description": "The total number of entity sets for which the related entity types were moved to the trash",
"example": 20,
"format": "int64",
"type": "integer"
},
"trashedEntityTypeCount": {
"description": "The total number of (custom) entity types that were moved to the trash",
"example": 8,
"format": "int64",
"type": "integer"
},
"trashedIndexCount": {
"description": "The total number of indexes for which the related entity types were moved to the trash",
"example": 10,
"format": "int64",
"type": "integer"
},
"trashedIndexSize": {
"description": "The total size of all indexes for which the related entity types were moved to the trash (KiB)",
"example": 8192,
"format": "int64",
"type": "integer"
},
"trashedModelCount": {
"description": "The total number of custom models that were moved to the trash",
"example": 2,
"format": "int64",
"type": "integer"
}
},
"type": "object"
}
},
"title": "The statistics of a tenant database",
"type": "object"
}
]
}
}
}
}
---
id: businessobjects.EntitySetStatisticsBuilt
name: EntitySetStatisticsBuilt
version: 1.0.0
summary: "Indicates that entity set statistics have been successfully built"
producers:
- businessobjects
consumers: []
schemaPath: 'schema.json'
---
# EntitySetStatisticsBuilt
Indicates that entity set statistics have been successfully built
## Base Schema
All analytics events are based on the **TrackEvent** schema which provides common properties like `messageId`, `userId`, `context`, timestamps, and more.
**Base Schema Reference**: [analytics-track.yaml](https://event-catalog.prod.otc.fts.d-3.de/schemas/analytics-track.yaml)
## Event-Specific Properties
This schema shows only the event-specific properties that extend the base TrackEvent schema:
## Raw Schema:schema.json
{
"title": "Event-Specific Properties",
"type": "object",
"description": "Properties specific to this event type (extends BaseEvent)",
"extends": "https://event-catalog.int.otc.fts.d-3.de/schemas/analytics-track.yaml#/TrackEvent",
"eventType": "EntitySetStatisticsBuilt",
"properties": {
"referenceId": {
"description": "Unique reference identifier of this event instance",
"example": "01JZAGPG76SXYC523XJAA7XNM7",
"type": "string"
},
"comment": {
"description": "Information that the event was backfilled",
"example": "backfilled",
"type": "string"
},
"typeName": {
"description": "The type name of the entities in the entity set",
"example": "Product",
"type": "string"
},
"entityCount": {
"description": "The number of entities in the entity set",
"example": 500,
"format": "int64",
"type": "integer"
},
"averageEntitySize": {
"description": "The average size of an entity in the entity set",
"example": 2,
"format": "int64",
"type": "integer"
},
"kind": {
"description": "The kind of the entity set (e.g., trashed, active)",
"example": "active",
"type": "string"
},
"tn": {
"description": "Unique identifier of the tenant",
"example": "3b1",
"type": "string"
},
"name": {
"description": "The (logical) name of the entity set",
"example": "Products",
"type": "string"
},
"physicalName": {
"description": "The physical name of the entity set",
"example": "products_3b1_collection",
"type": "string"
},
"dataSize": {
"description": "The size of the data in the entity set (KiB)",
"example": 1024,
"format": "int64",
"type": "integer"
},
"indexSize": {
"description": "The size of the indexes (KiB)",
"example": 128,
"format": "int64",
"type": "integer"
},
"indexCount": {
"description": "The number of indexes",
"example": 3,
"format": "int64",
"type": "integer"
}
},
"components": {
"schemas": {
"AppPurgeReceivedPayload": {
"allOf": [
{
"$ref": "https://event-catalog.int.otc.fts.d-3.de/schemas/analytics-track.yaml#/TrackEvent"
},
{
"properties": {
"event": {
"const": "AppPurgeReceived"
},
"properties": {
"properties": {
"baseUri": {
"description": "Base URL of the tenant's cloud environment",
"example": "https://example.d-velop.cloud",
"format": "uri",
"type": "string"
},
"comment": {
"description": "Information that the event was backfilled",
"example": "backfilled",
"type": "string"
},
"received": {
"description": "Timestamp indicating when the purge request was received",
"example": "2025-07-08T10:31:11.311Z",
"format": "date-time",
"type": "string"
},
"referenceId": {
"description": "Unique reference identifier of this event instance",
"example": "01JZAGPG76SXYC523XJAA7XNM7",
"type": "string"
},
"tn": {
"description": "Unique identifier of the tenant for which the purge request was received",
"example": "3b1",
"type": "string"
}
},
"type": "object"
}
},
"title": "Specific event properties",
"type": "object"
}
]
},
"AppResubscribedPayload": {
"allOf": [
{
"$ref": "https://event-catalog.int.otc.fts.d-3.de/schemas/analytics-track.yaml#/TrackEvent"
},
{
"properties": {
"event": {
"const": "AppResubscribed"
},
"properties": {
"properties": {
"baseUri": {
"description": "Base URL of the tenant's cloud environment",
"example": "https://example.d-velop.cloud",
"format": "uri",
"type": "string"
},
"comment": {
"description": "Information that the event was backfilled",
"example": "backfilled",
"type": "string"
},
"received": {
"description": "Timestamp indicating when the tenant's app re-subscription was received",
"example": "2025-07-08T10:31:11.311Z",
"format": "date-time",
"type": "string"
},
"referenceId": {
"description": "Unique reference identifier of this event instance",
"example": "01JZAGPG76SXYC523XJAA7XNM7",
"type": "string"
},
"tn": {
"description": "Unique identifier of the re-subscribing tenant",
"example": "3b1",
"type": "string"
}
},
"type": "object"
}
},
"title": "Specific event properties",
"type": "object"
}
]
},
"AppSubscribedPayload": {
"allOf": [
{
"$ref": "https://event-catalog.int.otc.fts.d-3.de/schemas/analytics-track.yaml#/TrackEvent"
},
{
"properties": {
"event": {
"const": "AppSubscribed"
},
"properties": {
"properties": {
"baseUri": {
"description": "Base URL of the tenant's cloud environment",
"example": "https://example.d-velop.cloud",
"format": "uri",
"type": "string"
},
"comment": {
"description": "Information that the event was backfilled",
"example": "backfilled",
"type": "string"
},
"received": {
"description": "Timestamp indicating when the tenant's app subscription was received",
"example": "2025-07-08T10:31:11.311Z",
"format": "date-time",
"type": "string"
},
"referenceId": {
"description": "Unique reference identifier of this event instance",
"example": "01JZAGPG76SXYC523XJAA7XNM7",
"type": "string"
},
"tn": {
"description": "Unique identifier of the subscribing tenant",
"example": "3b1",
"type": "string"
}
},
"type": "object"
}
},
"title": "Specific event properties",
"type": "object"
}
]
},
"AppUnsubscribedPayload": {
"allOf": [
{
"$ref": "https://event-catalog.int.otc.fts.d-3.de/schemas/analytics-track.yaml#/TrackEvent"
},
{
"properties": {
"event": {
"const": "AppUnsubscribed"
},
"properties": {
"properties": {
"baseUri": {
"description": "Base URL of the tenant's cloud environment",
"example": "https://example.d-velop.cloud",
"format": "uri",
"type": "string"
},
"comment": {
"description": "Information that the event was backfilled",
"example": "backfilled",
"type": "string"
},
"received": {
"description": "Timestamp indicating when the tenant's app unsubscription was received",
"example": "2025-07-08T10:31:11.311Z",
"format": "date-time",
"type": "string"
},
"referenceId": {
"description": "Unique reference identifier of this event instance",
"example": "01JZAGPG76SXYC523XJAA7XNM7",
"type": "string"
},
"tn": {
"description": "Unique identifier of the unsubscribing tenant",
"example": "3b1",
"type": "string"
}
},
"type": "object"
}
},
"title": "Specific event properties",
"type": "object"
}
]
},
"DatabaseStatisticsBuiltPayload": {
"allOf": [
{
"$ref": "https://event-catalog.int.otc.fts.d-3.de/schemas/analytics-track.yaml#/TrackEvent"
},
{
"properties": {
"event": {
"const": "DatabaseStatisticsBuilt"
},
"properties": {
"properties": {
"comment": {
"description": "Information that the event was backfilled",
"example": "backfilled",
"type": "string"
},
"created": {
"description": "The time the statistics were created",
"example": "2025-11-03T10:31:11.311Z",
"format": "date-time",
"type": "string"
},
"dataSize": {
"description": "The total size of the data in use (KiB)",
"example": 1572864,
"format": "int64",
"type": "integer"
},
"entityCount": {
"description": "The total number of entities in use",
"example": 40000,
"format": "int64",
"type": "integer"
},
"entitySetCount": {
"description": "The total number of entity sets in use",
"example": 1200,
"format": "int64",
"type": "integer"
},
"entityTypeCount": {
"description": "The total number of (custom) entity types in use",
"example": 150,
"format": "int64",
"type": "integer"
},
"id": {
"description": "The unique identifier under which the statistics is stored",
"example": "01JZAGPG76SXYC523XJAA7XNM7",
"type": "string"
},
"indexCount": {
"description": "The total number of indexes in use",
"example": 240,
"format": "int64",
"type": "integer"
},
"indexSize": {
"description": "The total size of all indexes in use (KiB)",
"example": 102400,
"format": "int64",
"type": "integer"
},
"modelCount": {
"description": "The total number of custom models in use",
"example": 25,
"format": "int64",
"type": "integer"
},
"orphanedDataSize": {
"description": "The total size of the orphaned data (KiB)",
"example": 262144,
"format": "int64",
"type": "integer"
},
"orphanedEntityCount": {
"description": "The total number of entities that are orphaned",
"example": 2000,
"format": "int64",
"type": "integer"
},
"orphanedEntitySetCount": {
"description": "The total number of entity sets that are orphaned",
"example": 100,
"format": "int64",
"type": "integer"
},
"orphanedIndexCount": {
"description": "The total number of indexes that are orphaned",
"example": 20,
"format": "int64",
"type": "integer"
},
"orphanedIndexSize": {
"description": "The total size of all orphaned indexes (KiB)",
"example": 12288,
"format": "int64",
"type": "integer"
},
"referenceId": {
"description": "Unique reference identifier of this event instance",
"example": "01JZAGPG76SXYC523XJAA7XNM7",
"type": "string"
},
"tenantCount": {
"description": "The number of tenants included in the statistics",
"example": 150,
"format": "int64",
"type": "integer"
},
"totalDataSize": {
"description": "The total size of the data held in the database (KiB)",
"example": 2097152,
"format": "int64",
"type": "integer"
},
"totalEntityCount": {
"description": "The total number of entities",
"example": 50000,
"format": "int64",
"type": "integer"
},
"totalEntitySetCount": {
"description": "The total number of entity sets",
"example": 1500,
"format": "int64",
"type": "integer"
},
"totalIndexCount": {
"description": "The total number of indexes",
"example": 300,
"format": "int64",
"type": "integer"
},
"totalIndexSize": {
"description": "The total size of all indexes (KiB)",
"example": 131072,
"format": "int64",
"type": "integer"
},
"trashedDataSize": {
"description": "The total size of the data for which the related entity types were moved to the trash (KiB)",
"example": 262144,
"format": "int64",
"type": "integer"
},
"trashedEntityCount": {
"description": "The total number of entities for which the related entity types were moved to the trash",
"example": 8000,
"format": "int64",
"type": "integer"
},
"trashedEntitySetCount": {
"description": "The total number of entity sets for which the related entity types were moved to the trash",
"example": 200,
"format": "int64",
"type": "integer"
},
"trashedEntityTypeCount": {
"description": "The total number of (custom) entity types that were moved to the trash",
"example": 20,
"format": "int64",
"type": "integer"
},
"trashedIndexCount": {
"description": "The total number of indexes for which the related entity types were moved to the trash",
"example": 40,
"format": "int64",
"type": "integer"
},
"trashedIndexSize": {
"description": "The total size of all indexes for which the related entity types were moved to the trash (KiB)",
"example": 16384,
"format": "int64",
"type": "integer"
},
"trashedModelCount": {
"description": "The total number of custom models that were moved to the trash",
"example": 3,
"format": "int64",
"type": "integer"
}
},
"type": "object"
}
},
"title": "Database statistics that summarize the database statistics for all tenants",
"type": "object"
}
]
},
"EntitySetQueryMetricsAggregatedPayload": {
"allOf": [
{
"$ref": "https://event-catalog.int.otc.fts.d-3.de/schemas/analytics-track.yaml#/TrackEvent"
},
{
"description": "This event is emitted after queries have been executed against an entity set and their usage metrics have been aggregated. Aggregation is based on processing time. Metrics are grouped into fixed aggregation windows defined by `aggregationWindowStart` (inclusive) and `aggregationWindowEnd` (exclusive). Queries occurring near window boundaries may be assigned to either adjacent window.\n",
"properties": {
"event": {
"const": "EntitySetQueryMetricsAggregated"
},
"properties": {
"properties": {
"aggregationInterval": {
"description": "Duration of the aggregation window used for this event. Typically equals `aggregationWindowEnd` minus `aggregationWindowStart`. Must be an ISO 8601 duration (e.g. PT30S, PT5M, PT1H).\n",
"example": "PT30S",
"type": "string"
},
"aggregationWindowEnd": {
"description": "End timestamp (exclusive) of the aggregation window.\n",
"example": "2026-02-24T10:00:30Z",
"format": "date-time",
"type": "string"
},
"aggregationWindowStart": {
"description": "Start timestamp (inclusive) of the aggregation window.\n",
"example": "2026-02-24T10:00:00Z",
"format": "date-time",
"type": "string"
},
"dataSource": {
"description": "Identifier of the logical context or model against which the entity set query was executed. A data source groups multiple related entity types and entity sets and represents the functional context of that query.\n",
"example": "crm",
"type": "string"
},
"entitiesReturned": {
"description": "Total number of entities returned across all executed queries for this entity set within the measured scope.\n",
"example": 12509,
"minimum": 0,
"type": "integer"
},
"entitySet": {
"description": "Name of the entity set that was queried.",
"example": "customers",
"type": "string"
},
"functionCounts": {
"description": "Counter array representing how often specific query functions were used. The array index corresponds to the internal FunctionFeatures flag position. Index 0 represents queries without functions. The array contains 41 entries, one for each defined function feature bit, including the `None` and `Unknown` flags.\n",
"example": [
10,
0,
2,
1,
0,
0,
3,
5,
0,
0,
0,
1,
0,
0,
0,
0,
0,
0,
0,
0,
0,
0,
0,
0,
0,
0,
0,
0,
0,
0,
0,
0,
0,
0,
0,
0,
0,
0,
0,
0,
0
],
"items": {
"minimum": 0,
"type": "integer"
},
"maxItems": 41,
"minItems": 41,
"type": "array"
},
"operatorCounts": {
"description": "Counter array representing how often specific filter operators were used. The array index corresponds to the internal OperatorFeatures flag position. Index 0 represents queries without operators. The array contains 19 entries, one for each defined operator feature bit, including the `None` and `Unknown` flags.\n",
"example": [
2,
0,
0,
4,
1,
0,
0,
3,
0,
0,
0,
1,
0,
0,
0,
0,
0,
0,
0
],
"items": {
"minimum": 0,
"type": "integer"
},
"maxItems": 19,
"minItems": 19,
"type": "array"
},
"queryCount": {
"description": "Total number of queries executed for this entity set within the measured scope.",
"example": 133,
"minimum": 0,
"type": "integer"
},
"queryOptionCounts": {
"description": "Counter array representing how often specific query options were used. The array index corresponds to the internal QueryOptionFeatures flag position. Index 0 represents queries without any query options. The array contains 17 entries, one for each defined query option feature bit, including the `None` and `Unknown` flags.\n",
"example": [
5,
0,
3,
0,
1,
0,
0,
2,
0,
0,
0,
1,
0,
0,
0,
0,
0
],
"items": {
"minimum": 0,
"type": "integer"
},
"maxItems": 17,
"minItems": 17,
"type": "array"
},
"schemaNamespace": {
"description": "Logical namespace of the schema in which the queried entity set is defined. Indicates whether the schema is system-provided (e.g. `core`) or tenant-specific (`custom`).\n",
"example": "custom",
"type": "string"
}
},
"type": "object"
}
},
"title": "Entity Set Query Metrics Aggregated Event",
"type": "object"
}
]
},
"EntitySetStatisticsBuiltPayload": {
"allOf": [
{
"$ref": "https://event-catalog.int.otc.fts.d-3.de/schemas/analytics-track.yaml#/TrackEvent"
},
{
"properties": {
"event": {
"const": "EntitySetStatisticsBuilt"
},
"properties": {
"properties": {
"averageEntitySize": {
"description": "The average size of an entity in the entity set",
"example": 2,
"format": "int64",
"type": "integer"
},
"comment": {
"description": "Information that the event was backfilled",
"example": "backfilled",
"type": "string"
},
"dataSize": {
"description": "The size of the data in the entity set (KiB)",
"example": 1024,
"format": "int64",
"type": "integer"
},
"entityCount": {
"description": "The number of entities in the entity set",
"example": 500,
"format": "int64",
"type": "integer"
},
"indexCount": {
"description": "The number of indexes",
"example": 3,
"format": "int64",
"type": "integer"
},
"indexSize": {
"description": "The size of the indexes (KiB)",
"example": 128,
"format": "int64",
"type": "integer"
},
"kind": {
"description": "The kind of the entity set (e.g., trashed, active)",
"example": "active",
"type": "string"
},
"name": {
"description": "The (logical) name of the entity set",
"example": "Products",
"type": "string"
},
"physicalName": {
"description": "The physical name of the entity set",
"example": "products_3b1_collection",
"type": "string"
},
"referenceId": {
"description": "Unique reference identifier of this event instance",
"example": "01JZAGPG76SXYC523XJAA7XNM7",
"type": "string"
},
"tn": {
"description": "Unique identifier of the tenant",
"example": "3b1",
"type": "string"
},
"typeName": {
"description": "The type name of the entities in the entity set",
"example": "Product",
"type": "string"
}
},
"type": "object"
}
},
"title": "The statistics of a tenant entity set",
"type": "object"
}
]
},
"TenantComputedTierChangedPayload": {
"allOf": [
{
"$ref": "https://event-catalog.int.otc.fts.d-3.de/schemas/analytics-track.yaml#/TrackEvent"
},
{
"properties": {
"event": {
"const": "TenantComputedTierChanged"
},
"properties": {
"properties": {
"newTier": {
"description": "The new computed tier of the tenant",
"example": "basic",
"type": "string"
},
"oldTier": {
"description": "The previous computed tier of the tenant",
"example": "standard",
"type": "string"
},
"tierDeterminants": {
"description": "The factors that determined the new tier calculation",
"example": "TotalEntityCount: 925, EntitySetMaxEntityCount: 382",
"type": "string"
},
"tn": {
"description": "Unique identifier of the tenant",
"example": "3b1",
"type": "string"
}
},
"type": "object"
}
},
"title": "Tenant computed tier change event",
"type": "object"
}
]
},
"TenantDatabaseStatisticsBuiltPayload": {
"allOf": [
{
"$ref": "https://event-catalog.int.otc.fts.d-3.de/schemas/analytics-track.yaml#/TrackEvent"
},
{
"properties": {
"event": {
"const": "TenantDatabaseStatisticsBuilt"
},
"properties": {
"properties": {
"created": {
"description": "The time the statistics were created",
"example": "2025-11-03T10:31:11.311Z",
"format": "date-time",
"type": "string"
},
"dataSize": {
"description": "The total size of the data in use (KiB)",
"example": 786432,
"format": "int64",
"type": "integer"
},
"entityCount": {
"description": "The total number of entities in use",
"example": 20000,
"format": "int64",
"type": "integer"
},
"entitySetCount": {
"description": "The total number of entity sets in use",
"example": 120,
"format": "int64",
"type": "integer"
},
"entityTypeCount": {
"description": "The total number of (custom) entity types in use",
"example": 45,
"format": "int64",
"type": "integer"
},
"id": {
"description": "The unique identifier under which the statistics is stored",
"example": "01JZAGPG76SXYC523XJAA7XNM7",
"type": "string"
},
"indexCount": {
"description": "The total number of indexes in use",
"example": 60,
"format": "int64",
"type": "integer"
},
"indexSize": {
"description": "The total size of all indexes in use (KiB)",
"example": 51200,
"format": "int64",
"type": "integer"
},
"modelCount": {
"description": "The total number of custom models in use",
"example": 12,
"format": "int64",
"type": "integer"
},
"orphanedDataSize": {
"description": "The total size of the orphaned data (KiB)",
"example": 131072,
"format": "int64",
"type": "integer"
},
"orphanedEntityCount": {
"description": "The total number of entities that are orphaned",
"example": 1000,
"format": "int64",
"type": "integer"
},
"orphanedEntitySetCount": {
"description": "The total number of entity sets that are orphaned",
"example": 10,
"format": "int64",
"type": "integer"
},
"orphanedIndexCount": {
"description": "The total number of indexes that are orphaned",
"example": 5,
"format": "int64",
"type": "integer"
},
"orphanedIndexSize": {
"description": "The total size of all orphaned indexes (KiB)",
"example": 6144,
"format": "int64",
"type": "integer"
},
"referenceId": {
"description": "Unique reference identifier of this event instance",
"example": "01JZAGPG76SXYC523XJAA7XNM7",
"type": "string"
},
"tenantDatabaseName": {
"description": "The name of the tenant database",
"example": "t_10qg",
"type": "string"
},
"tn": {
"description": "Unique identifier of the tenant",
"example": "3b1",
"type": "string"
},
"totalDataSize": {
"description": "The total size of the data held in the database (KiB)",
"example": 1048576,
"format": "int64",
"type": "integer"
},
"totalEntityCount": {
"description": "The total number of entities",
"example": 25000,
"format": "int64",
"type": "integer"
},
"totalEntitySetCount": {
"description": "The total number of entity sets",
"example": 150,
"format": "int64",
"type": "integer"
},
"totalIndexCount": {
"description": "The total number of indexes",
"example": 75,
"format": "int64",
"type": "integer"
},
"totalIndexSize": {
"description": "The total size of all indexes (KiB)",
"example": 65536,
"format": "int64",
"type": "integer"
},
"trashedDataSize": {
"description": "The total size of the data for which the related entity types were moved to the trash (KiB)",
"example": 131072,
"format": "int64",
"type": "integer"
},
"trashedEntityCount": {
"description": "The total number of entities for which the related entity types were moved to the trash",
"example": 4000,
"format": "int64",
"type": "integer"
},
"trashedEntitySetCount": {
"description": "The total number of entity sets for which the related entity types were moved to the trash",
"example": 20,
"format": "int64",
"type": "integer"
},
"trashedEntityTypeCount": {
"description": "The total number of (custom) entity types that were moved to the trash",
"example": 8,
"format": "int64",
"type": "integer"
},
"trashedIndexCount": {
"description": "The total number of indexes for which the related entity types were moved to the trash",
"example": 10,
"format": "int64",
"type": "integer"
},
"trashedIndexSize": {
"description": "The total size of all indexes for which the related entity types were moved to the trash (KiB)",
"example": 8192,
"format": "int64",
"type": "integer"
},
"trashedModelCount": {
"description": "The total number of custom models that were moved to the trash",
"example": 2,
"format": "int64",
"type": "integer"
}
},
"type": "object"
}
},
"title": "The statistics of a tenant database",
"type": "object"
}
]
}
}
}
}
---
id: businessobjects.TenantComputedTierChanged
name: TenantComputedTierChanged
version: 1.0.0
summary: "Indicates that a tenant's computed tier has changed"
producers:
- businessobjects
consumers: []
schemaPath: 'schema.json'
---
# TenantComputedTierChanged
Indicates that a tenant's computed tier has changed
## Base Schema
All analytics events are based on the **TrackEvent** schema which provides common properties like `messageId`, `userId`, `context`, timestamps, and more.
**Base Schema Reference**: [analytics-track.yaml](https://event-catalog.prod.otc.fts.d-3.de/schemas/analytics-track.yaml)
## Event-Specific Properties
This schema shows only the event-specific properties that extend the base TrackEvent schema:
## Raw Schema:schema.json
{
"title": "Event-Specific Properties",
"type": "object",
"description": "Properties specific to this event type (extends BaseEvent)",
"extends": "https://event-catalog.int.otc.fts.d-3.de/schemas/analytics-track.yaml#/TrackEvent",
"eventType": "TenantComputedTierChanged",
"properties": {
"tn": {
"description": "Unique identifier of the tenant",
"example": "3b1",
"type": "string"
},
"oldTier": {
"description": "The previous computed tier of the tenant",
"example": "standard",
"type": "string"
},
"newTier": {
"description": "The new computed tier of the tenant",
"example": "basic",
"type": "string"
},
"tierDeterminants": {
"description": "The factors that determined the new tier calculation",
"example": "TotalEntityCount: 925, EntitySetMaxEntityCount: 382",
"type": "string"
}
},
"components": {
"schemas": {
"AppPurgeReceivedPayload": {
"allOf": [
{
"$ref": "https://event-catalog.int.otc.fts.d-3.de/schemas/analytics-track.yaml#/TrackEvent"
},
{
"properties": {
"event": {
"const": "AppPurgeReceived"
},
"properties": {
"properties": {
"baseUri": {
"description": "Base URL of the tenant's cloud environment",
"example": "https://example.d-velop.cloud",
"format": "uri",
"type": "string"
},
"comment": {
"description": "Information that the event was backfilled",
"example": "backfilled",
"type": "string"
},
"received": {
"description": "Timestamp indicating when the purge request was received",
"example": "2025-07-08T10:31:11.311Z",
"format": "date-time",
"type": "string"
},
"referenceId": {
"description": "Unique reference identifier of this event instance",
"example": "01JZAGPG76SXYC523XJAA7XNM7",
"type": "string"
},
"tn": {
"description": "Unique identifier of the tenant for which the purge request was received",
"example": "3b1",
"type": "string"
}
},
"type": "object"
}
},
"title": "Specific event properties",
"type": "object"
}
]
},
"AppResubscribedPayload": {
"allOf": [
{
"$ref": "https://event-catalog.int.otc.fts.d-3.de/schemas/analytics-track.yaml#/TrackEvent"
},
{
"properties": {
"event": {
"const": "AppResubscribed"
},
"properties": {
"properties": {
"baseUri": {
"description": "Base URL of the tenant's cloud environment",
"example": "https://example.d-velop.cloud",
"format": "uri",
"type": "string"
},
"comment": {
"description": "Information that the event was backfilled",
"example": "backfilled",
"type": "string"
},
"received": {
"description": "Timestamp indicating when the tenant's app re-subscription was received",
"example": "2025-07-08T10:31:11.311Z",
"format": "date-time",
"type": "string"
},
"referenceId": {
"description": "Unique reference identifier of this event instance",
"example": "01JZAGPG76SXYC523XJAA7XNM7",
"type": "string"
},
"tn": {
"description": "Unique identifier of the re-subscribing tenant",
"example": "3b1",
"type": "string"
}
},
"type": "object"
}
},
"title": "Specific event properties",
"type": "object"
}
]
},
"AppSubscribedPayload": {
"allOf": [
{
"$ref": "https://event-catalog.int.otc.fts.d-3.de/schemas/analytics-track.yaml#/TrackEvent"
},
{
"properties": {
"event": {
"const": "AppSubscribed"
},
"properties": {
"properties": {
"baseUri": {
"description": "Base URL of the tenant's cloud environment",
"example": "https://example.d-velop.cloud",
"format": "uri",
"type": "string"
},
"comment": {
"description": "Information that the event was backfilled",
"example": "backfilled",
"type": "string"
},
"received": {
"description": "Timestamp indicating when the tenant's app subscription was received",
"example": "2025-07-08T10:31:11.311Z",
"format": "date-time",
"type": "string"
},
"referenceId": {
"description": "Unique reference identifier of this event instance",
"example": "01JZAGPG76SXYC523XJAA7XNM7",
"type": "string"
},
"tn": {
"description": "Unique identifier of the subscribing tenant",
"example": "3b1",
"type": "string"
}
},
"type": "object"
}
},
"title": "Specific event properties",
"type": "object"
}
]
},
"AppUnsubscribedPayload": {
"allOf": [
{
"$ref": "https://event-catalog.int.otc.fts.d-3.de/schemas/analytics-track.yaml#/TrackEvent"
},
{
"properties": {
"event": {
"const": "AppUnsubscribed"
},
"properties": {
"properties": {
"baseUri": {
"description": "Base URL of the tenant's cloud environment",
"example": "https://example.d-velop.cloud",
"format": "uri",
"type": "string"
},
"comment": {
"description": "Information that the event was backfilled",
"example": "backfilled",
"type": "string"
},
"received": {
"description": "Timestamp indicating when the tenant's app unsubscription was received",
"example": "2025-07-08T10:31:11.311Z",
"format": "date-time",
"type": "string"
},
"referenceId": {
"description": "Unique reference identifier of this event instance",
"example": "01JZAGPG76SXYC523XJAA7XNM7",
"type": "string"
},
"tn": {
"description": "Unique identifier of the unsubscribing tenant",
"example": "3b1",
"type": "string"
}
},
"type": "object"
}
},
"title": "Specific event properties",
"type": "object"
}
]
},
"DatabaseStatisticsBuiltPayload": {
"allOf": [
{
"$ref": "https://event-catalog.int.otc.fts.d-3.de/schemas/analytics-track.yaml#/TrackEvent"
},
{
"properties": {
"event": {
"const": "DatabaseStatisticsBuilt"
},
"properties": {
"properties": {
"comment": {
"description": "Information that the event was backfilled",
"example": "backfilled",
"type": "string"
},
"created": {
"description": "The time the statistics were created",
"example": "2025-11-03T10:31:11.311Z",
"format": "date-time",
"type": "string"
},
"dataSize": {
"description": "The total size of the data in use (KiB)",
"example": 1572864,
"format": "int64",
"type": "integer"
},
"entityCount": {
"description": "The total number of entities in use",
"example": 40000,
"format": "int64",
"type": "integer"
},
"entitySetCount": {
"description": "The total number of entity sets in use",
"example": 1200,
"format": "int64",
"type": "integer"
},
"entityTypeCount": {
"description": "The total number of (custom) entity types in use",
"example": 150,
"format": "int64",
"type": "integer"
},
"id": {
"description": "The unique identifier under which the statistics is stored",
"example": "01JZAGPG76SXYC523XJAA7XNM7",
"type": "string"
},
"indexCount": {
"description": "The total number of indexes in use",
"example": 240,
"format": "int64",
"type": "integer"
},
"indexSize": {
"description": "The total size of all indexes in use (KiB)",
"example": 102400,
"format": "int64",
"type": "integer"
},
"modelCount": {
"description": "The total number of custom models in use",
"example": 25,
"format": "int64",
"type": "integer"
},
"orphanedDataSize": {
"description": "The total size of the orphaned data (KiB)",
"example": 262144,
"format": "int64",
"type": "integer"
},
"orphanedEntityCount": {
"description": "The total number of entities that are orphaned",
"example": 2000,
"format": "int64",
"type": "integer"
},
"orphanedEntitySetCount": {
"description": "The total number of entity sets that are orphaned",
"example": 100,
"format": "int64",
"type": "integer"
},
"orphanedIndexCount": {
"description": "The total number of indexes that are orphaned",
"example": 20,
"format": "int64",
"type": "integer"
},
"orphanedIndexSize": {
"description": "The total size of all orphaned indexes (KiB)",
"example": 12288,
"format": "int64",
"type": "integer"
},
"referenceId": {
"description": "Unique reference identifier of this event instance",
"example": "01JZAGPG76SXYC523XJAA7XNM7",
"type": "string"
},
"tenantCount": {
"description": "The number of tenants included in the statistics",
"example": 150,
"format": "int64",
"type": "integer"
},
"totalDataSize": {
"description": "The total size of the data held in the database (KiB)",
"example": 2097152,
"format": "int64",
"type": "integer"
},
"totalEntityCount": {
"description": "The total number of entities",
"example": 50000,
"format": "int64",
"type": "integer"
},
"totalEntitySetCount": {
"description": "The total number of entity sets",
"example": 1500,
"format": "int64",
"type": "integer"
},
"totalIndexCount": {
"description": "The total number of indexes",
"example": 300,
"format": "int64",
"type": "integer"
},
"totalIndexSize": {
"description": "The total size of all indexes (KiB)",
"example": 131072,
"format": "int64",
"type": "integer"
},
"trashedDataSize": {
"description": "The total size of the data for which the related entity types were moved to the trash (KiB)",
"example": 262144,
"format": "int64",
"type": "integer"
},
"trashedEntityCount": {
"description": "The total number of entities for which the related entity types were moved to the trash",
"example": 8000,
"format": "int64",
"type": "integer"
},
"trashedEntitySetCount": {
"description": "The total number of entity sets for which the related entity types were moved to the trash",
"example": 200,
"format": "int64",
"type": "integer"
},
"trashedEntityTypeCount": {
"description": "The total number of (custom) entity types that were moved to the trash",
"example": 20,
"format": "int64",
"type": "integer"
},
"trashedIndexCount": {
"description": "The total number of indexes for which the related entity types were moved to the trash",
"example": 40,
"format": "int64",
"type": "integer"
},
"trashedIndexSize": {
"description": "The total size of all indexes for which the related entity types were moved to the trash (KiB)",
"example": 16384,
"format": "int64",
"type": "integer"
},
"trashedModelCount": {
"description": "The total number of custom models that were moved to the trash",
"example": 3,
"format": "int64",
"type": "integer"
}
},
"type": "object"
}
},
"title": "Database statistics that summarize the database statistics for all tenants",
"type": "object"
}
]
},
"EntitySetQueryMetricsAggregatedPayload": {
"allOf": [
{
"$ref": "https://event-catalog.int.otc.fts.d-3.de/schemas/analytics-track.yaml#/TrackEvent"
},
{
"description": "This event is emitted after queries have been executed against an entity set and their usage metrics have been aggregated. Aggregation is based on processing time. Metrics are grouped into fixed aggregation windows defined by `aggregationWindowStart` (inclusive) and `aggregationWindowEnd` (exclusive). Queries occurring near window boundaries may be assigned to either adjacent window.\n",
"properties": {
"event": {
"const": "EntitySetQueryMetricsAggregated"
},
"properties": {
"properties": {
"aggregationInterval": {
"description": "Duration of the aggregation window used for this event. Typically equals `aggregationWindowEnd` minus `aggregationWindowStart`. Must be an ISO 8601 duration (e.g. PT30S, PT5M, PT1H).\n",
"example": "PT30S",
"type": "string"
},
"aggregationWindowEnd": {
"description": "End timestamp (exclusive) of the aggregation window.\n",
"example": "2026-02-24T10:00:30Z",
"format": "date-time",
"type": "string"
},
"aggregationWindowStart": {
"description": "Start timestamp (inclusive) of the aggregation window.\n",
"example": "2026-02-24T10:00:00Z",
"format": "date-time",
"type": "string"
},
"dataSource": {
"description": "Identifier of the logical context or model against which the entity set query was executed. A data source groups multiple related entity types and entity sets and represents the functional context of that query.\n",
"example": "crm",
"type": "string"
},
"entitiesReturned": {
"description": "Total number of entities returned across all executed queries for this entity set within the measured scope.\n",
"example": 12509,
"minimum": 0,
"type": "integer"
},
"entitySet": {
"description": "Name of the entity set that was queried.",
"example": "customers",
"type": "string"
},
"functionCounts": {
"description": "Counter array representing how often specific query functions were used. The array index corresponds to the internal FunctionFeatures flag position. Index 0 represents queries without functions. The array contains 41 entries, one for each defined function feature bit, including the `None` and `Unknown` flags.\n",
"example": [
10,
0,
2,
1,
0,
0,
3,
5,
0,
0,
0,
1,
0,
0,
0,
0,
0,
0,
0,
0,
0,
0,
0,
0,
0,
0,
0,
0,
0,
0,
0,
0,
0,
0,
0,
0,
0,
0,
0,
0,
0
],
"items": {
"minimum": 0,
"type": "integer"
},
"maxItems": 41,
"minItems": 41,
"type": "array"
},
"operatorCounts": {
"description": "Counter array representing how often specific filter operators were used. The array index corresponds to the internal OperatorFeatures flag position. Index 0 represents queries without operators. The array contains 19 entries, one for each defined operator feature bit, including the `None` and `Unknown` flags.\n",
"example": [
2,
0,
0,
4,
1,
0,
0,
3,
0,
0,
0,
1,
0,
0,
0,
0,
0,
0,
0
],
"items": {
"minimum": 0,
"type": "integer"
},
"maxItems": 19,
"minItems": 19,
"type": "array"
},
"queryCount": {
"description": "Total number of queries executed for this entity set within the measured scope.",
"example": 133,
"minimum": 0,
"type": "integer"
},
"queryOptionCounts": {
"description": "Counter array representing how often specific query options were used. The array index corresponds to the internal QueryOptionFeatures flag position. Index 0 represents queries without any query options. The array contains 17 entries, one for each defined query option feature bit, including the `None` and `Unknown` flags.\n",
"example": [
5,
0,
3,
0,
1,
0,
0,
2,
0,
0,
0,
1,
0,
0,
0,
0,
0
],
"items": {
"minimum": 0,
"type": "integer"
},
"maxItems": 17,
"minItems": 17,
"type": "array"
},
"schemaNamespace": {
"description": "Logical namespace of the schema in which the queried entity set is defined. Indicates whether the schema is system-provided (e.g. `core`) or tenant-specific (`custom`).\n",
"example": "custom",
"type": "string"
}
},
"type": "object"
}
},
"title": "Entity Set Query Metrics Aggregated Event",
"type": "object"
}
]
},
"EntitySetStatisticsBuiltPayload": {
"allOf": [
{
"$ref": "https://event-catalog.int.otc.fts.d-3.de/schemas/analytics-track.yaml#/TrackEvent"
},
{
"properties": {
"event": {
"const": "EntitySetStatisticsBuilt"
},
"properties": {
"properties": {
"averageEntitySize": {
"description": "The average size of an entity in the entity set",
"example": 2,
"format": "int64",
"type": "integer"
},
"comment": {
"description": "Information that the event was backfilled",
"example": "backfilled",
"type": "string"
},
"dataSize": {
"description": "The size of the data in the entity set (KiB)",
"example": 1024,
"format": "int64",
"type": "integer"
},
"entityCount": {
"description": "The number of entities in the entity set",
"example": 500,
"format": "int64",
"type": "integer"
},
"indexCount": {
"description": "The number of indexes",
"example": 3,
"format": "int64",
"type": "integer"
},
"indexSize": {
"description": "The size of the indexes (KiB)",
"example": 128,
"format": "int64",
"type": "integer"
},
"kind": {
"description": "The kind of the entity set (e.g., trashed, active)",
"example": "active",
"type": "string"
},
"name": {
"description": "The (logical) name of the entity set",
"example": "Products",
"type": "string"
},
"physicalName": {
"description": "The physical name of the entity set",
"example": "products_3b1_collection",
"type": "string"
},
"referenceId": {
"description": "Unique reference identifier of this event instance",
"example": "01JZAGPG76SXYC523XJAA7XNM7",
"type": "string"
},
"tn": {
"description": "Unique identifier of the tenant",
"example": "3b1",
"type": "string"
},
"typeName": {
"description": "The type name of the entities in the entity set",
"example": "Product",
"type": "string"
}
},
"type": "object"
}
},
"title": "The statistics of a tenant entity set",
"type": "object"
}
]
},
"TenantComputedTierChangedPayload": {
"allOf": [
{
"$ref": "https://event-catalog.int.otc.fts.d-3.de/schemas/analytics-track.yaml#/TrackEvent"
},
{
"properties": {
"event": {
"const": "TenantComputedTierChanged"
},
"properties": {
"properties": {
"newTier": {
"description": "The new computed tier of the tenant",
"example": "basic",
"type": "string"
},
"oldTier": {
"description": "The previous computed tier of the tenant",
"example": "standard",
"type": "string"
},
"tierDeterminants": {
"description": "The factors that determined the new tier calculation",
"example": "TotalEntityCount: 925, EntitySetMaxEntityCount: 382",
"type": "string"
},
"tn": {
"description": "Unique identifier of the tenant",
"example": "3b1",
"type": "string"
}
},
"type": "object"
}
},
"title": "Tenant computed tier change event",
"type": "object"
}
]
},
"TenantDatabaseStatisticsBuiltPayload": {
"allOf": [
{
"$ref": "https://event-catalog.int.otc.fts.d-3.de/schemas/analytics-track.yaml#/TrackEvent"
},
{
"properties": {
"event": {
"const": "TenantDatabaseStatisticsBuilt"
},
"properties": {
"properties": {
"created": {
"description": "The time the statistics were created",
"example": "2025-11-03T10:31:11.311Z",
"format": "date-time",
"type": "string"
},
"dataSize": {
"description": "The total size of the data in use (KiB)",
"example": 786432,
"format": "int64",
"type": "integer"
},
"entityCount": {
"description": "The total number of entities in use",
"example": 20000,
"format": "int64",
"type": "integer"
},
"entitySetCount": {
"description": "The total number of entity sets in use",
"example": 120,
"format": "int64",
"type": "integer"
},
"entityTypeCount": {
"description": "The total number of (custom) entity types in use",
"example": 45,
"format": "int64",
"type": "integer"
},
"id": {
"description": "The unique identifier under which the statistics is stored",
"example": "01JZAGPG76SXYC523XJAA7XNM7",
"type": "string"
},
"indexCount": {
"description": "The total number of indexes in use",
"example": 60,
"format": "int64",
"type": "integer"
},
"indexSize": {
"description": "The total size of all indexes in use (KiB)",
"example": 51200,
"format": "int64",
"type": "integer"
},
"modelCount": {
"description": "The total number of custom models in use",
"example": 12,
"format": "int64",
"type": "integer"
},
"orphanedDataSize": {
"description": "The total size of the orphaned data (KiB)",
"example": 131072,
"format": "int64",
"type": "integer"
},
"orphanedEntityCount": {
"description": "The total number of entities that are orphaned",
"example": 1000,
"format": "int64",
"type": "integer"
},
"orphanedEntitySetCount": {
"description": "The total number of entity sets that are orphaned",
"example": 10,
"format": "int64",
"type": "integer"
},
"orphanedIndexCount": {
"description": "The total number of indexes that are orphaned",
"example": 5,
"format": "int64",
"type": "integer"
},
"orphanedIndexSize": {
"description": "The total size of all orphaned indexes (KiB)",
"example": 6144,
"format": "int64",
"type": "integer"
},
"referenceId": {
"description": "Unique reference identifier of this event instance",
"example": "01JZAGPG76SXYC523XJAA7XNM7",
"type": "string"
},
"tenantDatabaseName": {
"description": "The name of the tenant database",
"example": "t_10qg",
"type": "string"
},
"tn": {
"description": "Unique identifier of the tenant",
"example": "3b1",
"type": "string"
},
"totalDataSize": {
"description": "The total size of the data held in the database (KiB)",
"example": 1048576,
"format": "int64",
"type": "integer"
},
"totalEntityCount": {
"description": "The total number of entities",
"example": 25000,
"format": "int64",
"type": "integer"
},
"totalEntitySetCount": {
"description": "The total number of entity sets",
"example": 150,
"format": "int64",
"type": "integer"
},
"totalIndexCount": {
"description": "The total number of indexes",
"example": 75,
"format": "int64",
"type": "integer"
},
"totalIndexSize": {
"description": "The total size of all indexes (KiB)",
"example": 65536,
"format": "int64",
"type": "integer"
},
"trashedDataSize": {
"description": "The total size of the data for which the related entity types were moved to the trash (KiB)",
"example": 131072,
"format": "int64",
"type": "integer"
},
"trashedEntityCount": {
"description": "The total number of entities for which the related entity types were moved to the trash",
"example": 4000,
"format": "int64",
"type": "integer"
},
"trashedEntitySetCount": {
"description": "The total number of entity sets for which the related entity types were moved to the trash",
"example": 20,
"format": "int64",
"type": "integer"
},
"trashedEntityTypeCount": {
"description": "The total number of (custom) entity types that were moved to the trash",
"example": 8,
"format": "int64",
"type": "integer"
},
"trashedIndexCount": {
"description": "The total number of indexes for which the related entity types were moved to the trash",
"example": 10,
"format": "int64",
"type": "integer"
},
"trashedIndexSize": {
"description": "The total size of all indexes for which the related entity types were moved to the trash (KiB)",
"example": 8192,
"format": "int64",
"type": "integer"
},
"trashedModelCount": {
"description": "The total number of custom models that were moved to the trash",
"example": 2,
"format": "int64",
"type": "integer"
}
},
"type": "object"
}
},
"title": "The statistics of a tenant database",
"type": "object"
}
]
}
}
}
}
---
id: businessobjects.TenantDatabaseStatisticsBuilt
name: TenantDatabaseStatisticsBuilt
version: 1.0.0
summary: "Indicates that tenant database statistics have been successfully built"
producers:
- businessobjects
consumers: []
schemaPath: 'schema.json'
---
# TenantDatabaseStatisticsBuilt
Indicates that tenant database statistics have been successfully built
## Base Schema
All analytics events are based on the **TrackEvent** schema which provides common properties like `messageId`, `userId`, `context`, timestamps, and more.
**Base Schema Reference**: [analytics-track.yaml](https://event-catalog.prod.otc.fts.d-3.de/schemas/analytics-track.yaml)
## Event-Specific Properties
This schema shows only the event-specific properties that extend the base TrackEvent schema:
## Raw Schema:schema.json
{
"title": "Event-Specific Properties",
"type": "object",
"description": "Properties specific to this event type (extends BaseEvent)",
"extends": "https://event-catalog.int.otc.fts.d-3.de/schemas/analytics-track.yaml#/TrackEvent",
"eventType": "TenantDatabaseStatisticsBuilt",
"properties": {
"tenantDatabaseName": {
"description": "The name of the tenant database",
"example": "t_10qg",
"type": "string"
},
"entitySetCount": {
"description": "The total number of entity sets in use",
"example": 120,
"format": "int64",
"type": "integer"
},
"trashedEntityTypeCount": {
"description": "The total number of (custom) entity types that were moved to the trash",
"example": 8,
"format": "int64",
"type": "integer"
},
"trashedEntityCount": {
"description": "The total number of entities for which the related entity types were moved to the trash",
"example": 4000,
"format": "int64",
"type": "integer"
},
"id": {
"description": "The unique identifier under which the statistics is stored",
"example": "01JZAGPG76SXYC523XJAA7XNM7",
"type": "string"
},
"dataSize": {
"description": "The total size of the data in use (KiB)",
"example": 786432,
"format": "int64",
"type": "integer"
},
"entityTypeCount": {
"description": "The total number of (custom) entity types in use",
"example": 45,
"format": "int64",
"type": "integer"
},
"entityCount": {
"description": "The total number of entities in use",
"example": 20000,
"format": "int64",
"type": "integer"
},
"orphanedEntityCount": {
"description": "The total number of entities that are orphaned",
"example": 1000,
"format": "int64",
"type": "integer"
},
"tn": {
"description": "Unique identifier of the tenant",
"example": "3b1",
"type": "string"
},
"totalIndexSize": {
"description": "The total size of all indexes (KiB)",
"example": 65536,
"format": "int64",
"type": "integer"
},
"trashedEntitySetCount": {
"description": "The total number of entity sets for which the related entity types were moved to the trash",
"example": 20,
"format": "int64",
"type": "integer"
},
"trashedDataSize": {
"description": "The total size of the data for which the related entity types were moved to the trash (KiB)",
"example": 131072,
"format": "int64",
"type": "integer"
},
"orphanedEntitySetCount": {
"description": "The total number of entity sets that are orphaned",
"example": 10,
"format": "int64",
"type": "integer"
},
"orphanedIndexCount": {
"description": "The total number of indexes that are orphaned",
"example": 5,
"format": "int64",
"type": "integer"
},
"trashedIndexCount": {
"description": "The total number of indexes for which the related entity types were moved to the trash",
"example": 10,
"format": "int64",
"type": "integer"
},
"orphanedDataSize": {
"description": "The total size of the orphaned data (KiB)",
"example": 131072,
"format": "int64",
"type": "integer"
},
"totalEntitySetCount": {
"description": "The total number of entity sets",
"example": 150,
"format": "int64",
"type": "integer"
},
"totalEntityCount": {
"description": "The total number of entities",
"example": 25000,
"format": "int64",
"type": "integer"
},
"indexSize": {
"description": "The total size of all indexes in use (KiB)",
"example": 51200,
"format": "int64",
"type": "integer"
},
"trashedModelCount": {
"description": "The total number of custom models that were moved to the trash",
"example": 2,
"format": "int64",
"type": "integer"
},
"created": {
"description": "The time the statistics were created",
"example": "2025-11-03T10:31:11.311Z",
"format": "date-time",
"type": "string"
},
"orphanedIndexSize": {
"description": "The total size of all orphaned indexes (KiB)",
"example": 6144,
"format": "int64",
"type": "integer"
},
"totalDataSize": {
"description": "The total size of the data held in the database (KiB)",
"example": 1048576,
"format": "int64",
"type": "integer"
},
"totalIndexCount": {
"description": "The total number of indexes",
"example": 75,
"format": "int64",
"type": "integer"
},
"modelCount": {
"description": "The total number of custom models in use",
"example": 12,
"format": "int64",
"type": "integer"
},
"indexCount": {
"description": "The total number of indexes in use",
"example": 60,
"format": "int64",
"type": "integer"
},
"referenceId": {
"description": "Unique reference identifier of this event instance",
"example": "01JZAGPG76SXYC523XJAA7XNM7",
"type": "string"
},
"trashedIndexSize": {
"description": "The total size of all indexes for which the related entity types were moved to the trash (KiB)",
"example": 8192,
"format": "int64",
"type": "integer"
}
},
"components": {
"schemas": {
"AppPurgeReceivedPayload": {
"allOf": [
{
"$ref": "https://event-catalog.int.otc.fts.d-3.de/schemas/analytics-track.yaml#/TrackEvent"
},
{
"properties": {
"event": {
"const": "AppPurgeReceived"
},
"properties": {
"properties": {
"baseUri": {
"description": "Base URL of the tenant's cloud environment",
"example": "https://example.d-velop.cloud",
"format": "uri",
"type": "string"
},
"comment": {
"description": "Information that the event was backfilled",
"example": "backfilled",
"type": "string"
},
"received": {
"description": "Timestamp indicating when the purge request was received",
"example": "2025-07-08T10:31:11.311Z",
"format": "date-time",
"type": "string"
},
"referenceId": {
"description": "Unique reference identifier of this event instance",
"example": "01JZAGPG76SXYC523XJAA7XNM7",
"type": "string"
},
"tn": {
"description": "Unique identifier of the tenant for which the purge request was received",
"example": "3b1",
"type": "string"
}
},
"type": "object"
}
},
"title": "Specific event properties",
"type": "object"
}
]
},
"AppResubscribedPayload": {
"allOf": [
{
"$ref": "https://event-catalog.int.otc.fts.d-3.de/schemas/analytics-track.yaml#/TrackEvent"
},
{
"properties": {
"event": {
"const": "AppResubscribed"
},
"properties": {
"properties": {
"baseUri": {
"description": "Base URL of the tenant's cloud environment",
"example": "https://example.d-velop.cloud",
"format": "uri",
"type": "string"
},
"comment": {
"description": "Information that the event was backfilled",
"example": "backfilled",
"type": "string"
},
"received": {
"description": "Timestamp indicating when the tenant's app re-subscription was received",
"example": "2025-07-08T10:31:11.311Z",
"format": "date-time",
"type": "string"
},
"referenceId": {
"description": "Unique reference identifier of this event instance",
"example": "01JZAGPG76SXYC523XJAA7XNM7",
"type": "string"
},
"tn": {
"description": "Unique identifier of the re-subscribing tenant",
"example": "3b1",
"type": "string"
}
},
"type": "object"
}
},
"title": "Specific event properties",
"type": "object"
}
]
},
"AppSubscribedPayload": {
"allOf": [
{
"$ref": "https://event-catalog.int.otc.fts.d-3.de/schemas/analytics-track.yaml#/TrackEvent"
},
{
"properties": {
"event": {
"const": "AppSubscribed"
},
"properties": {
"properties": {
"baseUri": {
"description": "Base URL of the tenant's cloud environment",
"example": "https://example.d-velop.cloud",
"format": "uri",
"type": "string"
},
"comment": {
"description": "Information that the event was backfilled",
"example": "backfilled",
"type": "string"
},
"received": {
"description": "Timestamp indicating when the tenant's app subscription was received",
"example": "2025-07-08T10:31:11.311Z",
"format": "date-time",
"type": "string"
},
"referenceId": {
"description": "Unique reference identifier of this event instance",
"example": "01JZAGPG76SXYC523XJAA7XNM7",
"type": "string"
},
"tn": {
"description": "Unique identifier of the subscribing tenant",
"example": "3b1",
"type": "string"
}
},
"type": "object"
}
},
"title": "Specific event properties",
"type": "object"
}
]
},
"AppUnsubscribedPayload": {
"allOf": [
{
"$ref": "https://event-catalog.int.otc.fts.d-3.de/schemas/analytics-track.yaml#/TrackEvent"
},
{
"properties": {
"event": {
"const": "AppUnsubscribed"
},
"properties": {
"properties": {
"baseUri": {
"description": "Base URL of the tenant's cloud environment",
"example": "https://example.d-velop.cloud",
"format": "uri",
"type": "string"
},
"comment": {
"description": "Information that the event was backfilled",
"example": "backfilled",
"type": "string"
},
"received": {
"description": "Timestamp indicating when the tenant's app unsubscription was received",
"example": "2025-07-08T10:31:11.311Z",
"format": "date-time",
"type": "string"
},
"referenceId": {
"description": "Unique reference identifier of this event instance",
"example": "01JZAGPG76SXYC523XJAA7XNM7",
"type": "string"
},
"tn": {
"description": "Unique identifier of the unsubscribing tenant",
"example": "3b1",
"type": "string"
}
},
"type": "object"
}
},
"title": "Specific event properties",
"type": "object"
}
]
},
"DatabaseStatisticsBuiltPayload": {
"allOf": [
{
"$ref": "https://event-catalog.int.otc.fts.d-3.de/schemas/analytics-track.yaml#/TrackEvent"
},
{
"properties": {
"event": {
"const": "DatabaseStatisticsBuilt"
},
"properties": {
"properties": {
"comment": {
"description": "Information that the event was backfilled",
"example": "backfilled",
"type": "string"
},
"created": {
"description": "The time the statistics were created",
"example": "2025-11-03T10:31:11.311Z",
"format": "date-time",
"type": "string"
},
"dataSize": {
"description": "The total size of the data in use (KiB)",
"example": 1572864,
"format": "int64",
"type": "integer"
},
"entityCount": {
"description": "The total number of entities in use",
"example": 40000,
"format": "int64",
"type": "integer"
},
"entitySetCount": {
"description": "The total number of entity sets in use",
"example": 1200,
"format": "int64",
"type": "integer"
},
"entityTypeCount": {
"description": "The total number of (custom) entity types in use",
"example": 150,
"format": "int64",
"type": "integer"
},
"id": {
"description": "The unique identifier under which the statistics is stored",
"example": "01JZAGPG76SXYC523XJAA7XNM7",
"type": "string"
},
"indexCount": {
"description": "The total number of indexes in use",
"example": 240,
"format": "int64",
"type": "integer"
},
"indexSize": {
"description": "The total size of all indexes in use (KiB)",
"example": 102400,
"format": "int64",
"type": "integer"
},
"modelCount": {
"description": "The total number of custom models in use",
"example": 25,
"format": "int64",
"type": "integer"
},
"orphanedDataSize": {
"description": "The total size of the orphaned data (KiB)",
"example": 262144,
"format": "int64",
"type": "integer"
},
"orphanedEntityCount": {
"description": "The total number of entities that are orphaned",
"example": 2000,
"format": "int64",
"type": "integer"
},
"orphanedEntitySetCount": {
"description": "The total number of entity sets that are orphaned",
"example": 100,
"format": "int64",
"type": "integer"
},
"orphanedIndexCount": {
"description": "The total number of indexes that are orphaned",
"example": 20,
"format": "int64",
"type": "integer"
},
"orphanedIndexSize": {
"description": "The total size of all orphaned indexes (KiB)",
"example": 12288,
"format": "int64",
"type": "integer"
},
"referenceId": {
"description": "Unique reference identifier of this event instance",
"example": "01JZAGPG76SXYC523XJAA7XNM7",
"type": "string"
},
"tenantCount": {
"description": "The number of tenants included in the statistics",
"example": 150,
"format": "int64",
"type": "integer"
},
"totalDataSize": {
"description": "The total size of the data held in the database (KiB)",
"example": 2097152,
"format": "int64",
"type": "integer"
},
"totalEntityCount": {
"description": "The total number of entities",
"example": 50000,
"format": "int64",
"type": "integer"
},
"totalEntitySetCount": {
"description": "The total number of entity sets",
"example": 1500,
"format": "int64",
"type": "integer"
},
"totalIndexCount": {
"description": "The total number of indexes",
"example": 300,
"format": "int64",
"type": "integer"
},
"totalIndexSize": {
"description": "The total size of all indexes (KiB)",
"example": 131072,
"format": "int64",
"type": "integer"
},
"trashedDataSize": {
"description": "The total size of the data for which the related entity types were moved to the trash (KiB)",
"example": 262144,
"format": "int64",
"type": "integer"
},
"trashedEntityCount": {
"description": "The total number of entities for which the related entity types were moved to the trash",
"example": 8000,
"format": "int64",
"type": "integer"
},
"trashedEntitySetCount": {
"description": "The total number of entity sets for which the related entity types were moved to the trash",
"example": 200,
"format": "int64",
"type": "integer"
},
"trashedEntityTypeCount": {
"description": "The total number of (custom) entity types that were moved to the trash",
"example": 20,
"format": "int64",
"type": "integer"
},
"trashedIndexCount": {
"description": "The total number of indexes for which the related entity types were moved to the trash",
"example": 40,
"format": "int64",
"type": "integer"
},
"trashedIndexSize": {
"description": "The total size of all indexes for which the related entity types were moved to the trash (KiB)",
"example": 16384,
"format": "int64",
"type": "integer"
},
"trashedModelCount": {
"description": "The total number of custom models that were moved to the trash",
"example": 3,
"format": "int64",
"type": "integer"
}
},
"type": "object"
}
},
"title": "Database statistics that summarize the database statistics for all tenants",
"type": "object"
}
]
},
"EntitySetQueryMetricsAggregatedPayload": {
"allOf": [
{
"$ref": "https://event-catalog.int.otc.fts.d-3.de/schemas/analytics-track.yaml#/TrackEvent"
},
{
"description": "This event is emitted after queries have been executed against an entity set and their usage metrics have been aggregated. Aggregation is based on processing time. Metrics are grouped into fixed aggregation windows defined by `aggregationWindowStart` (inclusive) and `aggregationWindowEnd` (exclusive). Queries occurring near window boundaries may be assigned to either adjacent window.\n",
"properties": {
"event": {
"const": "EntitySetQueryMetricsAggregated"
},
"properties": {
"properties": {
"aggregationInterval": {
"description": "Duration of the aggregation window used for this event. Typically equals `aggregationWindowEnd` minus `aggregationWindowStart`. Must be an ISO 8601 duration (e.g. PT30S, PT5M, PT1H).\n",
"example": "PT30S",
"type": "string"
},
"aggregationWindowEnd": {
"description": "End timestamp (exclusive) of the aggregation window.\n",
"example": "2026-02-24T10:00:30Z",
"format": "date-time",
"type": "string"
},
"aggregationWindowStart": {
"description": "Start timestamp (inclusive) of the aggregation window.\n",
"example": "2026-02-24T10:00:00Z",
"format": "date-time",
"type": "string"
},
"dataSource": {
"description": "Identifier of the logical context or model against which the entity set query was executed. A data source groups multiple related entity types and entity sets and represents the functional context of that query.\n",
"example": "crm",
"type": "string"
},
"entitiesReturned": {
"description": "Total number of entities returned across all executed queries for this entity set within the measured scope.\n",
"example": 12509,
"minimum": 0,
"type": "integer"
},
"entitySet": {
"description": "Name of the entity set that was queried.",
"example": "customers",
"type": "string"
},
"functionCounts": {
"description": "Counter array representing how often specific query functions were used. The array index corresponds to the internal FunctionFeatures flag position. Index 0 represents queries without functions. The array contains 41 entries, one for each defined function feature bit, including the `None` and `Unknown` flags.\n",
"example": [
10,
0,
2,
1,
0,
0,
3,
5,
0,
0,
0,
1,
0,
0,
0,
0,
0,
0,
0,
0,
0,
0,
0,
0,
0,
0,
0,
0,
0,
0,
0,
0,
0,
0,
0,
0,
0,
0,
0,
0,
0
],
"items": {
"minimum": 0,
"type": "integer"
},
"maxItems": 41,
"minItems": 41,
"type": "array"
},
"operatorCounts": {
"description": "Counter array representing how often specific filter operators were used. The array index corresponds to the internal OperatorFeatures flag position. Index 0 represents queries without operators. The array contains 19 entries, one for each defined operator feature bit, including the `None` and `Unknown` flags.\n",
"example": [
2,
0,
0,
4,
1,
0,
0,
3,
0,
0,
0,
1,
0,
0,
0,
0,
0,
0,
0
],
"items": {
"minimum": 0,
"type": "integer"
},
"maxItems": 19,
"minItems": 19,
"type": "array"
},
"queryCount": {
"description": "Total number of queries executed for this entity set within the measured scope.",
"example": 133,
"minimum": 0,
"type": "integer"
},
"queryOptionCounts": {
"description": "Counter array representing how often specific query options were used. The array index corresponds to the internal QueryOptionFeatures flag position. Index 0 represents queries without any query options. The array contains 17 entries, one for each defined query option feature bit, including the `None` and `Unknown` flags.\n",
"example": [
5,
0,
3,
0,
1,
0,
0,
2,
0,
0,
0,
1,
0,
0,
0,
0,
0
],
"items": {
"minimum": 0,
"type": "integer"
},
"maxItems": 17,
"minItems": 17,
"type": "array"
},
"schemaNamespace": {
"description": "Logical namespace of the schema in which the queried entity set is defined. Indicates whether the schema is system-provided (e.g. `core`) or tenant-specific (`custom`).\n",
"example": "custom",
"type": "string"
}
},
"type": "object"
}
},
"title": "Entity Set Query Metrics Aggregated Event",
"type": "object"
}
]
},
"EntitySetStatisticsBuiltPayload": {
"allOf": [
{
"$ref": "https://event-catalog.int.otc.fts.d-3.de/schemas/analytics-track.yaml#/TrackEvent"
},
{
"properties": {
"event": {
"const": "EntitySetStatisticsBuilt"
},
"properties": {
"properties": {
"averageEntitySize": {
"description": "The average size of an entity in the entity set",
"example": 2,
"format": "int64",
"type": "integer"
},
"comment": {
"description": "Information that the event was backfilled",
"example": "backfilled",
"type": "string"
},
"dataSize": {
"description": "The size of the data in the entity set (KiB)",
"example": 1024,
"format": "int64",
"type": "integer"
},
"entityCount": {
"description": "The number of entities in the entity set",
"example": 500,
"format": "int64",
"type": "integer"
},
"indexCount": {
"description": "The number of indexes",
"example": 3,
"format": "int64",
"type": "integer"
},
"indexSize": {
"description": "The size of the indexes (KiB)",
"example": 128,
"format": "int64",
"type": "integer"
},
"kind": {
"description": "The kind of the entity set (e.g., trashed, active)",
"example": "active",
"type": "string"
},
"name": {
"description": "The (logical) name of the entity set",
"example": "Products",
"type": "string"
},
"physicalName": {
"description": "The physical name of the entity set",
"example": "products_3b1_collection",
"type": "string"
},
"referenceId": {
"description": "Unique reference identifier of this event instance",
"example": "01JZAGPG76SXYC523XJAA7XNM7",
"type": "string"
},
"tn": {
"description": "Unique identifier of the tenant",
"example": "3b1",
"type": "string"
},
"typeName": {
"description": "The type name of the entities in the entity set",
"example": "Product",
"type": "string"
}
},
"type": "object"
}
},
"title": "The statistics of a tenant entity set",
"type": "object"
}
]
},
"TenantComputedTierChangedPayload": {
"allOf": [
{
"$ref": "https://event-catalog.int.otc.fts.d-3.de/schemas/analytics-track.yaml#/TrackEvent"
},
{
"properties": {
"event": {
"const": "TenantComputedTierChanged"
},
"properties": {
"properties": {
"newTier": {
"description": "The new computed tier of the tenant",
"example": "basic",
"type": "string"
},
"oldTier": {
"description": "The previous computed tier of the tenant",
"example": "standard",
"type": "string"
},
"tierDeterminants": {
"description": "The factors that determined the new tier calculation",
"example": "TotalEntityCount: 925, EntitySetMaxEntityCount: 382",
"type": "string"
},
"tn": {
"description": "Unique identifier of the tenant",
"example": "3b1",
"type": "string"
}
},
"type": "object"
}
},
"title": "Tenant computed tier change event",
"type": "object"
}
]
},
"TenantDatabaseStatisticsBuiltPayload": {
"allOf": [
{
"$ref": "https://event-catalog.int.otc.fts.d-3.de/schemas/analytics-track.yaml#/TrackEvent"
},
{
"properties": {
"event": {
"const": "TenantDatabaseStatisticsBuilt"
},
"properties": {
"properties": {
"created": {
"description": "The time the statistics were created",
"example": "2025-11-03T10:31:11.311Z",
"format": "date-time",
"type": "string"
},
"dataSize": {
"description": "The total size of the data in use (KiB)",
"example": 786432,
"format": "int64",
"type": "integer"
},
"entityCount": {
"description": "The total number of entities in use",
"example": 20000,
"format": "int64",
"type": "integer"
},
"entitySetCount": {
"description": "The total number of entity sets in use",
"example": 120,
"format": "int64",
"type": "integer"
},
"entityTypeCount": {
"description": "The total number of (custom) entity types in use",
"example": 45,
"format": "int64",
"type": "integer"
},
"id": {
"description": "The unique identifier under which the statistics is stored",
"example": "01JZAGPG76SXYC523XJAA7XNM7",
"type": "string"
},
"indexCount": {
"description": "The total number of indexes in use",
"example": 60,
"format": "int64",
"type": "integer"
},
"indexSize": {
"description": "The total size of all indexes in use (KiB)",
"example": 51200,
"format": "int64",
"type": "integer"
},
"modelCount": {
"description": "The total number of custom models in use",
"example": 12,
"format": "int64",
"type": "integer"
},
"orphanedDataSize": {
"description": "The total size of the orphaned data (KiB)",
"example": 131072,
"format": "int64",
"type": "integer"
},
"orphanedEntityCount": {
"description": "The total number of entities that are orphaned",
"example": 1000,
"format": "int64",
"type": "integer"
},
"orphanedEntitySetCount": {
"description": "The total number of entity sets that are orphaned",
"example": 10,
"format": "int64",
"type": "integer"
},
"orphanedIndexCount": {
"description": "The total number of indexes that are orphaned",
"example": 5,
"format": "int64",
"type": "integer"
},
"orphanedIndexSize": {
"description": "The total size of all orphaned indexes (KiB)",
"example": 6144,
"format": "int64",
"type": "integer"
},
"referenceId": {
"description": "Unique reference identifier of this event instance",
"example": "01JZAGPG76SXYC523XJAA7XNM7",
"type": "string"
},
"tenantDatabaseName": {
"description": "The name of the tenant database",
"example": "t_10qg",
"type": "string"
},
"tn": {
"description": "Unique identifier of the tenant",
"example": "3b1",
"type": "string"
},
"totalDataSize": {
"description": "The total size of the data held in the database (KiB)",
"example": 1048576,
"format": "int64",
"type": "integer"
},
"totalEntityCount": {
"description": "The total number of entities",
"example": 25000,
"format": "int64",
"type": "integer"
},
"totalEntitySetCount": {
"description": "The total number of entity sets",
"example": 150,
"format": "int64",
"type": "integer"
},
"totalIndexCount": {
"description": "The total number of indexes",
"example": 75,
"format": "int64",
"type": "integer"
},
"totalIndexSize": {
"description": "The total size of all indexes (KiB)",
"example": 65536,
"format": "int64",
"type": "integer"
},
"trashedDataSize": {
"description": "The total size of the data for which the related entity types were moved to the trash (KiB)",
"example": 131072,
"format": "int64",
"type": "integer"
},
"trashedEntityCount": {
"description": "The total number of entities for which the related entity types were moved to the trash",
"example": 4000,
"format": "int64",
"type": "integer"
},
"trashedEntitySetCount": {
"description": "The total number of entity sets for which the related entity types were moved to the trash",
"example": 20,
"format": "int64",
"type": "integer"
},
"trashedEntityTypeCount": {
"description": "The total number of (custom) entity types that were moved to the trash",
"example": 8,
"format": "int64",
"type": "integer"
},
"trashedIndexCount": {
"description": "The total number of indexes for which the related entity types were moved to the trash",
"example": 10,
"format": "int64",
"type": "integer"
},
"trashedIndexSize": {
"description": "The total size of all indexes for which the related entity types were moved to the trash (KiB)",
"example": 8192,
"format": "int64",
"type": "integer"
},
"trashedModelCount": {
"description": "The total number of custom models that were moved to the trash",
"example": 2,
"format": "int64",
"type": "integer"
}
},
"type": "object"
}
},
"title": "The statistics of a tenant database",
"type": "object"
}
]
}
}
}
}
---
id: contextaction.ContextActionDialogDismissed
name: ContextActionDialogDismissed
version: 1.0.0
summary: "When an action dialog is closed, recording how it was dismissed (close icon, abort button, cancel, or programmatically)"
producers:
- contextaction
consumers: []
schemaPath: 'schema.json'
---
# ContextActionDialogDismissed
When an action dialog is closed, recording how it was dismissed (close icon, abort button, cancel, or programmatically)
## Base Schema
All analytics events are based on the **TrackEvent** schema which provides common properties like `messageId`, `userId`, `context`, timestamps, and more.
**Base Schema Reference**: [analytics-track.yaml](https://event-catalog.prod.otc.fts.d-3.de/schemas/analytics-track.yaml)
## Event-Specific Properties
This schema shows only the event-specific properties that extend the base TrackEvent schema:
## Raw Schema:schema.json
{
"title": "Event-Specific Properties",
"type": "object",
"description": "Properties specific to this event type (extends BaseEvent)",
"extends": "https://event-catalog.prod.otc.fts.d-3.de/schemas/analytics-track.yaml#/TrackEvent",
"eventType": "ContextActionDialogDismissed",
"properties": {
"source": {
"$ref": "#/components/schemas/DismissSource"
},
"actionId": {
"description": "The ID of the context action whose dialog was dismissed",
"type": "string"
},
"actionGroup": {
"$ref": "#/components/schemas/ActionGroup"
},
"actionType": {
"$ref": "#/components/schemas/DialogActionType"
},
"actionContext": {
"$ref": "#/components/schemas/ActionContext"
},
"legacy": {
"description": "True when the action originates from a legacy (non-fragment-native) action provider",
"type": "boolean"
}
},
"components": {
"schemas": {
"ActionContext": {
"description": "The selection contexts in which the action is available",
"items": {
"enum": [
"singleSelect",
"multiSelect"
],
"type": "string"
},
"type": "array"
},
"ActionGroup": {
"description": "The group the context action belongs to, used to organize actions in the menu",
"enum": [
"open",
"new",
"download",
"share",
"ai",
"edit",
"processes",
"link",
"delete",
"other"
],
"type": "string"
},
"ActionType": {
"description": "The target type of the context action that determines how it is executed",
"enum": [
"url",
"federation",
"dapi-callback"
],
"type": "string"
},
"DialogActionType": {
"description": "The target type of a context action rendered in a dialog (dialogs support only url and federation targets)",
"enum": [
"url",
"federation"
],
"type": "string"
},
"DismissSource": {
"description": "How the action dialog was dismissed",
"enum": [
"closeIcon",
"abortButton",
"cancel",
"programmatic"
],
"type": "string"
},
"Source": {
"description": "The consumer of the context action API that triggered the DMS object fetch",
"enum": [
"menu",
"toolbar"
],
"type": "string"
}
}
}
}
---
id: contextaction.ContextActionDialogPrimaryAction
name: ContextActionDialogPrimaryAction
version: 1.0.0
summary: "When a user clicks the primary action button within an action dialog"
producers:
- contextaction
consumers: []
schemaPath: 'schema.json'
---
# ContextActionDialogPrimaryAction
When a user clicks the primary action button within an action dialog
## Base Schema
All analytics events are based on the **TrackEvent** schema which provides common properties like `messageId`, `userId`, `context`, timestamps, and more.
**Base Schema Reference**: [analytics-track.yaml](https://event-catalog.prod.otc.fts.d-3.de/schemas/analytics-track.yaml)
## Event-Specific Properties
This schema shows only the event-specific properties that extend the base TrackEvent schema:
## Raw Schema:schema.json
{
"title": "Event-Specific Properties",
"type": "object",
"description": "Properties specific to this event type (extends BaseEvent)",
"extends": "https://event-catalog.prod.otc.fts.d-3.de/schemas/analytics-track.yaml#/TrackEvent",
"eventType": "ContextActionDialogPrimaryAction",
"properties": {
"legacy": {
"description": "True when the action originates from a legacy (non-fragment-native) action provider",
"type": "boolean"
},
"dialogActionId": {
"description": "The ID of the primary dialog button that was activated",
"type": "string"
},
"actionId": {
"description": "The ID of the context action that opened the dialog",
"type": "string"
},
"actionGroup": {
"$ref": "#/components/schemas/ActionGroup"
},
"actionType": {
"$ref": "#/components/schemas/DialogActionType"
},
"actionContext": {
"$ref": "#/components/schemas/ActionContext"
}
},
"components": {
"schemas": {
"ActionContext": {
"description": "The selection contexts in which the action is available",
"items": {
"enum": [
"singleSelect",
"multiSelect"
],
"type": "string"
},
"type": "array"
},
"ActionGroup": {
"description": "The group the context action belongs to, used to organize actions in the menu",
"enum": [
"open",
"new",
"download",
"share",
"ai",
"edit",
"processes",
"link",
"delete",
"other"
],
"type": "string"
},
"ActionType": {
"description": "The target type of the context action that determines how it is executed",
"enum": [
"url",
"federation",
"dapi-callback"
],
"type": "string"
},
"DialogActionType": {
"description": "The target type of a context action rendered in a dialog (dialogs support only url and federation targets)",
"enum": [
"url",
"federation"
],
"type": "string"
},
"DismissSource": {
"description": "How the action dialog was dismissed",
"enum": [
"closeIcon",
"abortButton",
"cancel",
"programmatic"
],
"type": "string"
},
"Source": {
"description": "The consumer of the context action API that triggered the DMS object fetch",
"enum": [
"menu",
"toolbar"
],
"type": "string"
}
}
}
}
---
id: contextaction.ContextActionDialogSecondaryAction
name: ContextActionDialogSecondaryAction
version: 1.0.0
summary: "When a user clicks the secondary action button within an action dialog"
producers:
- contextaction
consumers: []
schemaPath: 'schema.json'
---
# ContextActionDialogSecondaryAction
When a user clicks the secondary action button within an action dialog
## Base Schema
All analytics events are based on the **TrackEvent** schema which provides common properties like `messageId`, `userId`, `context`, timestamps, and more.
**Base Schema Reference**: [analytics-track.yaml](https://event-catalog.prod.otc.fts.d-3.de/schemas/analytics-track.yaml)
## Event-Specific Properties
This schema shows only the event-specific properties that extend the base TrackEvent schema:
## Raw Schema:schema.json
{
"title": "Event-Specific Properties",
"type": "object",
"description": "Properties specific to this event type (extends BaseEvent)",
"extends": "https://event-catalog.prod.otc.fts.d-3.de/schemas/analytics-track.yaml#/TrackEvent",
"eventType": "ContextActionDialogSecondaryAction",
"properties": {
"dialogActionId": {
"description": "The ID of the secondary dialog button that was activated",
"type": "string"
},
"actionId": {
"description": "The ID of the context action that opened the dialog",
"type": "string"
},
"actionGroup": {
"$ref": "#/components/schemas/ActionGroup"
},
"actionType": {
"$ref": "#/components/schemas/DialogActionType"
},
"actionContext": {
"$ref": "#/components/schemas/ActionContext"
},
"legacy": {
"description": "True when the action originates from a legacy (non-fragment-native) action provider",
"type": "boolean"
}
},
"components": {
"schemas": {
"ActionContext": {
"description": "The selection contexts in which the action is available",
"items": {
"enum": [
"singleSelect",
"multiSelect"
],
"type": "string"
},
"type": "array"
},
"ActionGroup": {
"description": "The group the context action belongs to, used to organize actions in the menu",
"enum": [
"open",
"new",
"download",
"share",
"ai",
"edit",
"processes",
"link",
"delete",
"other"
],
"type": "string"
},
"ActionType": {
"description": "The target type of the context action that determines how it is executed",
"enum": [
"url",
"federation",
"dapi-callback"
],
"type": "string"
},
"DialogActionType": {
"description": "The target type of a context action rendered in a dialog (dialogs support only url and federation targets)",
"enum": [
"url",
"federation"
],
"type": "string"
},
"DismissSource": {
"description": "How the action dialog was dismissed",
"enum": [
"closeIcon",
"abortButton",
"cancel",
"programmatic"
],
"type": "string"
},
"Source": {
"description": "The consumer of the context action API that triggered the DMS object fetch",
"enum": [
"menu",
"toolbar"
],
"type": "string"
}
}
}
}
---
id: contextaction.ContextActionDmsObjectFetched
name: ContextActionDmsObjectFetched
version: 1.0.0
summary: "When a document is actually fetched from the server (a cache miss) by a consumer of the context action API. One event is emitted per fetched document and carries the requesting source, enabling per-consumer fetch volume and preload success analysis."
producers:
- contextaction
consumers: []
schemaPath: 'schema.json'
---
# ContextActionDmsObjectFetched
When a document is actually fetched from the server (a cache miss) by a consumer of the context action API. One event is emitted per fetched document and carries the requesting source, enabling per-consumer fetch volume and preload success analysis.
## Base Schema
All analytics events are based on the **TrackEvent** schema which provides common properties like `messageId`, `userId`, `context`, timestamps, and more.
**Base Schema Reference**: [analytics-track.yaml](https://event-catalog.prod.otc.fts.d-3.de/schemas/analytics-track.yaml)
## Event-Specific Properties
This schema shows only the event-specific properties that extend the base TrackEvent schema:
## Raw Schema:schema.json
{
"title": "Event-Specific Properties",
"type": "object",
"description": "Properties specific to this event type (extends BaseEvent)",
"extends": "https://event-catalog.prod.otc.fts.d-3.de/schemas/analytics-track.yaml#/TrackEvent",
"eventType": "ContextActionDmsObjectFetched",
"properties": {
"repoId": {
"description": "ID of the repository the fetched document belongs to. Correlates this event with ContextActionMenuOpened for the same document.",
"type": "string"
},
"docId": {
"description": "ID of the fetched document. A fetched document that never appears in a later ContextActionMenuOpened identifies a wasted preload.",
"type": "string"
},
"source": {
"$ref": "#/components/schemas/Source"
}
},
"components": {
"schemas": {
"ActionContext": {
"description": "The selection contexts in which the action is available",
"items": {
"enum": [
"singleSelect",
"multiSelect"
],
"type": "string"
},
"type": "array"
},
"ActionGroup": {
"description": "The group the context action belongs to, used to organize actions in the menu",
"enum": [
"open",
"new",
"download",
"share",
"ai",
"edit",
"processes",
"link",
"delete",
"other"
],
"type": "string"
},
"ActionType": {
"description": "The target type of the context action that determines how it is executed",
"enum": [
"url",
"federation",
"dapi-callback"
],
"type": "string"
},
"DialogActionType": {
"description": "The target type of a context action rendered in a dialog (dialogs support only url and federation targets)",
"enum": [
"url",
"federation"
],
"type": "string"
},
"DismissSource": {
"description": "How the action dialog was dismissed",
"enum": [
"closeIcon",
"abortButton",
"cancel",
"programmatic"
],
"type": "string"
},
"Source": {
"description": "The consumer of the context action API that triggered the DMS object fetch",
"enum": [
"menu",
"toolbar"
],
"type": "string"
}
}
}
}
---
id: contextaction.ContextActionInvoked
name: ContextActionInvoked
version: 1.0.0
summary: "When a user clicks a context action from the menu, via click or by pressing Enter/Space"
producers:
- contextaction
consumers: []
schemaPath: 'schema.json'
---
# ContextActionInvoked
When a user clicks a context action from the menu, via click or by pressing Enter/Space
## Base Schema
All analytics events are based on the **TrackEvent** schema which provides common properties like `messageId`, `userId`, `context`, timestamps, and more.
**Base Schema Reference**: [analytics-track.yaml](https://event-catalog.prod.otc.fts.d-3.de/schemas/analytics-track.yaml)
## Event-Specific Properties
This schema shows only the event-specific properties that extend the base TrackEvent schema:
## Raw Schema:schema.json
{
"title": "Event-Specific Properties",
"type": "object",
"description": "Properties specific to this event type (extends BaseEvent)",
"extends": "https://event-catalog.prod.otc.fts.d-3.de/schemas/analytics-track.yaml#/TrackEvent",
"eventType": "ContextActionInvoked",
"properties": {
"actionId": {
"description": "The ID of the invoked context action",
"type": "string"
},
"actionGroup": {
"$ref": "#/components/schemas/ActionGroup"
},
"actionType": {
"$ref": "#/components/schemas/ActionType"
},
"actionContext": {
"$ref": "#/components/schemas/ActionContext"
},
"legacy": {
"description": "True when the action originates from a legacy (non-fragment-native) action provider",
"type": "boolean"
}
},
"components": {
"schemas": {
"ActionContext": {
"description": "The selection contexts in which the action is available",
"items": {
"enum": [
"singleSelect",
"multiSelect"
],
"type": "string"
},
"type": "array"
},
"ActionGroup": {
"description": "The group the context action belongs to, used to organize actions in the menu",
"enum": [
"open",
"new",
"download",
"share",
"ai",
"edit",
"processes",
"link",
"delete",
"other"
],
"type": "string"
},
"ActionType": {
"description": "The target type of the context action that determines how it is executed",
"enum": [
"url",
"federation",
"dapi-callback"
],
"type": "string"
},
"DialogActionType": {
"description": "The target type of a context action rendered in a dialog (dialogs support only url and federation targets)",
"enum": [
"url",
"federation"
],
"type": "string"
},
"DismissSource": {
"description": "How the action dialog was dismissed",
"enum": [
"closeIcon",
"abortButton",
"cancel",
"programmatic"
],
"type": "string"
},
"Source": {
"description": "The consumer of the context action API that triggered the DMS object fetch",
"enum": [
"menu",
"toolbar"
],
"type": "string"
}
}
}
}
---
id: contextaction.ContextActionMenuOpened
name: ContextActionMenuOpened
version: 1.0.0
summary: "When the context action menu is opened. Carries cacheHit, which is true when the DMS object (and fragment data) was already preloaded into the in-memory cache — used together with ContextActionDmsObjectFetched to measure how often preloads pay off."
producers:
- contextaction
consumers: []
schemaPath: 'schema.json'
---
# ContextActionMenuOpened
When the context action menu is opened. Carries cacheHit, which is true when the DMS object (and fragment data) was already preloaded into the in-memory cache — used together with ContextActionDmsObjectFetched to measure how often preloads pay off.
## Base Schema
All analytics events are based on the **TrackEvent** schema which provides common properties like `messageId`, `userId`, `context`, timestamps, and more.
**Base Schema Reference**: [analytics-track.yaml](https://event-catalog.prod.otc.fts.d-3.de/schemas/analytics-track.yaml)
## Event-Specific Properties
This schema shows only the event-specific properties that extend the base TrackEvent schema:
## Raw Schema:schema.json
{
"title": "Event-Specific Properties",
"type": "object",
"description": "Properties specific to this event type (extends BaseEvent)",
"extends": "https://event-catalog.prod.otc.fts.d-3.de/schemas/analytics-track.yaml#/TrackEvent",
"eventType": "ContextActionMenuOpened",
"properties": {
"docId": {
"description": "ID of the document the menu was opened for. Correlates this event with ContextActionDmsObjectFetched for the same document.",
"type": "string"
},
"cacheHit": {
"description": "True when the DMS object and fragment data were already in the in-memory cache (a prior preload paid off) when the menu opened",
"type": "boolean"
},
"repoId": {
"description": "ID of the repository the document belongs to. Correlates this event with ContextActionDmsObjectFetched for the same document.",
"type": "string"
}
},
"components": {
"schemas": {
"ActionContext": {
"description": "The selection contexts in which the action is available",
"items": {
"enum": [
"singleSelect",
"multiSelect"
],
"type": "string"
},
"type": "array"
},
"ActionGroup": {
"description": "The group the context action belongs to, used to organize actions in the menu",
"enum": [
"open",
"new",
"download",
"share",
"ai",
"edit",
"processes",
"link",
"delete",
"other"
],
"type": "string"
},
"ActionType": {
"description": "The target type of the context action that determines how it is executed",
"enum": [
"url",
"federation",
"dapi-callback"
],
"type": "string"
},
"DialogActionType": {
"description": "The target type of a context action rendered in a dialog (dialogs support only url and federation targets)",
"enum": [
"url",
"federation"
],
"type": "string"
},
"DismissSource": {
"description": "How the action dialog was dismissed",
"enum": [
"closeIcon",
"abortButton",
"cancel",
"programmatic"
],
"type": "string"
},
"Source": {
"description": "The consumer of the context action API that triggered the DMS object fetch",
"enum": [
"menu",
"toolbar"
],
"type": "string"
}
}
}
}
---
id: dash.DashboardEdited
name: DashboardEdited
version: 1.0.0
summary: "Event emitted when a user edits their dashboard."
producers:
- dash
consumers: []
schemaPath: 'schema.json'
---
# DashboardEdited
Event emitted when a user edits their dashboard.
## Base Schema
All analytics events are based on the **TrackEvent** schema which provides common properties like `messageId`, `userId`, `context`, timestamps, and more.
**Base Schema Reference**: [analytics-track.yaml](https://event-catalog.prod.otc.fts.d-3.de/schemas/analytics-track.yaml)
## Event-Specific Properties
This schema shows only the event-specific properties that extend the base TrackEvent schema:
## Raw Schema:schema.json
{
"title": "Event-Specific Properties",
"type": "object",
"description": "Properties specific to this event type (extends BaseEvent)",
"extends": "../../../base/base-event.yaml#/BaseEvent",
"eventType": "DashboardEdited",
"properties": {
"kind": {
"description": "The kind of edit performed on the dashboard.",
"enum": [
"saved",
"discarded"
],
"type": "string"
},
"transactionId": {
"description": "Unique identifier of the edit transaction. This is set when the user opens the dashboard editor.",
"type": "string"
},
"dashboardId": {
"description": "Unique identifier of the dashboard that was edited.",
"type": "string"
}
}
}
---
id: dash.DashboardMetricsCollected
name: DashboardMetricsCollected
version: 1.0.0
summary: "Event emitted once a day containing collected dashboard metrics from the database."
producers:
- dash
consumers: []
schemaPath: 'schema.json'
---
# DashboardMetricsCollected
Event emitted once a day containing collected dashboard metrics from the database.
## Base Schema
All analytics events are based on the **TrackEvent** schema which provides common properties like `messageId`, `userId`, `context`, timestamps, and more.
**Base Schema Reference**: [analytics-track.yaml](https://event-catalog.prod.otc.fts.d-3.de/schemas/analytics-track.yaml)
## Event-Specific Properties
This schema shows only the event-specific properties that extend the base TrackEvent schema:
## Raw Schema:schema.json
{
"title": "Event-Specific Properties",
"type": "object",
"description": "Properties specific to this event type (extends BaseEvent)",
"extends": "../../../base/base-event.yaml#/BaseEvent",
"eventType": "DashboardMetricsCollected",
"properties": {
"assignedTnDashboardsPerTnDistr": {
"additionalProperties": {
"description": "Number of tenants with the corresponding number of assigned tenant dashboards.",
"type": "integer"
},
"description": "Distribution of the number of assigned tenant dashboards per tenant.",
"propertyNames": {
"enum": [
"50",
"30",
"20",
"10",
"8",
"5",
"3",
"2",
"1",
"0"
]
},
"type": "object"
},
"totalTenantsWithWidgetVisEnable": {
"description": "Total number of tenants that have enabled widget visibility settings.",
"type": "integer"
},
"avgConsumersPerWidgetVisConfig": {
"description": "Average number of consumers per widget visibility configuration.",
"format": "float",
"type": "number"
},
"avgGroupsPerWidgetVisConfig": {
"description": "Average number of groups per widget visibility configuration.",
"format": "float",
"type": "number"
},
"tenantWidgetUsage": {
"description": "Total number of tenants that use tenant widgets.",
"type": "integer"
},
"avgAssignedTnDashboardsPerTnNew": {
"description": "Average number of assigned tenant dashboards per tenant.",
"format": "float",
"type": "number"
},
"tenantDashboardsPerTenantDistr": {
"additionalProperties": {
"description": "Number of tenants with the corresponding number of tenant dashboards.",
"type": "integer"
},
"description": "Distribution of the number of tenant dashboards per tenant.",
"propertyNames": {
"enum": [
"50",
"30",
"20",
"10",
"8",
"5",
"3",
"2",
"1",
"0"
]
},
"type": "object"
},
"consumersPerWidgetVisConfigDist": {
"additionalProperties": {
"description": "Number of widget visibility configurations with the corresponding number of consumers.",
"type": "integer"
},
"description": "Distribution of the number of consumers per widget visibility configuration.",
"propertyNames": {
"enum": [
"50",
"30",
"20",
"15",
"10",
"5",
"3",
"2",
"1",
"0"
]
},
"type": "object"
},
"usersPerWidgetVisConfigDist": {
"additionalProperties": {
"description": "Number of widget visibility configurations with the corresponding number of users.",
"type": "integer"
},
"description": "Distribution of the number of users per widget visibility configuration.",
"propertyNames": {
"enum": [
"50",
"30",
"20",
"15",
"10",
"5",
"3",
"2",
"1",
"0"
]
},
"type": "object"
},
"iFrameTenantWidgetUsage": {
"description": "Total number of tenants that use tenant iframe widgets.",
"type": "integer"
},
"avgTenantDashboardsPerTenant": {
"description": "Average number of tenant dashboards per tenant.",
"format": "float",
"type": "number"
},
"avgUsersPerWidgetVisConfig": {
"description": "Average number of users per widget visibility configuration.",
"format": "float",
"type": "number"
},
"totalTenantWidgetsCount": {
"description": "Total number of tenant widgets across all tenants.",
"type": "integer"
},
"totalListTenantWidgetsCount": {
"description": "Total number of tenant list widgets across all tenants.",
"type": "integer"
},
"listTenantWidgetUsage": {
"description": "Total number of tenants that use tenant list widgets.",
"type": "integer"
},
"totalTenantDashboardsCount": {
"description": "Total number of tenant dashboards across all tenants that use dashboard V2.",
"type": "integer"
},
"totalV2TenantsCount": {
"description": "Total number of tenants that use dashboard V2.",
"type": "integer"
},
"groupsPerWidgetVisConfigDist": {
"additionalProperties": {
"description": "Number of widget visibility configurations with the corresponding number of groups.",
"type": "integer"
},
"description": "Distribution of the number of groups per widget visibility configuration.",
"propertyNames": {
"enum": [
"50",
"30",
"20",
"15",
"10",
"5",
"3",
"2",
"1",
"0"
]
},
"type": "object"
},
"totalIFrameTenantWidgetsCount": {
"description": "Total number of tenant iframe widgets across all tenants.",
"type": "integer"
},
"totalDisabledV2TenantsCount": {
"description": "Total number of tenants that have disabled dashboard V2.",
"type": "integer"
},
"totalCustomizableTnBoardCount": {
"description": "Total number of customizable tenant dashboards across all tenants.",
"type": "integer"
}
}
}
---
id: dash.DashboardPublicAPIRequestReceived
name: DashboardPublicAPIRequestReceived
version: 1.0.0
summary: "Event emitted when a request is made to the Dashboard Public API."
producers:
- dash
consumers: []
schemaPath: 'schema.json'
---
# DashboardPublicAPIRequestReceived
Event emitted when a request is made to the Dashboard Public API.
## Base Schema
All analytics events are based on the **TrackEvent** schema which provides common properties like `messageId`, `userId`, `context`, timestamps, and more.
**Base Schema Reference**: [analytics-track.yaml](https://event-catalog.prod.otc.fts.d-3.de/schemas/analytics-track.yaml)
## Event-Specific Properties
This schema shows only the event-specific properties that extend the base TrackEvent schema:
## Raw Schema:schema.json
{
"title": "Event-Specific Properties",
"type": "object",
"description": "Properties specific to this event type (extends BaseEvent)",
"extends": "../../../base/base-event.yaml#/BaseEvent",
"eventType": "DashboardPublicAPIRequestReceived",
"properties": {
"routeType": {
"description": "The type of route accessed in the Dashboard Public API.",
"enum": [
"collection",
"singleton"
],
"type": "string"
},
"httpMethod": {
"description": "The HTTP method used for the request.",
"enum": [
"GET",
"POST",
"PUT",
"DELETE"
],
"type": "string"
}
}
}
---
id: dash.DashboardPublicAPIRequestSuccessful
name: DashboardPublicAPIRequestSuccessful
version: 1.0.0
summary: "Event emitted when a request to the Dashboard Public API is successful."
producers:
- dash
consumers: []
schemaPath: 'schema.json'
---
# DashboardPublicAPIRequestSuccessful
Event emitted when a request to the Dashboard Public API is successful.
## Base Schema
All analytics events are based on the **TrackEvent** schema which provides common properties like `messageId`, `userId`, `context`, timestamps, and more.
**Base Schema Reference**: [analytics-track.yaml](https://event-catalog.prod.otc.fts.d-3.de/schemas/analytics-track.yaml)
## Event-Specific Properties
This schema shows only the event-specific properties that extend the base TrackEvent schema:
## Raw Schema:schema.json
{
"title": "Event-Specific Properties",
"type": "object",
"description": "Properties specific to this event type (extends BaseEvent)",
"extends": "../../../base/base-event.yaml#/BaseEvent",
"eventType": "DashboardPublicAPIRequestSuccessful",
"properties": {
"routeType": {
"description": "The type of route accessed in the Dashboard Public API.",
"enum": [
"collection",
"singleton"
],
"type": "string"
},
"httpMethod": {
"description": "The HTTP method used for the request.",
"enum": [
"GET",
"POST",
"PUT",
"DELETE"
],
"type": "string"
}
}
}
---
id: dash.DisableDashboardV2Changed
name: DisableDashboardV2Changed
version: 1.0.0
summary: "Event emitted when a tenant changes the feature preview to disable or enable Dashboard V2."
producers:
- dash
consumers: []
schemaPath: 'schema.json'
---
# DisableDashboardV2Changed
Event emitted when a tenant changes the feature preview to disable or enable Dashboard V2.
## Base Schema
All analytics events are based on the **TrackEvent** schema which provides common properties like `messageId`, `userId`, `context`, timestamps, and more.
**Base Schema Reference**: [analytics-track.yaml](https://event-catalog.prod.otc.fts.d-3.de/schemas/analytics-track.yaml)
## Event-Specific Properties
This schema shows only the event-specific properties that extend the base TrackEvent schema:
## Raw Schema:schema.json
{
"title": "Event-Specific Properties",
"type": "object",
"description": "Properties specific to this event type (extends BaseEvent)",
"extends": "../../../base/base-event.yaml#/BaseEvent",
"eventType": "DisableDashboardV2Changed",
"properties": {
"active": {
"description": "Indicates whether Dashboard V2 has been disabled (true) or enabled (false) by the tenant.",
"type": "boolean"
}
}
}
---
id: dash.EnableHomeAppChanged
name: EnableHomeAppChanged
version: 1.0.0
summary: "Event emitted when a tenant changes the feature preview to enable or disable the Home App."
producers:
- dash
consumers: []
schemaPath: 'schema.json'
---
# EnableHomeAppChanged
Event emitted when a tenant changes the feature preview to enable or disable the Home App.
## Base Schema
All analytics events are based on the **TrackEvent** schema which provides common properties like `messageId`, `userId`, `context`, timestamps, and more.
**Base Schema Reference**: [analytics-track.yaml](https://event-catalog.prod.otc.fts.d-3.de/schemas/analytics-track.yaml)
## Event-Specific Properties
This schema shows only the event-specific properties that extend the base TrackEvent schema:
## Raw Schema:schema.json
{
"title": "Event-Specific Properties",
"type": "object",
"description": "Properties specific to this event type (extends BaseEvent)",
"extends": "../../../base/base-event.yaml#/BaseEvent",
"eventType": "EnableHomeAppChanged",
"properties": {
"active": {
"description": "Indicates whether the Home App has been enabled (true) or disabled (false) by the tenant.",
"type": "boolean"
}
}
}
---
id: dash.FavoritesUpdated
name: FavoritesUpdated
version: 1.0.0
summary: "Event emitted when a user updates their favorites in the apps menu."
producers:
- dash
consumers: []
schemaPath: 'schema.json'
---
# FavoritesUpdated
Event emitted when a user updates their favorites in the apps menu.
## Base Schema
All analytics events are based on the **TrackEvent** schema which provides common properties like `messageId`, `userId`, `context`, timestamps, and more.
**Base Schema Reference**: [analytics-track.yaml](https://event-catalog.prod.otc.fts.d-3.de/schemas/analytics-track.yaml)
## Event-Specific Properties
This schema shows only the event-specific properties that extend the base TrackEvent schema:
## Raw Schema:schema.json
{
"title": "Event-Specific Properties",
"type": "object",
"description": "Properties specific to this event type (extends BaseEvent)",
"extends": "../../../base/base-event.yaml#/BaseEvent",
"eventType": "FavoritesUpdated",
"properties": {
"favorites": {
"description": "The list of favored apps.",
"items": {
"type": "string"
},
"type": "array"
},
"favoritesCount": {
"description": "The total number of favored apps.",
"type": "integer"
}
}
}
---
id: dash.LegacyWidgetsConverted
name: LegacyWidgetsConverted
version: 1.0.0
summary: "Event emitted when the widget converter has been executed."
producers:
- dash
consumers: []
schemaPath: 'schema.json'
---
# LegacyWidgetsConverted
Event emitted when the widget converter has been executed.
## Base Schema
All analytics events are based on the **TrackEvent** schema which provides common properties like `messageId`, `userId`, `context`, timestamps, and more.
**Base Schema Reference**: [analytics-track.yaml](https://event-catalog.prod.otc.fts.d-3.de/schemas/analytics-track.yaml)
## Event-Specific Properties
This schema shows only the event-specific properties that extend the base TrackEvent schema:
## Raw Schema:schema.json
{
"title": "Event-Specific Properties",
"type": "object",
"description": "Properties specific to this event type (extends BaseEvent)",
"extends": "../../../base/base-event.yaml#/BaseEvent",
"eventType": "LegacyWidgetsConverted",
"properties": {
"homeWidgetCount": {
"description": "The number of home widgets that were converted.",
"type": "integer"
},
"v1WidgetCount": {
"description": "The number of v1 dashboard widgets that were converted.",
"type": "integer"
},
"convertedWidgetCount": {
"description": "The total number of converted widgets after merging.",
"type": "integer"
}
}
}
---
id: dash.NavigatedViaAppsMenu
name: NavigatedViaAppsMenu
version: 1.0.0
summary: "Event emitted when a user navigates to an app via the apps menu."
producers:
- dash
consumers: []
schemaPath: 'schema.json'
---
# NavigatedViaAppsMenu
Event emitted when a user navigates to an app via the apps menu.
## Base Schema
All analytics events are based on the **TrackEvent** schema which provides common properties like `messageId`, `userId`, `context`, timestamps, and more.
**Base Schema Reference**: [analytics-track.yaml](https://event-catalog.prod.otc.fts.d-3.de/schemas/analytics-track.yaml)
## Event-Specific Properties
This schema shows only the event-specific properties that extend the base TrackEvent schema:
## Raw Schema:schema.json
{
"title": "Event-Specific Properties",
"type": "object",
"description": "Properties specific to this event type (extends BaseEvent)",
"extends": "../../../base/base-event.yaml#/BaseEvent",
"eventType": "NavigatedViaAppsMenu",
"properties": {
"widgetID": {
"description": "Unique identifier of the widget instance from which the navigation was initiated.",
"type": "string"
},
"isFavorite": {
"description": "Indicates whether the app navigated to is marked as a favorite by the user.",
"type": "boolean"
}
}
}
---
id: dash.NavigatedViaWidget
name: NavigatedViaWidget
version: 1.0.0
summary: "Event emitted when a user navigates to an app via a dashboard widget."
producers:
- dash
consumers: []
schemaPath: 'schema.json'
---
# NavigatedViaWidget
Event emitted when a user navigates to an app via a dashboard widget.
## Base Schema
All analytics events are based on the **TrackEvent** schema which provides common properties like `messageId`, `userId`, `context`, timestamps, and more.
**Base Schema Reference**: [analytics-track.yaml](https://event-catalog.prod.otc.fts.d-3.de/schemas/analytics-track.yaml)
## Event-Specific Properties
This schema shows only the event-specific properties that extend the base TrackEvent schema:
## Raw Schema:schema.json
{
"title": "Event-Specific Properties",
"type": "object",
"description": "Properties specific to this event type (extends BaseEvent)",
"extends": "../../../base/base-event.yaml#/BaseEvent",
"eventType": "NavigatedViaWidget",
"properties": {
"type": {
"description": "The type of the widget used for navigation.",
"enum": [
"shortcut",
"list",
"iframe"
],
"type": "string"
},
"widgetID": {
"description": "Unique identifier of the widget instance from which the navigation was initiated.",
"type": "string"
}
}
}
---
id: dash.ResetAllCustomDashboards
name: ResetAllCustomDashboards
version: 1.0.0
summary: "Event emitted when all custom user dashboards are reset."
producers:
- dash
consumers: []
schemaPath: 'schema.json'
---
# ResetAllCustomDashboards
Event emitted when all custom user dashboards are reset.
## Base Schema
All analytics events are based on the **TrackEvent** schema which provides common properties like `messageId`, `userId`, `context`, timestamps, and more.
**Base Schema Reference**: [analytics-track.yaml](https://event-catalog.prod.otc.fts.d-3.de/schemas/analytics-track.yaml)
## Event-Specific Properties
This schema shows only the event-specific properties that extend the base TrackEvent schema:
## Raw Schema:schema.json
{
"title": "Event-Specific Properties",
"type": "object",
"description": "Properties specific to this event type (extends BaseEvent)",
"extends": "../../../base/base-event.yaml#/BaseEvent",
"eventType": "ResetAllCustomDashboards",
"properties": {},
"note": "This event uses only BaseEvent properties with no additional event-specific properties"
}
---
id: dash.ResetUserDashboard
name: ResetUserDashboard
version: 1.0.0
summary: "Event emitted when a user resets their dashboard to the default dashboard."
producers:
- dash
consumers: []
schemaPath: 'schema.json'
---
# ResetUserDashboard
Event emitted when a user resets their dashboard to the default dashboard.
## Base Schema
All analytics events are based on the **TrackEvent** schema which provides common properties like `messageId`, `userId`, `context`, timestamps, and more.
**Base Schema Reference**: [analytics-track.yaml](https://event-catalog.prod.otc.fts.d-3.de/schemas/analytics-track.yaml)
## Event-Specific Properties
This schema shows only the event-specific properties that extend the base TrackEvent schema:
## Raw Schema:schema.json
{
"title": "Event-Specific Properties",
"type": "object",
"description": "Properties specific to this event type (extends BaseEvent)",
"extends": "../../../base/base-event.yaml#/BaseEvent",
"eventType": "ResetUserDashboard",
"properties": {},
"note": "This event uses only BaseEvent properties with no additional event-specific properties"
}
---
id: dash.TenantDashboardCreated
name: TenantDashboardCreated
version: 1.0.0
summary: "Event emitted when a tenant dashboard is created."
producers:
- dash
consumers: []
schemaPath: 'schema.json'
---
# TenantDashboardCreated
Event emitted when a tenant dashboard is created.
## Base Schema
All analytics events are based on the **TrackEvent** schema which provides common properties like `messageId`, `userId`, `context`, timestamps, and more.
**Base Schema Reference**: [analytics-track.yaml](https://event-catalog.prod.otc.fts.d-3.de/schemas/analytics-track.yaml)
## Event-Specific Properties
This schema shows only the event-specific properties that extend the base TrackEvent schema:
## Raw Schema:schema.json
{
"title": "Event-Specific Properties",
"type": "object",
"description": "Properties specific to this event type (extends BaseEvent)",
"extends": "../../../base/base-event.yaml#/BaseEvent",
"eventType": "TenantDashboardCreated",
"properties": {
"agent": {
"description": "The agent that created the tenant dashboard.",
"enum": [
"service",
"user"
],
"type": "string"
}
}
}
---
id: dash.TenantDashboardDeleted
name: TenantDashboardDeleted
version: 1.0.0
summary: "Event emitted when a tenant dashboard is deleted."
producers:
- dash
consumers: []
schemaPath: 'schema.json'
---
# TenantDashboardDeleted
Event emitted when a tenant dashboard is deleted.
## Base Schema
All analytics events are based on the **TrackEvent** schema which provides common properties like `messageId`, `userId`, `context`, timestamps, and more.
**Base Schema Reference**: [analytics-track.yaml](https://event-catalog.prod.otc.fts.d-3.de/schemas/analytics-track.yaml)
## Event-Specific Properties
This schema shows only the event-specific properties that extend the base TrackEvent schema:
## Raw Schema:schema.json
{
"title": "Event-Specific Properties",
"type": "object",
"description": "Properties specific to this event type (extends BaseEvent)",
"extends": "../../../base/base-event.yaml#/BaseEvent",
"eventType": "TenantDashboardDeleted",
"properties": {
"agent": {
"description": "The agent that deleted the tenant dashboard.",
"enum": [
"service",
"user"
],
"type": "string"
}
}
}
---
id: dash.WidgetAdded
name: WidgetAdded
version: 1.0.0
summary: "Event emitted when a user adds a widget to the v1 dashboard."
producers:
- dash
consumers: []
schemaPath: 'schema.json'
---
# WidgetAdded
Event emitted when a user adds a widget to the v1 dashboard.
## Base Schema
All analytics events are based on the **TrackEvent** schema which provides common properties like `messageId`, `userId`, `context`, timestamps, and more.
**Base Schema Reference**: [analytics-track.yaml](https://event-catalog.prod.otc.fts.d-3.de/schemas/analytics-track.yaml)
## Event-Specific Properties
This schema shows only the event-specific properties that extend the base TrackEvent schema:
## Raw Schema:schema.json
{
"title": "Event-Specific Properties",
"type": "object",
"description": "Properties specific to this event type (extends BaseEvent)",
"extends": "../../../base/base-event.yaml#/BaseEvent",
"eventType": "WidgetAdded",
"properties": {
"widgetID": {
"description": "Unique identifier of the added widget instance.",
"type": "string"
},
"registrationID": {
"description": "Registration ID of the added widget.",
"type": "string"
},
"widgetType": {
"description": "Type of the added widget.",
"enum": [
"shortcut",
"list",
"iframe"
],
"type": "string"
}
}
}
---
id: dash.WidgetAPIV2Used
name: WidgetAPIV2Used
version: 1.0.0
summary: "Event emitted when the Widget API V2 is used."
producers:
- dash
consumers: []
schemaPath: 'schema.json'
---
# WidgetAPIV2Used
Event emitted when the Widget API V2 is used.
## Base Schema
All analytics events are based on the **TrackEvent** schema which provides common properties like `messageId`, `userId`, `context`, timestamps, and more.
**Base Schema Reference**: [analytics-track.yaml](https://event-catalog.prod.otc.fts.d-3.de/schemas/analytics-track.yaml)
## Event-Specific Properties
This schema shows only the event-specific properties that extend the base TrackEvent schema:
## Raw Schema:schema.json
{
"title": "Event-Specific Properties",
"type": "object",
"description": "Properties specific to this event type (extends BaseEvent)",
"extends": "../../../base/base-event.yaml#/BaseEvent",
"eventType": "WidgetAPIV2Used",
"properties": {
"id": {
"description": "Unique identifier of the widget. If the collection route is used, this is just the app name.",
"examples": [
"app1/my-widget",
"app1"
],
"type": "string"
},
"method": {
"description": "The method of the Widget API V2 that was used.",
"enum": [
"GetAllWidgetsForApp",
"GetWidgetByID",
"UpsertWidget",
"DeleteWidget"
],
"type": "string"
}
}
}
---
id: dash.WidgetDeregistered
name: WidgetDeregistered
version: 1.0.0
summary: "Event emitted when a v1 widget is deregistered."
producers:
- dash
consumers: []
schemaPath: 'schema.json'
---
# WidgetDeregistered
Event emitted when a v1 widget is deregistered.
## Base Schema
All analytics events are based on the **TrackEvent** schema which provides common properties like `messageId`, `userId`, `context`, timestamps, and more.
**Base Schema Reference**: [analytics-track.yaml](https://event-catalog.prod.otc.fts.d-3.de/schemas/analytics-track.yaml)
## Event-Specific Properties
This schema shows only the event-specific properties that extend the base TrackEvent schema:
## Raw Schema:schema.json
{
"title": "Event-Specific Properties",
"type": "object",
"description": "Properties specific to this event type (extends BaseEvent)",
"extends": "../../../base/base-event.yaml#/BaseEvent",
"eventType": "WidgetDeregistered",
"properties": {
"widgetId": {
"description": "Unique identifier of the deregistered widget.",
"type": "string"
}
}
}
---
id: dash.WidgetRegistered
name: WidgetRegistered
version: 1.0.0
summary: "Event emitted when a new v1 widget is registered."
producers:
- dash
consumers: []
schemaPath: 'schema.json'
---
# WidgetRegistered
Event emitted when a new v1 widget is registered.
## Base Schema
All analytics events are based on the **TrackEvent** schema which provides common properties like `messageId`, `userId`, `context`, timestamps, and more.
**Base Schema Reference**: [analytics-track.yaml](https://event-catalog.prod.otc.fts.d-3.de/schemas/analytics-track.yaml)
## Event-Specific Properties
This schema shows only the event-specific properties that extend the base TrackEvent schema:
## Raw Schema:schema.json
{
"title": "Event-Specific Properties",
"type": "object",
"description": "Properties specific to this event type (extends BaseEvent)",
"extends": "../../../base/base-event.yaml#/BaseEvent",
"eventType": "WidgetRegistered",
"properties": {
"widgetType": {
"description": "Type of the newly registered widget.",
"enum": [
"shortcut",
"list",
"iframe"
],
"type": "string"
},
"widgetId": {
"description": "Unique identifier of the newly registered widget.",
"type": "string"
}
}
}
---
id: dash.WidgetRemoved
name: WidgetRemoved
version: 1.0.0
summary: "Event emitted when a user removes a widget from the v1 dashboard."
producers:
- dash
consumers: []
schemaPath: 'schema.json'
---
# WidgetRemoved
Event emitted when a user removes a widget from the v1 dashboard.
## Base Schema
All analytics events are based on the **TrackEvent** schema which provides common properties like `messageId`, `userId`, `context`, timestamps, and more.
**Base Schema Reference**: [analytics-track.yaml](https://event-catalog.prod.otc.fts.d-3.de/schemas/analytics-track.yaml)
## Event-Specific Properties
This schema shows only the event-specific properties that extend the base TrackEvent schema:
## Raw Schema:schema.json
{
"title": "Event-Specific Properties",
"type": "object",
"description": "Properties specific to this event type (extends BaseEvent)",
"extends": "../../../base/base-event.yaml#/BaseEvent",
"eventType": "WidgetRemoved",
"properties": {
"widgetID": {
"description": "Unique identifier of the removed widget instance.",
"type": "string"
}
}
}
---
id: dash.WidgetSettingsUpdated
name: WidgetSettingsUpdated
version: 1.0.0
summary: "Event emitted when a user updates the settings of a widget in the v1 dashboard."
producers:
- dash
consumers: []
schemaPath: 'schema.json'
---
# WidgetSettingsUpdated
Event emitted when a user updates the settings of a widget in the v1 dashboard.
## Base Schema
All analytics events are based on the **TrackEvent** schema which provides common properties like `messageId`, `userId`, `context`, timestamps, and more.
**Base Schema Reference**: [analytics-track.yaml](https://event-catalog.prod.otc.fts.d-3.de/schemas/analytics-track.yaml)
## Event-Specific Properties
This schema shows only the event-specific properties that extend the base TrackEvent schema:
## Raw Schema:schema.json
{
"title": "Event-Specific Properties",
"type": "object",
"description": "Properties specific to this event type (extends BaseEvent)",
"extends": "../../../base/base-event.yaml#/BaseEvent",
"eventType": "WidgetSettingsUpdated",
"properties": {
"widgetID": {
"description": "Unique identifier of the widget instance whose settings were updated.",
"type": "string"
}
}
}
---
id: dash.WidgetV2ReplacedOnDashboards
name: WidgetV2ReplacedOnDashboards
version: 1.0.0
summary: "Event emitted when a v1 widget is replaced by a v2 widget on dashboards."
producers:
- dash
consumers: []
schemaPath: 'schema.json'
---
# WidgetV2ReplacedOnDashboards
Event emitted when a v1 widget is replaced by a v2 widget on dashboards.
## Base Schema
All analytics events are based on the **TrackEvent** schema which provides common properties like `messageId`, `userId`, `context`, timestamps, and more.
**Base Schema Reference**: [analytics-track.yaml](https://event-catalog.prod.otc.fts.d-3.de/schemas/analytics-track.yaml)
## Event-Specific Properties
This schema shows only the event-specific properties that extend the base TrackEvent schema:
## Raw Schema:schema.json
{
"title": "Event-Specific Properties",
"type": "object",
"description": "Properties specific to this event type (extends BaseEvent)",
"extends": "../../../base/base-event.yaml#/BaseEvent",
"eventType": "WidgetV2ReplacedOnDashboards",
"properties": {
"deletedWidget": {
"description": "Unique identifier of the v1 widget that was deleted.",
"type": "string"
},
"replacementWidget": {
"description": "Unique identifier of the v2 widget that replaced the v1 widget.",
"type": "string"
}
}
}
---
id: dms-app.AlterationTextCancelClicked
name: AlterationTextCancelClicked
version: 1.0.0
summary: "When a user dismisses the alteration text dialog by clicking Cancel or closing the dialog"
producers:
- dms-app
consumers: []
schemaPath: 'schema.json'
---
# AlterationTextCancelClicked
When a user dismisses the alteration text dialog by clicking Cancel or closing the dialog
## Base Schema
All analytics events are based on the **TrackEvent** schema which provides common properties like `messageId`, `userId`, `context`, timestamps, and more.
**Base Schema Reference**: [analytics-track.yaml](https://event-catalog.prod.otc.fts.d-3.de/schemas/analytics-track.yaml)
## Event-Specific Properties
This schema shows only the event-specific properties that extend the base TrackEvent schema:
## Raw Schema:schema.json
{
"title": "Event-Specific Properties",
"type": "object",
"description": "Properties specific to this event type (extends BaseEvent)",
"extends": "https://event-catalog.prod.otc.fts.d-3.de/schemas/analytics-track.yaml#/TrackEvent",
"eventType": "AlterationTextCancelClicked",
"properties": {
"fileCount": {
"description": "Number of files selected by the user",
"type": "integer"
}
},
"components": {
"schemas": {
"BlobSource": {
"description": "The blob content type that was targeted for download",
"enum": [
"blob",
"mainBlobContent",
"dependentBlobContent"
],
"type": "string"
},
"ContextActionOrigin": {
"description": "The UI area from which a context action was triggered. Emitted by the context action service; falls back to \"unknown\" when the caller provides no origin.",
"enum": [
"Details",
"DetailsPerspectives",
"FolderNavigator",
"SearchResult",
"SearchResultGrid",
"SearchResultList",
"unknown"
],
"type": "string"
},
"DocexOrigin": {
"description": "The UI area from which a Docex-specific action was triggered",
"enum": [
"DetailsPerspectivesDocex",
"NewVersionDocex"
],
"type": "string"
},
"DocumentState": {
"description": "The release state of a document",
"enum": [
"PROCESSING",
"RELEASE"
],
"type": "string"
},
"PreviewOrigin": {
"description": "The UI area from which a preview-related action was triggered",
"enum": [
"Details",
"DetailsPreview"
],
"type": "string"
}
}
}
}
---
id: dms-app.AlterationTextOkClicked
name: AlterationTextOkClicked
version: 1.0.0
summary: "When a user confirms the alteration text dialog by clicking OK"
producers:
- dms-app
consumers: []
schemaPath: 'schema.json'
---
# AlterationTextOkClicked
When a user confirms the alteration text dialog by clicking OK
## Base Schema
All analytics events are based on the **TrackEvent** schema which provides common properties like `messageId`, `userId`, `context`, timestamps, and more.
**Base Schema Reference**: [analytics-track.yaml](https://event-catalog.prod.otc.fts.d-3.de/schemas/analytics-track.yaml)
## Event-Specific Properties
This schema shows only the event-specific properties that extend the base TrackEvent schema:
## Raw Schema:schema.json
{
"title": "Event-Specific Properties",
"type": "object",
"description": "Properties specific to this event type (extends BaseEvent)",
"extends": "https://event-catalog.prod.otc.fts.d-3.de/schemas/analytics-track.yaml#/TrackEvent",
"eventType": "AlterationTextOkClicked",
"properties": {},
"note": "This event uses only BaseEvent properties with no additional event-specific properties",
"components": {
"schemas": {
"BlobSource": {
"description": "The blob content type that was targeted for download",
"enum": [
"blob",
"mainBlobContent",
"dependentBlobContent"
],
"type": "string"
},
"ContextActionOrigin": {
"description": "The UI area from which a context action was triggered. Emitted by the context action service; falls back to \"unknown\" when the caller provides no origin.",
"enum": [
"Details",
"DetailsPerspectives",
"FolderNavigator",
"SearchResult",
"SearchResultGrid",
"SearchResultList",
"unknown"
],
"type": "string"
},
"DocexOrigin": {
"description": "The UI area from which a Docex-specific action was triggered",
"enum": [
"DetailsPerspectivesDocex",
"NewVersionDocex"
],
"type": "string"
},
"DocumentState": {
"description": "The release state of a document",
"enum": [
"PROCESSING",
"RELEASE"
],
"type": "string"
},
"PreviewOrigin": {
"description": "The UI area from which a preview-related action was triggered",
"enum": [
"Details",
"DetailsPreview"
],
"type": "string"
}
}
}
}
---
id: dms-app.BrowserPreviewUsed
name: BrowserPreviewUsed
version: 1.0.0
summary: "When a user enables or disables the in-browser document preview"
producers:
- dms-app
consumers: []
schemaPath: 'schema.json'
---
# BrowserPreviewUsed
When a user enables or disables the in-browser document preview
## Base Schema
All analytics events are based on the **TrackEvent** schema which provides common properties like `messageId`, `userId`, `context`, timestamps, and more.
**Base Schema Reference**: [analytics-track.yaml](https://event-catalog.prod.otc.fts.d-3.de/schemas/analytics-track.yaml)
## Event-Specific Properties
This schema shows only the event-specific properties that extend the base TrackEvent schema:
## Raw Schema:schema.json
{
"title": "Event-Specific Properties",
"type": "object",
"description": "Properties specific to this event type (extends BaseEvent)",
"extends": "https://event-catalog.prod.otc.fts.d-3.de/schemas/analytics-track.yaml#/TrackEvent",
"eventType": "BrowserPreviewUsed",
"properties": {
"origin": {
"$ref": "#/components/schemas/PreviewOrigin"
},
"activate": {
"description": "True when the browser preview is being activated, false when deactivated",
"type": "boolean"
}
},
"components": {
"schemas": {
"BlobSource": {
"description": "The blob content type that was targeted for download",
"enum": [
"blob",
"mainBlobContent",
"dependentBlobContent"
],
"type": "string"
},
"ContextActionOrigin": {
"description": "The UI area from which a context action was triggered. Emitted by the context action service; falls back to \"unknown\" when the caller provides no origin.",
"enum": [
"Details",
"DetailsPerspectives",
"FolderNavigator",
"SearchResult",
"SearchResultGrid",
"SearchResultList",
"unknown"
],
"type": "string"
},
"DocexOrigin": {
"description": "The UI area from which a Docex-specific action was triggered",
"enum": [
"DetailsPerspectivesDocex",
"NewVersionDocex"
],
"type": "string"
},
"DocumentState": {
"description": "The release state of a document",
"enum": [
"PROCESSING",
"RELEASE"
],
"type": "string"
},
"PreviewOrigin": {
"description": "The UI area from which a preview-related action was triggered",
"enum": [
"Details",
"DetailsPreview"
],
"type": "string"
}
}
}
}
---
id: dms-app.CopyLinkToClipboard
name: CopyLinkToClipboard
version: 1.0.0
summary: "When a user copies a link to a DMS object to the clipboard"
producers:
- dms-app
consumers: []
schemaPath: 'schema.json'
---
# CopyLinkToClipboard
When a user copies a link to a DMS object to the clipboard
## Base Schema
All analytics events are based on the **TrackEvent** schema which provides common properties like `messageId`, `userId`, `context`, timestamps, and more.
**Base Schema Reference**: [analytics-track.yaml](https://event-catalog.prod.otc.fts.d-3.de/schemas/analytics-track.yaml)
## Event-Specific Properties
This schema shows only the event-specific properties that extend the base TrackEvent schema:
## Raw Schema:schema.json
{
"title": "Event-Specific Properties",
"type": "object",
"description": "Properties specific to this event type (extends BaseEvent)",
"extends": "https://event-catalog.prod.otc.fts.d-3.de/schemas/analytics-track.yaml#/TrackEvent",
"eventType": "CopyLinkToClipboard",
"properties": {
"origin": {
"$ref": "#/components/schemas/ContextActionOrigin"
}
},
"components": {
"schemas": {
"BlobSource": {
"description": "The blob content type that was targeted for download",
"enum": [
"blob",
"mainBlobContent",
"dependentBlobContent"
],
"type": "string"
},
"ContextActionOrigin": {
"description": "The UI area from which a context action was triggered. Emitted by the context action service; falls back to \"unknown\" when the caller provides no origin.",
"enum": [
"Details",
"DetailsPerspectives",
"FolderNavigator",
"SearchResult",
"SearchResultGrid",
"SearchResultList",
"unknown"
],
"type": "string"
},
"DocexOrigin": {
"description": "The UI area from which a Docex-specific action was triggered",
"enum": [
"DetailsPerspectivesDocex",
"NewVersionDocex"
],
"type": "string"
},
"DocumentState": {
"description": "The release state of a document",
"enum": [
"PROCESSING",
"RELEASE"
],
"type": "string"
},
"PreviewOrigin": {
"description": "The UI area from which a preview-related action was triggered",
"enum": [
"Details",
"DetailsPreview"
],
"type": "string"
}
}
}
}
---
id: dms-app.DeleteClicked
name: DeleteClicked
version: 1.0.0
summary: "When a user clicks the delete action for a DMS object"
producers:
- dms-app
consumers: []
schemaPath: 'schema.json'
---
# DeleteClicked
When a user clicks the delete action for a DMS object
## Base Schema
All analytics events are based on the **TrackEvent** schema which provides common properties like `messageId`, `userId`, `context`, timestamps, and more.
**Base Schema Reference**: [analytics-track.yaml](https://event-catalog.prod.otc.fts.d-3.de/schemas/analytics-track.yaml)
## Event-Specific Properties
This schema shows only the event-specific properties that extend the base TrackEvent schema:
## Raw Schema:schema.json
{
"title": "Event-Specific Properties",
"type": "object",
"description": "Properties specific to this event type (extends BaseEvent)",
"extends": "https://event-catalog.prod.otc.fts.d-3.de/schemas/analytics-track.yaml#/TrackEvent",
"eventType": "DeleteClicked",
"properties": {
"origin": {
"$ref": "#/components/schemas/ContextActionOrigin"
},
"withReason": {
"description": "Whether the deletion dialog required the user to provide a reason",
"type": "boolean"
},
"state": {
"description": "The current release state of the document at the time of deletion",
"type": "string"
}
},
"components": {
"schemas": {
"BlobSource": {
"description": "The blob content type that was targeted for download",
"enum": [
"blob",
"mainBlobContent",
"dependentBlobContent"
],
"type": "string"
},
"ContextActionOrigin": {
"description": "The UI area from which a context action was triggered. Emitted by the context action service; falls back to \"unknown\" when the caller provides no origin.",
"enum": [
"Details",
"DetailsPerspectives",
"FolderNavigator",
"SearchResult",
"SearchResultGrid",
"SearchResultList",
"unknown"
],
"type": "string"
},
"DocexOrigin": {
"description": "The UI area from which a Docex-specific action was triggered",
"enum": [
"DetailsPerspectivesDocex",
"NewVersionDocex"
],
"type": "string"
},
"DocumentState": {
"description": "The release state of a document",
"enum": [
"PROCESSING",
"RELEASE"
],
"type": "string"
},
"PreviewOrigin": {
"description": "The UI area from which a preview-related action was triggered",
"enum": [
"Details",
"DetailsPreview"
],
"type": "string"
}
}
}
}
---
id: dms-app.DeleteDmsObjectLinkClicked
name: DeleteDmsObjectLinkClicked
version: 1.0.0
summary: "When a user clicks the delete action for a DMS object link in the perspectives panel"
producers:
- dms-app
consumers: []
schemaPath: 'schema.json'
---
# DeleteDmsObjectLinkClicked
When a user clicks the delete action for a DMS object link in the perspectives panel
## Base Schema
All analytics events are based on the **TrackEvent** schema which provides common properties like `messageId`, `userId`, `context`, timestamps, and more.
**Base Schema Reference**: [analytics-track.yaml](https://event-catalog.prod.otc.fts.d-3.de/schemas/analytics-track.yaml)
## Event-Specific Properties
This schema shows only the event-specific properties that extend the base TrackEvent schema:
## Raw Schema:schema.json
{
"title": "Event-Specific Properties",
"type": "object",
"description": "Properties specific to this event type (extends BaseEvent)",
"extends": "https://event-catalog.prod.otc.fts.d-3.de/schemas/analytics-track.yaml#/TrackEvent",
"eventType": "DeleteDmsObjectLinkClicked",
"properties": {
"origin": {
"const": "DetailsPerspectives",
"type": "string"
}
},
"components": {
"schemas": {
"BlobSource": {
"description": "The blob content type that was targeted for download",
"enum": [
"blob",
"mainBlobContent",
"dependentBlobContent"
],
"type": "string"
},
"ContextActionOrigin": {
"description": "The UI area from which a context action was triggered. Emitted by the context action service; falls back to \"unknown\" when the caller provides no origin.",
"enum": [
"Details",
"DetailsPerspectives",
"FolderNavigator",
"SearchResult",
"SearchResultGrid",
"SearchResultList",
"unknown"
],
"type": "string"
},
"DocexOrigin": {
"description": "The UI area from which a Docex-specific action was triggered",
"enum": [
"DetailsPerspectivesDocex",
"NewVersionDocex"
],
"type": "string"
},
"DocumentState": {
"description": "The release state of a document",
"enum": [
"PROCESSING",
"RELEASE"
],
"type": "string"
},
"PreviewOrigin": {
"description": "The UI area from which a preview-related action was triggered",
"enum": [
"Details",
"DetailsPreview"
],
"type": "string"
}
}
}
}
---
id: dms-app.DocexDocumentDownloaded
name: DocexDocumentDownloaded
version: 1.0.0
summary: "When a document blob export is completed and the file is downloaded in the Docex V1 UI"
producers:
- dms-app
consumers: []
schemaPath: 'schema.json'
---
# DocexDocumentDownloaded
When a document blob export is completed and the file is downloaded in the Docex V1 UI
## Base Schema
All analytics events are based on the **TrackEvent** schema which provides common properties like `messageId`, `userId`, `context`, timestamps, and more.
**Base Schema Reference**: [analytics-track.yaml](https://event-catalog.prod.otc.fts.d-3.de/schemas/analytics-track.yaml)
## Event-Specific Properties
This schema shows only the event-specific properties that extend the base TrackEvent schema:
## Raw Schema:schema.json
{
"title": "Event-Specific Properties",
"type": "object",
"description": "Properties specific to this event type (extends BaseEvent)",
"extends": "https://event-catalog.prod.otc.fts.d-3.de/schemas/analytics-track.yaml#/TrackEvent",
"eventType": "DocexDocumentDownloaded",
"properties": {
"optionCount": {
"description": "The number of export format options presented to the user",
"type": "integer"
},
"displayName": {
"description": "The display name of the downloaded blob",
"type": "string"
},
"secondaryText": {
"description": "The secondary descriptive text shown alongside the blob",
"type": "string"
}
},
"components": {
"schemas": {
"BlobSource": {
"description": "The blob content type that was targeted for download",
"enum": [
"blob",
"mainBlobContent",
"dependentBlobContent"
],
"type": "string"
},
"ContextActionOrigin": {
"description": "The UI area from which a context action was triggered. Emitted by the context action service; falls back to \"unknown\" when the caller provides no origin.",
"enum": [
"Details",
"DetailsPerspectives",
"FolderNavigator",
"SearchResult",
"SearchResultGrid",
"SearchResultList",
"unknown"
],
"type": "string"
},
"DocexOrigin": {
"description": "The UI area from which a Docex-specific action was triggered",
"enum": [
"DetailsPerspectivesDocex",
"NewVersionDocex"
],
"type": "string"
},
"DocumentState": {
"description": "The release state of a document",
"enum": [
"PROCESSING",
"RELEASE"
],
"type": "string"
},
"PreviewOrigin": {
"description": "The UI area from which a preview-related action was triggered",
"enum": [
"Details",
"DetailsPreview"
],
"type": "string"
}
}
}
}
---
id: dms-app.DocexEditPropertiesClicked
name: DocexEditPropertiesClicked
version: 1.0.0
summary: "When a user clicks the action to edit a DMS object's properties in the Docex perspectives panel"
producers:
- dms-app
consumers: []
schemaPath: 'schema.json'
---
# DocexEditPropertiesClicked
When a user clicks the action to edit a DMS object's properties in the Docex perspectives panel
## Base Schema
All analytics events are based on the **TrackEvent** schema which provides common properties like `messageId`, `userId`, `context`, timestamps, and more.
**Base Schema Reference**: [analytics-track.yaml](https://event-catalog.prod.otc.fts.d-3.de/schemas/analytics-track.yaml)
## Event-Specific Properties
This schema shows only the event-specific properties that extend the base TrackEvent schema:
## Raw Schema:schema.json
{
"title": "Event-Specific Properties",
"type": "object",
"description": "Properties specific to this event type (extends BaseEvent)",
"extends": "https://event-catalog.prod.otc.fts.d-3.de/schemas/analytics-track.yaml#/TrackEvent",
"eventType": "DocexEditPropertiesClicked",
"properties": {
"origin": {
"const": "DetailsPerspectivesDocex",
"type": "string"
}
},
"components": {
"schemas": {
"BlobSource": {
"description": "The blob content type that was targeted for download",
"enum": [
"blob",
"mainBlobContent",
"dependentBlobContent"
],
"type": "string"
},
"ContextActionOrigin": {
"description": "The UI area from which a context action was triggered. Emitted by the context action service; falls back to \"unknown\" when the caller provides no origin.",
"enum": [
"Details",
"DetailsPerspectives",
"FolderNavigator",
"SearchResult",
"SearchResultGrid",
"SearchResultList",
"unknown"
],
"type": "string"
},
"DocexOrigin": {
"description": "The UI area from which a Docex-specific action was triggered",
"enum": [
"DetailsPerspectivesDocex",
"NewVersionDocex"
],
"type": "string"
},
"DocumentState": {
"description": "The release state of a document",
"enum": [
"PROCESSING",
"RELEASE"
],
"type": "string"
},
"PreviewOrigin": {
"description": "The UI area from which a preview-related action was triggered",
"enum": [
"Details",
"DetailsPreview"
],
"type": "string"
}
}
}
}
---
id: dms-app.DocexNewVersionDialogSaveClicked
name: DocexNewVersionDialogSaveClicked
version: 1.0.0
summary: "When the Docex V1 upload dialog triggers a save on the new-version form"
producers:
- dms-app
consumers: []
schemaPath: 'schema.json'
---
# DocexNewVersionDialogSaveClicked
When the Docex V1 upload dialog triggers a save on the new-version form
## Base Schema
All analytics events are based on the **TrackEvent** schema which provides common properties like `messageId`, `userId`, `context`, timestamps, and more.
**Base Schema Reference**: [analytics-track.yaml](https://event-catalog.prod.otc.fts.d-3.de/schemas/analytics-track.yaml)
## Event-Specific Properties
This schema shows only the event-specific properties that extend the base TrackEvent schema:
## Raw Schema:schema.json
{
"title": "Event-Specific Properties",
"type": "object",
"description": "Properties specific to this event type (extends BaseEvent)",
"extends": "https://event-catalog.prod.otc.fts.d-3.de/schemas/analytics-track.yaml#/TrackEvent",
"eventType": "DocexNewVersionDialogSaveClicked",
"properties": {
"propertiesUpdated": {
"description": "True when the user edited at least one property of the document during the Docex V1 new-version dialog session. False when the user only replaced the file (blob) and left all properties unchanged. Programmatic mutations during initialization and validation are excluded.",
"type": "boolean"
}
},
"components": {
"schemas": {
"BlobSource": {
"description": "The blob content type that was targeted for download",
"enum": [
"blob",
"mainBlobContent",
"dependentBlobContent"
],
"type": "string"
},
"ContextActionOrigin": {
"description": "The UI area from which a context action was triggered. Emitted by the context action service; falls back to \"unknown\" when the caller provides no origin.",
"enum": [
"Details",
"DetailsPerspectives",
"FolderNavigator",
"SearchResult",
"SearchResultGrid",
"SearchResultList",
"unknown"
],
"type": "string"
},
"DocexOrigin": {
"description": "The UI area from which a Docex-specific action was triggered",
"enum": [
"DetailsPerspectivesDocex",
"NewVersionDocex"
],
"type": "string"
},
"DocumentState": {
"description": "The release state of a document",
"enum": [
"PROCESSING",
"RELEASE"
],
"type": "string"
},
"PreviewOrigin": {
"description": "The UI area from which a preview-related action was triggered",
"enum": [
"Details",
"DetailsPreview"
],
"type": "string"
}
}
}
}
---
id: dms-app.DocexPropertiesFormCategorySelected
name: DocexPropertiesFormCategorySelected
version: 1.0.0
summary: "When a user selects a category in the Docex properties form"
producers:
- dms-app
consumers: []
schemaPath: 'schema.json'
---
# DocexPropertiesFormCategorySelected
When a user selects a category in the Docex properties form
## Base Schema
All analytics events are based on the **TrackEvent** schema which provides common properties like `messageId`, `userId`, `context`, timestamps, and more.
**Base Schema Reference**: [analytics-track.yaml](https://event-catalog.prod.otc.fts.d-3.de/schemas/analytics-track.yaml)
## Event-Specific Properties
This schema shows only the event-specific properties that extend the base TrackEvent schema:
## Raw Schema:schema.json
{
"title": "Event-Specific Properties",
"type": "object",
"description": "Properties specific to this event type (extends BaseEvent)",
"extends": "https://event-catalog.prod.otc.fts.d-3.de/schemas/analytics-track.yaml#/TrackEvent",
"eventType": "DocexPropertiesFormCategorySelected",
"properties": {
"kind": {
"description": "The kind of the selected object definition (FOLDER corresponds to a dossier)",
"enum": [
"DOCUMENT",
"FOLDER",
"TEMPLATE"
],
"type": "string"
},
"formContext": {
"description": "Whether the form was opened for updating an existing object or importing a new one",
"enum": [
"update",
"import"
],
"type": "string"
},
"origin": {
"$ref": "#/components/schemas/DocexOrigin"
}
},
"components": {
"schemas": {
"BlobSource": {
"description": "The blob content type that was targeted for download",
"enum": [
"blob",
"mainBlobContent",
"dependentBlobContent"
],
"type": "string"
},
"ContextActionOrigin": {
"description": "The UI area from which a context action was triggered. Emitted by the context action service; falls back to \"unknown\" when the caller provides no origin.",
"enum": [
"Details",
"DetailsPerspectives",
"FolderNavigator",
"SearchResult",
"SearchResultGrid",
"SearchResultList",
"unknown"
],
"type": "string"
},
"DocexOrigin": {
"description": "The UI area from which a Docex-specific action was triggered",
"enum": [
"DetailsPerspectivesDocex",
"NewVersionDocex"
],
"type": "string"
},
"DocumentState": {
"description": "The release state of a document",
"enum": [
"PROCESSING",
"RELEASE"
],
"type": "string"
},
"PreviewOrigin": {
"description": "The UI area from which a preview-related action was triggered",
"enum": [
"Details",
"DetailsPreview"
],
"type": "string"
}
}
}
}
---
id: dms-app.DocexPropertiesFormTabClicked
name: DocexPropertiesFormTabClicked
version: 1.0.0
summary: "When a user switches between property tabs in the Docex properties form"
producers:
- dms-app
consumers: []
schemaPath: 'schema.json'
---
# DocexPropertiesFormTabClicked
When a user switches between property tabs in the Docex properties form
## Base Schema
All analytics events are based on the **TrackEvent** schema which provides common properties like `messageId`, `userId`, `context`, timestamps, and more.
**Base Schema Reference**: [analytics-track.yaml](https://event-catalog.prod.otc.fts.d-3.de/schemas/analytics-track.yaml)
## Event-Specific Properties
This schema shows only the event-specific properties that extend the base TrackEvent schema:
## Raw Schema:schema.json
{
"title": "Event-Specific Properties",
"type": "object",
"description": "Properties specific to this event type (extends BaseEvent)",
"extends": "https://event-catalog.prod.otc.fts.d-3.de/schemas/analytics-track.yaml#/TrackEvent",
"eventType": "DocexPropertiesFormTabClicked",
"properties": {
"tab": {
"description": "The tab the user switched to",
"enum": [
"extended",
"multivalue",
"system"
],
"type": "string"
},
"formContext": {
"description": "Whether the form was opened for updating an existing object or importing a new one",
"enum": [
"update",
"import"
],
"type": "string"
},
"origin": {
"$ref": "#/components/schemas/DocexOrigin"
}
},
"components": {
"schemas": {
"BlobSource": {
"description": "The blob content type that was targeted for download",
"enum": [
"blob",
"mainBlobContent",
"dependentBlobContent"
],
"type": "string"
},
"ContextActionOrigin": {
"description": "The UI area from which a context action was triggered. Emitted by the context action service; falls back to \"unknown\" when the caller provides no origin.",
"enum": [
"Details",
"DetailsPerspectives",
"FolderNavigator",
"SearchResult",
"SearchResultGrid",
"SearchResultList",
"unknown"
],
"type": "string"
},
"DocexOrigin": {
"description": "The UI area from which a Docex-specific action was triggered",
"enum": [
"DetailsPerspectivesDocex",
"NewVersionDocex"
],
"type": "string"
},
"DocumentState": {
"description": "The release state of a document",
"enum": [
"PROCESSING",
"RELEASE"
],
"type": "string"
},
"PreviewOrigin": {
"description": "The UI area from which a preview-related action was triggered",
"enum": [
"Details",
"DetailsPreview"
],
"type": "string"
}
}
}
}
---
id: dms-app.DocexRegisterChanged
name: DocexRegisterChanged
version: 1.0.0
summary: "When a user switches to a different perspective tab in the Docex details view"
producers:
- dms-app
consumers: []
schemaPath: 'schema.json'
---
# DocexRegisterChanged
When a user switches to a different perspective tab in the Docex details view
## Base Schema
All analytics events are based on the **TrackEvent** schema which provides common properties like `messageId`, `userId`, `context`, timestamps, and more.
**Base Schema Reference**: [analytics-track.yaml](https://event-catalog.prod.otc.fts.d-3.de/schemas/analytics-track.yaml)
## Event-Specific Properties
This schema shows only the event-specific properties that extend the base TrackEvent schema:
## Raw Schema:schema.json
{
"title": "Event-Specific Properties",
"type": "object",
"description": "Properties specific to this event type (extends BaseEvent)",
"extends": "https://event-catalog.prod.otc.fts.d-3.de/schemas/analytics-track.yaml#/TrackEvent",
"eventType": "DocexRegisterChanged",
"properties": {
"origin": {
"const": "DetailsPerspectivesDocex",
"type": "string"
},
"perspective": {
"description": "The identifier of the perspective (register tab) the user switched to",
"type": "string"
}
},
"components": {
"schemas": {
"BlobSource": {
"description": "The blob content type that was targeted for download",
"enum": [
"blob",
"mainBlobContent",
"dependentBlobContent"
],
"type": "string"
},
"ContextActionOrigin": {
"description": "The UI area from which a context action was triggered. Emitted by the context action service; falls back to \"unknown\" when the caller provides no origin.",
"enum": [
"Details",
"DetailsPerspectives",
"FolderNavigator",
"SearchResult",
"SearchResultGrid",
"SearchResultList",
"unknown"
],
"type": "string"
},
"DocexOrigin": {
"description": "The UI area from which a Docex-specific action was triggered",
"enum": [
"DetailsPerspectivesDocex",
"NewVersionDocex"
],
"type": "string"
},
"DocumentState": {
"description": "The release state of a document",
"enum": [
"PROCESSING",
"RELEASE"
],
"type": "string"
},
"PreviewOrigin": {
"description": "The UI area from which a preview-related action was triggered",
"enum": [
"Details",
"DetailsPreview"
],
"type": "string"
}
}
}
}
---
id: dms-app.DocexUpdatePropertiesCancelClicked
name: DocexUpdatePropertiesCancelClicked
version: 1.0.0
summary: "When a user clicks the cancel button in the Docex update-properties form"
producers:
- dms-app
consumers: []
schemaPath: 'schema.json'
---
# DocexUpdatePropertiesCancelClicked
When a user clicks the cancel button in the Docex update-properties form
## Base Schema
All analytics events are based on the **TrackEvent** schema which provides common properties like `messageId`, `userId`, `context`, timestamps, and more.
**Base Schema Reference**: [analytics-track.yaml](https://event-catalog.prod.otc.fts.d-3.de/schemas/analytics-track.yaml)
## Event-Specific Properties
This schema shows only the event-specific properties that extend the base TrackEvent schema:
## Raw Schema:schema.json
{
"title": "Event-Specific Properties",
"type": "object",
"description": "Properties specific to this event type (extends BaseEvent)",
"extends": "https://event-catalog.prod.otc.fts.d-3.de/schemas/analytics-track.yaml#/TrackEvent",
"eventType": "DocexUpdatePropertiesCancelClicked",
"properties": {},
"note": "This event uses only BaseEvent properties with no additional event-specific properties",
"components": {
"schemas": {
"BlobSource": {
"description": "The blob content type that was targeted for download",
"enum": [
"blob",
"mainBlobContent",
"dependentBlobContent"
],
"type": "string"
},
"ContextActionOrigin": {
"description": "The UI area from which a context action was triggered. Emitted by the context action service; falls back to \"unknown\" when the caller provides no origin.",
"enum": [
"Details",
"DetailsPerspectives",
"FolderNavigator",
"SearchResult",
"SearchResultGrid",
"SearchResultList",
"unknown"
],
"type": "string"
},
"DocexOrigin": {
"description": "The UI area from which a Docex-specific action was triggered",
"enum": [
"DetailsPerspectivesDocex",
"NewVersionDocex"
],
"type": "string"
},
"DocumentState": {
"description": "The release state of a document",
"enum": [
"PROCESSING",
"RELEASE"
],
"type": "string"
},
"PreviewOrigin": {
"description": "The UI area from which a preview-related action was triggered",
"enum": [
"Details",
"DetailsPreview"
],
"type": "string"
}
}
}
}
---
id: dms-app.DocexUpdatePropertiesSaveClicked
name: DocexUpdatePropertiesSaveClicked
version: 1.0.0
summary: "When a user clicks the save button in the Docex update-properties form"
producers:
- dms-app
consumers: []
schemaPath: 'schema.json'
---
# DocexUpdatePropertiesSaveClicked
When a user clicks the save button in the Docex update-properties form
## Base Schema
All analytics events are based on the **TrackEvent** schema which provides common properties like `messageId`, `userId`, `context`, timestamps, and more.
**Base Schema Reference**: [analytics-track.yaml](https://event-catalog.prod.otc.fts.d-3.de/schemas/analytics-track.yaml)
## Event-Specific Properties
This schema shows only the event-specific properties that extend the base TrackEvent schema:
## Raw Schema:schema.json
{
"title": "Event-Specific Properties",
"type": "object",
"description": "Properties specific to this event type (extends BaseEvent)",
"extends": "https://event-catalog.prod.otc.fts.d-3.de/schemas/analytics-track.yaml#/TrackEvent",
"eventType": "DocexUpdatePropertiesSaveClicked",
"properties": {},
"note": "This event uses only BaseEvent properties with no additional event-specific properties",
"components": {
"schemas": {
"BlobSource": {
"description": "The blob content type that was targeted for download",
"enum": [
"blob",
"mainBlobContent",
"dependentBlobContent"
],
"type": "string"
},
"ContextActionOrigin": {
"description": "The UI area from which a context action was triggered. Emitted by the context action service; falls back to \"unknown\" when the caller provides no origin.",
"enum": [
"Details",
"DetailsPerspectives",
"FolderNavigator",
"SearchResult",
"SearchResultGrid",
"SearchResultList",
"unknown"
],
"type": "string"
},
"DocexOrigin": {
"description": "The UI area from which a Docex-specific action was triggered",
"enum": [
"DetailsPerspectivesDocex",
"NewVersionDocex"
],
"type": "string"
},
"DocumentState": {
"description": "The release state of a document",
"enum": [
"PROCESSING",
"RELEASE"
],
"type": "string"
},
"PreviewOrigin": {
"description": "The UI area from which a preview-related action was triggered",
"enum": [
"Details",
"DetailsPreview"
],
"type": "string"
}
}
}
}
---
id: dms-app.DocexUpdatePropertiesValidateClicked
name: DocexUpdatePropertiesValidateClicked
version: 1.0.0
summary: "When a user clicks the validate properties button in the Docex update-properties form"
producers:
- dms-app
consumers: []
schemaPath: 'schema.json'
---
# DocexUpdatePropertiesValidateClicked
When a user clicks the validate properties button in the Docex update-properties form
## Base Schema
All analytics events are based on the **TrackEvent** schema which provides common properties like `messageId`, `userId`, `context`, timestamps, and more.
**Base Schema Reference**: [analytics-track.yaml](https://event-catalog.prod.otc.fts.d-3.de/schemas/analytics-track.yaml)
## Event-Specific Properties
This schema shows only the event-specific properties that extend the base TrackEvent schema:
## Raw Schema:schema.json
{
"title": "Event-Specific Properties",
"type": "object",
"description": "Properties specific to this event type (extends BaseEvent)",
"extends": "https://event-catalog.prod.otc.fts.d-3.de/schemas/analytics-track.yaml#/TrackEvent",
"eventType": "DocexUpdatePropertiesValidateClicked",
"properties": {},
"note": "This event uses only BaseEvent properties with no additional event-specific properties",
"components": {
"schemas": {
"BlobSource": {
"description": "The blob content type that was targeted for download",
"enum": [
"blob",
"mainBlobContent",
"dependentBlobContent"
],
"type": "string"
},
"ContextActionOrigin": {
"description": "The UI area from which a context action was triggered. Emitted by the context action service; falls back to \"unknown\" when the caller provides no origin.",
"enum": [
"Details",
"DetailsPerspectives",
"FolderNavigator",
"SearchResult",
"SearchResultGrid",
"SearchResultList",
"unknown"
],
"type": "string"
},
"DocexOrigin": {
"description": "The UI area from which a Docex-specific action was triggered",
"enum": [
"DetailsPerspectivesDocex",
"NewVersionDocex"
],
"type": "string"
},
"DocumentState": {
"description": "The release state of a document",
"enum": [
"PROCESSING",
"RELEASE"
],
"type": "string"
},
"PreviewOrigin": {
"description": "The UI area from which a preview-related action was triggered",
"enum": [
"Details",
"DetailsPreview"
],
"type": "string"
}
}
}
}
---
id: dms-app.DocumentDownloadClicked
name: DocumentDownloadClicked
version: 1.0.0
summary: "When a user clicks the download action for a document or blob"
producers:
- dms-app
consumers: []
schemaPath: 'schema.json'
---
# DocumentDownloadClicked
When a user clicks the download action for a document or blob
## Base Schema
All analytics events are based on the **TrackEvent** schema which provides common properties like `messageId`, `userId`, `context`, timestamps, and more.
**Base Schema Reference**: [analytics-track.yaml](https://event-catalog.prod.otc.fts.d-3.de/schemas/analytics-track.yaml)
## Event-Specific Properties
This schema shows only the event-specific properties that extend the base TrackEvent schema:
## Raw Schema:schema.json
{
"title": "Event-Specific Properties",
"type": "object",
"description": "Properties specific to this event type (extends BaseEvent)",
"extends": "https://event-catalog.prod.otc.fts.d-3.de/schemas/analytics-track.yaml#/TrackEvent",
"eventType": "DocumentDownloadClicked",
"properties": {
"source": {
"$ref": "#/components/schemas/BlobSource"
},
"origin": {
"$ref": "#/components/schemas/ContextActionOrigin"
}
},
"components": {
"schemas": {
"BlobSource": {
"description": "The blob content type that was targeted for download",
"enum": [
"blob",
"mainBlobContent",
"dependentBlobContent"
],
"type": "string"
},
"ContextActionOrigin": {
"description": "The UI area from which a context action was triggered. Emitted by the context action service; falls back to \"unknown\" when the caller provides no origin.",
"enum": [
"Details",
"DetailsPerspectives",
"FolderNavigator",
"SearchResult",
"SearchResultGrid",
"SearchResultList",
"unknown"
],
"type": "string"
},
"DocexOrigin": {
"description": "The UI area from which a Docex-specific action was triggered",
"enum": [
"DetailsPerspectivesDocex",
"NewVersionDocex"
],
"type": "string"
},
"DocumentState": {
"description": "The release state of a document",
"enum": [
"PROCESSING",
"RELEASE"
],
"type": "string"
},
"PreviewOrigin": {
"description": "The UI area from which a preview-related action was triggered",
"enum": [
"Details",
"DetailsPreview"
],
"type": "string"
}
}
}
}
---
id: dms-app.DocumentDownloadDialogDismissed
name: DocumentDownloadDialogDismissed
version: 1.0.0
summary: "When a user dismisses the download dialog without downloading a document"
producers:
- dms-app
consumers: []
schemaPath: 'schema.json'
---
# DocumentDownloadDialogDismissed
When a user dismisses the download dialog without downloading a document
## Base Schema
All analytics events are based on the **TrackEvent** schema which provides common properties like `messageId`, `userId`, `context`, timestamps, and more.
**Base Schema Reference**: [analytics-track.yaml](https://event-catalog.prod.otc.fts.d-3.de/schemas/analytics-track.yaml)
## Event-Specific Properties
This schema shows only the event-specific properties that extend the base TrackEvent schema:
## Raw Schema:schema.json
{
"title": "Event-Specific Properties",
"type": "object",
"description": "Properties specific to this event type (extends BaseEvent)",
"extends": "https://event-catalog.prod.otc.fts.d-3.de/schemas/analytics-track.yaml#/TrackEvent",
"eventType": "DocumentDownloadDialogDismissed",
"properties": {},
"note": "This event uses only BaseEvent properties with no additional event-specific properties",
"components": {
"schemas": {
"BlobSource": {
"description": "The blob content type that was targeted for download",
"enum": [
"blob",
"mainBlobContent",
"dependentBlobContent"
],
"type": "string"
},
"ContextActionOrigin": {
"description": "The UI area from which a context action was triggered. Emitted by the context action service; falls back to \"unknown\" when the caller provides no origin.",
"enum": [
"Details",
"DetailsPerspectives",
"FolderNavigator",
"SearchResult",
"SearchResultGrid",
"SearchResultList",
"unknown"
],
"type": "string"
},
"DocexOrigin": {
"description": "The UI area from which a Docex-specific action was triggered",
"enum": [
"DetailsPerspectivesDocex",
"NewVersionDocex"
],
"type": "string"
},
"DocumentState": {
"description": "The release state of a document",
"enum": [
"PROCESSING",
"RELEASE"
],
"type": "string"
},
"PreviewOrigin": {
"description": "The UI area from which a preview-related action was triggered",
"enum": [
"Details",
"DetailsPreview"
],
"type": "string"
}
}
}
}
---
id: dms-app.DocumentDownloaded
name: DocumentDownloaded
version: 1.0.0
summary: "When a document blob export is completed and the file is downloaded"
producers:
- dms-app
consumers: []
schemaPath: 'schema.json'
---
# DocumentDownloaded
When a document blob export is completed and the file is downloaded
## Base Schema
All analytics events are based on the **TrackEvent** schema which provides common properties like `messageId`, `userId`, `context`, timestamps, and more.
**Base Schema Reference**: [analytics-track.yaml](https://event-catalog.prod.otc.fts.d-3.de/schemas/analytics-track.yaml)
## Event-Specific Properties
This schema shows only the event-specific properties that extend the base TrackEvent schema:
## Raw Schema:schema.json
{
"title": "Event-Specific Properties",
"type": "object",
"description": "Properties specific to this event type (extends BaseEvent)",
"extends": "https://event-catalog.prod.otc.fts.d-3.de/schemas/analytics-track.yaml#/TrackEvent",
"eventType": "DocumentDownloaded",
"properties": {
"optionCount": {
"description": "The number of export format options presented to the user",
"type": "integer"
},
"displayName": {
"description": "The display name of the downloaded blob",
"type": "string"
},
"secondaryText": {
"description": "The secondary descriptive text shown alongside the blob",
"type": "string"
}
},
"components": {
"schemas": {
"BlobSource": {
"description": "The blob content type that was targeted for download",
"enum": [
"blob",
"mainBlobContent",
"dependentBlobContent"
],
"type": "string"
},
"ContextActionOrigin": {
"description": "The UI area from which a context action was triggered. Emitted by the context action service; falls back to \"unknown\" when the caller provides no origin.",
"enum": [
"Details",
"DetailsPerspectives",
"FolderNavigator",
"SearchResult",
"SearchResultGrid",
"SearchResultList",
"unknown"
],
"type": "string"
},
"DocexOrigin": {
"description": "The UI area from which a Docex-specific action was triggered",
"enum": [
"DetailsPerspectivesDocex",
"NewVersionDocex"
],
"type": "string"
},
"DocumentState": {
"description": "The release state of a document",
"enum": [
"PROCESSING",
"RELEASE"
],
"type": "string"
},
"PreviewOrigin": {
"description": "The UI area from which a preview-related action was triggered",
"enum": [
"Details",
"DetailsPreview"
],
"type": "string"
}
}
}
}
---
id: dms-app.DocumentStatusChanged
name: DocumentStatusChanged
version: 1.0.0
summary: "When a user changes the release state of a document (e.g. from PROCESSING to RELEASE)"
producers:
- dms-app
consumers: []
schemaPath: 'schema.json'
---
# DocumentStatusChanged
When a user changes the release state of a document (e.g. from PROCESSING to RELEASE)
## Base Schema
All analytics events are based on the **TrackEvent** schema which provides common properties like `messageId`, `userId`, `context`, timestamps, and more.
**Base Schema Reference**: [analytics-track.yaml](https://event-catalog.prod.otc.fts.d-3.de/schemas/analytics-track.yaml)
## Event-Specific Properties
This schema shows only the event-specific properties that extend the base TrackEvent schema:
## Raw Schema:schema.json
{
"title": "Event-Specific Properties",
"type": "object",
"description": "Properties specific to this event type (extends BaseEvent)",
"extends": "https://event-catalog.prod.otc.fts.d-3.de/schemas/analytics-track.yaml#/TrackEvent",
"eventType": "DocumentStatusChanged",
"properties": {
"newState": {
"$ref": "#/components/schemas/DocumentState"
},
"origin": {
"$ref": "#/components/schemas/ContextActionOrigin"
}
},
"components": {
"schemas": {
"BlobSource": {
"description": "The blob content type that was targeted for download",
"enum": [
"blob",
"mainBlobContent",
"dependentBlobContent"
],
"type": "string"
},
"ContextActionOrigin": {
"description": "The UI area from which a context action was triggered. Emitted by the context action service; falls back to \"unknown\" when the caller provides no origin.",
"enum": [
"Details",
"DetailsPerspectives",
"FolderNavigator",
"SearchResult",
"SearchResultGrid",
"SearchResultList",
"unknown"
],
"type": "string"
},
"DocexOrigin": {
"description": "The UI area from which a Docex-specific action was triggered",
"enum": [
"DetailsPerspectivesDocex",
"NewVersionDocex"
],
"type": "string"
},
"DocumentState": {
"description": "The release state of a document",
"enum": [
"PROCESSING",
"RELEASE"
],
"type": "string"
},
"PreviewOrigin": {
"description": "The UI area from which a preview-related action was triggered",
"enum": [
"Details",
"DetailsPreview"
],
"type": "string"
}
}
}
}
---
id: dms-app.DViewClicked
name: DViewClicked
version: 1.0.0
summary: "When a user clicks the action to open a document in d.ecs viewer (DView)"
producers:
- dms-app
consumers: []
schemaPath: 'schema.json'
---
# DViewClicked
When a user clicks the action to open a document in d.ecs viewer (DView)
## Base Schema
All analytics events are based on the **TrackEvent** schema which provides common properties like `messageId`, `userId`, `context`, timestamps, and more.
**Base Schema Reference**: [analytics-track.yaml](https://event-catalog.prod.otc.fts.d-3.de/schemas/analytics-track.yaml)
## Event-Specific Properties
This schema shows only the event-specific properties that extend the base TrackEvent schema:
## Raw Schema:schema.json
{
"title": "Event-Specific Properties",
"type": "object",
"description": "Properties specific to this event type (extends BaseEvent)",
"extends": "https://event-catalog.prod.otc.fts.d-3.de/schemas/analytics-track.yaml#/TrackEvent",
"eventType": "DViewClicked",
"properties": {
"origin": {
"$ref": "#/components/schemas/ContextActionOrigin"
}
},
"components": {
"schemas": {
"BlobSource": {
"description": "The blob content type that was targeted for download",
"enum": [
"blob",
"mainBlobContent",
"dependentBlobContent"
],
"type": "string"
},
"ContextActionOrigin": {
"description": "The UI area from which a context action was triggered. Emitted by the context action service; falls back to \"unknown\" when the caller provides no origin.",
"enum": [
"Details",
"DetailsPerspectives",
"FolderNavigator",
"SearchResult",
"SearchResultGrid",
"SearchResultList",
"unknown"
],
"type": "string"
},
"DocexOrigin": {
"description": "The UI area from which a Docex-specific action was triggered",
"enum": [
"DetailsPerspectivesDocex",
"NewVersionDocex"
],
"type": "string"
},
"DocumentState": {
"description": "The release state of a document",
"enum": [
"PROCESSING",
"RELEASE"
],
"type": "string"
},
"PreviewOrigin": {
"description": "The UI area from which a preview-related action was triggered",
"enum": [
"Details",
"DetailsPreview"
],
"type": "string"
}
}
}
}
---
id: dms-app.EditInOfficeClicked
name: EditInOfficeClicked
version: 1.0.0
summary: "When a user clicks the action to edit a document in Microsoft Office"
producers:
- dms-app
consumers: []
schemaPath: 'schema.json'
---
# EditInOfficeClicked
When a user clicks the action to edit a document in Microsoft Office
## Base Schema
All analytics events are based on the **TrackEvent** schema which provides common properties like `messageId`, `userId`, `context`, timestamps, and more.
**Base Schema Reference**: [analytics-track.yaml](https://event-catalog.prod.otc.fts.d-3.de/schemas/analytics-track.yaml)
## Event-Specific Properties
This schema shows only the event-specific properties that extend the base TrackEvent schema:
## Raw Schema:schema.json
{
"title": "Event-Specific Properties",
"type": "object",
"description": "Properties specific to this event type (extends BaseEvent)",
"extends": "https://event-catalog.prod.otc.fts.d-3.de/schemas/analytics-track.yaml#/TrackEvent",
"eventType": "EditInOfficeClicked",
"properties": {
"origin": {
"$ref": "#/components/schemas/ContextActionOrigin"
}
},
"components": {
"schemas": {
"BlobSource": {
"description": "The blob content type that was targeted for download",
"enum": [
"blob",
"mainBlobContent",
"dependentBlobContent"
],
"type": "string"
},
"ContextActionOrigin": {
"description": "The UI area from which a context action was triggered. Emitted by the context action service; falls back to \"unknown\" when the caller provides no origin.",
"enum": [
"Details",
"DetailsPerspectives",
"FolderNavigator",
"SearchResult",
"SearchResultGrid",
"SearchResultList",
"unknown"
],
"type": "string"
},
"DocexOrigin": {
"description": "The UI area from which a Docex-specific action was triggered",
"enum": [
"DetailsPerspectivesDocex",
"NewVersionDocex"
],
"type": "string"
},
"DocumentState": {
"description": "The release state of a document",
"enum": [
"PROCESSING",
"RELEASE"
],
"type": "string"
},
"PreviewOrigin": {
"description": "The UI area from which a preview-related action was triggered",
"enum": [
"Details",
"DetailsPreview"
],
"type": "string"
}
}
}
}
---
id: dms-app.EditLocallyClicked
name: EditLocallyClicked
version: 1.0.0
summary: "When a user clicks the action to edit a document locally (via d.velop documents)"
producers:
- dms-app
consumers: []
schemaPath: 'schema.json'
---
# EditLocallyClicked
When a user clicks the action to edit a document locally (via d.velop documents)
## Base Schema
All analytics events are based on the **TrackEvent** schema which provides common properties like `messageId`, `userId`, `context`, timestamps, and more.
**Base Schema Reference**: [analytics-track.yaml](https://event-catalog.prod.otc.fts.d-3.de/schemas/analytics-track.yaml)
## Event-Specific Properties
This schema shows only the event-specific properties that extend the base TrackEvent schema:
## Raw Schema:schema.json
{
"title": "Event-Specific Properties",
"type": "object",
"description": "Properties specific to this event type (extends BaseEvent)",
"extends": "https://event-catalog.prod.otc.fts.d-3.de/schemas/analytics-track.yaml#/TrackEvent",
"eventType": "EditLocallyClicked",
"properties": {
"origin": {
"$ref": "#/components/schemas/ContextActionOrigin"
}
},
"components": {
"schemas": {
"BlobSource": {
"description": "The blob content type that was targeted for download",
"enum": [
"blob",
"mainBlobContent",
"dependentBlobContent"
],
"type": "string"
},
"ContextActionOrigin": {
"description": "The UI area from which a context action was triggered. Emitted by the context action service; falls back to \"unknown\" when the caller provides no origin.",
"enum": [
"Details",
"DetailsPerspectives",
"FolderNavigator",
"SearchResult",
"SearchResultGrid",
"SearchResultList",
"unknown"
],
"type": "string"
},
"DocexOrigin": {
"description": "The UI area from which a Docex-specific action was triggered",
"enum": [
"DetailsPerspectivesDocex",
"NewVersionDocex"
],
"type": "string"
},
"DocumentState": {
"description": "The release state of a document",
"enum": [
"PROCESSING",
"RELEASE"
],
"type": "string"
},
"PreviewOrigin": {
"description": "The UI area from which a preview-related action was triggered",
"enum": [
"Details",
"DetailsPreview"
],
"type": "string"
}
}
}
}
---
id: dms-app.EditorChanged
name: EditorChanged
version: 1.0.0
summary: "When a user selects a different editor for a document"
producers:
- dms-app
consumers: []
schemaPath: 'schema.json'
---
# EditorChanged
When a user selects a different editor for a document
## Base Schema
All analytics events are based on the **TrackEvent** schema which provides common properties like `messageId`, `userId`, `context`, timestamps, and more.
**Base Schema Reference**: [analytics-track.yaml](https://event-catalog.prod.otc.fts.d-3.de/schemas/analytics-track.yaml)
## Event-Specific Properties
This schema shows only the event-specific properties that extend the base TrackEvent schema:
## Raw Schema:schema.json
{
"title": "Event-Specific Properties",
"type": "object",
"description": "Properties specific to this event type (extends BaseEvent)",
"extends": "https://event-catalog.prod.otc.fts.d-3.de/schemas/analytics-track.yaml#/TrackEvent",
"eventType": "EditorChanged",
"properties": {
"origin": {
"$ref": "#/components/schemas/ContextActionOrigin"
},
"type": {
"description": "The identifier of the selected editor (e.g. \"user\" or an editor kind)",
"type": "string"
}
},
"components": {
"schemas": {
"BlobSource": {
"description": "The blob content type that was targeted for download",
"enum": [
"blob",
"mainBlobContent",
"dependentBlobContent"
],
"type": "string"
},
"ContextActionOrigin": {
"description": "The UI area from which a context action was triggered. Emitted by the context action service; falls back to \"unknown\" when the caller provides no origin.",
"enum": [
"Details",
"DetailsPerspectives",
"FolderNavigator",
"SearchResult",
"SearchResultGrid",
"SearchResultList",
"unknown"
],
"type": "string"
},
"DocexOrigin": {
"description": "The UI area from which a Docex-specific action was triggered",
"enum": [
"DetailsPerspectivesDocex",
"NewVersionDocex"
],
"type": "string"
},
"DocumentState": {
"description": "The release state of a document",
"enum": [
"PROCESSING",
"RELEASE"
],
"type": "string"
},
"PreviewOrigin": {
"description": "The UI area from which a preview-related action was triggered",
"enum": [
"Details",
"DetailsPreview"
],
"type": "string"
}
}
}
}
---
id: dms-app.EditPropertiesClicked
name: EditPropertiesClicked
version: 1.0.0
summary: "When a user clicks the action to edit a DMS object's properties"
producers:
- dms-app
consumers: []
schemaPath: 'schema.json'
---
# EditPropertiesClicked
When a user clicks the action to edit a DMS object's properties
## Base Schema
All analytics events are based on the **TrackEvent** schema which provides common properties like `messageId`, `userId`, `context`, timestamps, and more.
**Base Schema Reference**: [analytics-track.yaml](https://event-catalog.prod.otc.fts.d-3.de/schemas/analytics-track.yaml)
## Event-Specific Properties
This schema shows only the event-specific properties that extend the base TrackEvent schema:
## Raw Schema:schema.json
{
"title": "Event-Specific Properties",
"type": "object",
"description": "Properties specific to this event type (extends BaseEvent)",
"extends": "https://event-catalog.prod.otc.fts.d-3.de/schemas/analytics-track.yaml#/TrackEvent",
"eventType": "EditPropertiesClicked",
"properties": {
"origin": {
"$ref": "#/components/schemas/ContextActionOrigin"
}
},
"components": {
"schemas": {
"BlobSource": {
"description": "The blob content type that was targeted for download",
"enum": [
"blob",
"mainBlobContent",
"dependentBlobContent"
],
"type": "string"
},
"ContextActionOrigin": {
"description": "The UI area from which a context action was triggered. Emitted by the context action service; falls back to \"unknown\" when the caller provides no origin.",
"enum": [
"Details",
"DetailsPerspectives",
"FolderNavigator",
"SearchResult",
"SearchResultGrid",
"SearchResultList",
"unknown"
],
"type": "string"
},
"DocexOrigin": {
"description": "The UI area from which a Docex-specific action was triggered",
"enum": [
"DetailsPerspectivesDocex",
"NewVersionDocex"
],
"type": "string"
},
"DocumentState": {
"description": "The release state of a document",
"enum": [
"PROCESSING",
"RELEASE"
],
"type": "string"
},
"PreviewOrigin": {
"description": "The UI area from which a preview-related action was triggered",
"enum": [
"Details",
"DetailsPreview"
],
"type": "string"
}
}
}
}
---
id: dms-app.ExtensionContextActionClicked
name: ExtensionContextActionClicked
version: 1.0.0
summary: "When a user clicks a context action registered by an extension (HTTP gateway app)"
producers:
- dms-app
consumers: []
schemaPath: 'schema.json'
---
# ExtensionContextActionClicked
When a user clicks a context action registered by an extension (HTTP gateway app)
## Base Schema
All analytics events are based on the **TrackEvent** schema which provides common properties like `messageId`, `userId`, `context`, timestamps, and more.
**Base Schema Reference**: [analytics-track.yaml](https://event-catalog.prod.otc.fts.d-3.de/schemas/analytics-track.yaml)
## Event-Specific Properties
This schema shows only the event-specific properties that extend the base TrackEvent schema:
## Raw Schema:schema.json
{
"title": "Event-Specific Properties",
"type": "object",
"description": "Properties specific to this event type (extends BaseEvent)",
"extends": "https://event-catalog.prod.otc.fts.d-3.de/schemas/analytics-track.yaml#/TrackEvent",
"eventType": "ExtensionContextActionClicked",
"properties": {
"title": {
"description": "The display title of the extension action",
"type": "string"
},
"protocol": {
"description": "The URL protocol of the action handler (e.g. \"http\", \"https\", \"other\")",
"type": "string"
},
"target": {
"description": "The target specifier of the action (e.g. \"_blank\", \"_self\")",
"type": "string"
},
"origin": {
"$ref": "#/components/schemas/ContextActionOrigin"
}
},
"components": {
"schemas": {
"BlobSource": {
"description": "The blob content type that was targeted for download",
"enum": [
"blob",
"mainBlobContent",
"dependentBlobContent"
],
"type": "string"
},
"ContextActionOrigin": {
"description": "The UI area from which a context action was triggered. Emitted by the context action service; falls back to \"unknown\" when the caller provides no origin.",
"enum": [
"Details",
"DetailsPerspectives",
"FolderNavigator",
"SearchResult",
"SearchResultGrid",
"SearchResultList",
"unknown"
],
"type": "string"
},
"DocexOrigin": {
"description": "The UI area from which a Docex-specific action was triggered",
"enum": [
"DetailsPerspectivesDocex",
"NewVersionDocex"
],
"type": "string"
},
"DocumentState": {
"description": "The release state of a document",
"enum": [
"PROCESSING",
"RELEASE"
],
"type": "string"
},
"PreviewOrigin": {
"description": "The UI area from which a preview-related action was triggered",
"enum": [
"Details",
"DetailsPreview"
],
"type": "string"
}
}
}
}
---
id: dms-app.FavoriteClicked
name: FavoriteClicked
version: 1.0.0
summary: "When a user adds or removes a DMS object from their favorites"
producers:
- dms-app
consumers: []
schemaPath: 'schema.json'
---
# FavoriteClicked
When a user adds or removes a DMS object from their favorites
## Base Schema
All analytics events are based on the **TrackEvent** schema which provides common properties like `messageId`, `userId`, `context`, timestamps, and more.
**Base Schema Reference**: [analytics-track.yaml](https://event-catalog.prod.otc.fts.d-3.de/schemas/analytics-track.yaml)
## Event-Specific Properties
This schema shows only the event-specific properties that extend the base TrackEvent schema:
## Raw Schema:schema.json
{
"title": "Event-Specific Properties",
"type": "object",
"description": "Properties specific to this event type (extends BaseEvent)",
"extends": "https://event-catalog.prod.otc.fts.d-3.de/schemas/analytics-track.yaml#/TrackEvent",
"eventType": "FavoriteClicked",
"properties": {
"origin": {
"$ref": "#/components/schemas/ContextActionOrigin"
}
},
"components": {
"schemas": {
"BlobSource": {
"description": "The blob content type that was targeted for download",
"enum": [
"blob",
"mainBlobContent",
"dependentBlobContent"
],
"type": "string"
},
"ContextActionOrigin": {
"description": "The UI area from which a context action was triggered. Emitted by the context action service; falls back to \"unknown\" when the caller provides no origin.",
"enum": [
"Details",
"DetailsPerspectives",
"FolderNavigator",
"SearchResult",
"SearchResultGrid",
"SearchResultList",
"unknown"
],
"type": "string"
},
"DocexOrigin": {
"description": "The UI area from which a Docex-specific action was triggered",
"enum": [
"DetailsPerspectivesDocex",
"NewVersionDocex"
],
"type": "string"
},
"DocumentState": {
"description": "The release state of a document",
"enum": [
"PROCESSING",
"RELEASE"
],
"type": "string"
},
"PreviewOrigin": {
"description": "The UI area from which a preview-related action was triggered",
"enum": [
"Details",
"DetailsPreview"
],
"type": "string"
}
}
}
}
---
id: dms-app.InnersupplyCancelClicked
name: InnersupplyCancelClicked
version: 1.0.0
summary: "When a user clicks the cancel button in the update-properties innersupply form"
producers:
- dms-app
consumers: []
schemaPath: 'schema.json'
---
# InnersupplyCancelClicked
When a user clicks the cancel button in the update-properties innersupply form
## Base Schema
All analytics events are based on the **TrackEvent** schema which provides common properties like `messageId`, `userId`, `context`, timestamps, and more.
**Base Schema Reference**: [analytics-track.yaml](https://event-catalog.prod.otc.fts.d-3.de/schemas/analytics-track.yaml)
## Event-Specific Properties
This schema shows only the event-specific properties that extend the base TrackEvent schema:
## Raw Schema:schema.json
{
"title": "Event-Specific Properties",
"type": "object",
"description": "Properties specific to this event type (extends BaseEvent)",
"extends": "https://event-catalog.prod.otc.fts.d-3.de/schemas/analytics-track.yaml#/TrackEvent",
"eventType": "InnersupplyCancelClicked",
"properties": {},
"note": "This event uses only BaseEvent properties with no additional event-specific properties",
"components": {
"schemas": {
"BlobSource": {
"description": "The blob content type that was targeted for download",
"enum": [
"blob",
"mainBlobContent",
"dependentBlobContent"
],
"type": "string"
},
"ContextActionOrigin": {
"description": "The UI area from which a context action was triggered. Emitted by the context action service; falls back to \"unknown\" when the caller provides no origin.",
"enum": [
"Details",
"DetailsPerspectives",
"FolderNavigator",
"SearchResult",
"SearchResultGrid",
"SearchResultList",
"unknown"
],
"type": "string"
},
"DocexOrigin": {
"description": "The UI area from which a Docex-specific action was triggered",
"enum": [
"DetailsPerspectivesDocex",
"NewVersionDocex"
],
"type": "string"
},
"DocumentState": {
"description": "The release state of a document",
"enum": [
"PROCESSING",
"RELEASE"
],
"type": "string"
},
"PreviewOrigin": {
"description": "The UI area from which a preview-related action was triggered",
"enum": [
"Details",
"DetailsPreview"
],
"type": "string"
}
}
}
}
---
id: dms-app.InnersupplyCheckPropertiesClicked
name: InnersupplyCheckPropertiesClicked
version: 1.0.0
summary: "When a user clicks the validate properties button in the update-properties innersupply form"
producers:
- dms-app
consumers: []
schemaPath: 'schema.json'
---
# InnersupplyCheckPropertiesClicked
When a user clicks the validate properties button in the update-properties innersupply form
## Base Schema
All analytics events are based on the **TrackEvent** schema which provides common properties like `messageId`, `userId`, `context`, timestamps, and more.
**Base Schema Reference**: [analytics-track.yaml](https://event-catalog.prod.otc.fts.d-3.de/schemas/analytics-track.yaml)
## Event-Specific Properties
This schema shows only the event-specific properties that extend the base TrackEvent schema:
## Raw Schema:schema.json
{
"title": "Event-Specific Properties",
"type": "object",
"description": "Properties specific to this event type (extends BaseEvent)",
"extends": "https://event-catalog.prod.otc.fts.d-3.de/schemas/analytics-track.yaml#/TrackEvent",
"eventType": "InnersupplyCheckPropertiesClicked",
"properties": {},
"note": "This event uses only BaseEvent properties with no additional event-specific properties",
"components": {
"schemas": {
"BlobSource": {
"description": "The blob content type that was targeted for download",
"enum": [
"blob",
"mainBlobContent",
"dependentBlobContent"
],
"type": "string"
},
"ContextActionOrigin": {
"description": "The UI area from which a context action was triggered. Emitted by the context action service; falls back to \"unknown\" when the caller provides no origin.",
"enum": [
"Details",
"DetailsPerspectives",
"FolderNavigator",
"SearchResult",
"SearchResultGrid",
"SearchResultList",
"unknown"
],
"type": "string"
},
"DocexOrigin": {
"description": "The UI area from which a Docex-specific action was triggered",
"enum": [
"DetailsPerspectivesDocex",
"NewVersionDocex"
],
"type": "string"
},
"DocumentState": {
"description": "The release state of a document",
"enum": [
"PROCESSING",
"RELEASE"
],
"type": "string"
},
"PreviewOrigin": {
"description": "The UI area from which a preview-related action was triggered",
"enum": [
"Details",
"DetailsPreview"
],
"type": "string"
}
}
}
}
---
id: dms-app.InnersupplyCloseClicked
name: InnersupplyCloseClicked
version: 1.0.0
summary: "When a user clicks the close button in the inner-supply panel toolbar"
producers:
- dms-app
consumers: []
schemaPath: 'schema.json'
---
# InnersupplyCloseClicked
When a user clicks the close button in the inner-supply panel toolbar
## Base Schema
All analytics events are based on the **TrackEvent** schema which provides common properties like `messageId`, `userId`, `context`, timestamps, and more.
**Base Schema Reference**: [analytics-track.yaml](https://event-catalog.prod.otc.fts.d-3.de/schemas/analytics-track.yaml)
## Event-Specific Properties
This schema shows only the event-specific properties that extend the base TrackEvent schema:
## Raw Schema:schema.json
{
"title": "Event-Specific Properties",
"type": "object",
"description": "Properties specific to this event type (extends BaseEvent)",
"extends": "https://event-catalog.prod.otc.fts.d-3.de/schemas/analytics-track.yaml#/TrackEvent",
"eventType": "InnersupplyCloseClicked",
"properties": {},
"note": "This event uses only BaseEvent properties with no additional event-specific properties",
"components": {
"schemas": {
"BlobSource": {
"description": "The blob content type that was targeted for download",
"enum": [
"blob",
"mainBlobContent",
"dependentBlobContent"
],
"type": "string"
},
"ContextActionOrigin": {
"description": "The UI area from which a context action was triggered. Emitted by the context action service; falls back to \"unknown\" when the caller provides no origin.",
"enum": [
"Details",
"DetailsPerspectives",
"FolderNavigator",
"SearchResult",
"SearchResultGrid",
"SearchResultList",
"unknown"
],
"type": "string"
},
"DocexOrigin": {
"description": "The UI area from which a Docex-specific action was triggered",
"enum": [
"DetailsPerspectivesDocex",
"NewVersionDocex"
],
"type": "string"
},
"DocumentState": {
"description": "The release state of a document",
"enum": [
"PROCESSING",
"RELEASE"
],
"type": "string"
},
"PreviewOrigin": {
"description": "The UI area from which a preview-related action was triggered",
"enum": [
"Details",
"DetailsPreview"
],
"type": "string"
}
}
}
}
---
id: dms-app.InnersupplyNavigateToClicked
name: InnersupplyNavigateToClicked
version: 1.0.0
summary: "When a user clicks the navigate-to button in the inner-supply panel toolbar"
producers:
- dms-app
consumers: []
schemaPath: 'schema.json'
---
# InnersupplyNavigateToClicked
When a user clicks the navigate-to button in the inner-supply panel toolbar
## Base Schema
All analytics events are based on the **TrackEvent** schema which provides common properties like `messageId`, `userId`, `context`, timestamps, and more.
**Base Schema Reference**: [analytics-track.yaml](https://event-catalog.prod.otc.fts.d-3.de/schemas/analytics-track.yaml)
## Event-Specific Properties
This schema shows only the event-specific properties that extend the base TrackEvent schema:
## Raw Schema:schema.json
{
"title": "Event-Specific Properties",
"type": "object",
"description": "Properties specific to this event type (extends BaseEvent)",
"extends": "https://event-catalog.prod.otc.fts.d-3.de/schemas/analytics-track.yaml#/TrackEvent",
"eventType": "InnersupplyNavigateToClicked",
"properties": {},
"note": "This event uses only BaseEvent properties with no additional event-specific properties",
"components": {
"schemas": {
"BlobSource": {
"description": "The blob content type that was targeted for download",
"enum": [
"blob",
"mainBlobContent",
"dependentBlobContent"
],
"type": "string"
},
"ContextActionOrigin": {
"description": "The UI area from which a context action was triggered. Emitted by the context action service; falls back to \"unknown\" when the caller provides no origin.",
"enum": [
"Details",
"DetailsPerspectives",
"FolderNavigator",
"SearchResult",
"SearchResultGrid",
"SearchResultList",
"unknown"
],
"type": "string"
},
"DocexOrigin": {
"description": "The UI area from which a Docex-specific action was triggered",
"enum": [
"DetailsPerspectivesDocex",
"NewVersionDocex"
],
"type": "string"
},
"DocumentState": {
"description": "The release state of a document",
"enum": [
"PROCESSING",
"RELEASE"
],
"type": "string"
},
"PreviewOrigin": {
"description": "The UI area from which a preview-related action was triggered",
"enum": [
"Details",
"DetailsPreview"
],
"type": "string"
}
}
}
}
---
id: dms-app.InnersupplySaveClicked
name: InnersupplySaveClicked
version: 1.0.0
summary: "When a user clicks the save button in the update-properties innersupply form"
producers:
- dms-app
consumers: []
schemaPath: 'schema.json'
---
# InnersupplySaveClicked
When a user clicks the save button in the update-properties innersupply form
## Base Schema
All analytics events are based on the **TrackEvent** schema which provides common properties like `messageId`, `userId`, `context`, timestamps, and more.
**Base Schema Reference**: [analytics-track.yaml](https://event-catalog.prod.otc.fts.d-3.de/schemas/analytics-track.yaml)
## Event-Specific Properties
This schema shows only the event-specific properties that extend the base TrackEvent schema:
## Raw Schema:schema.json
{
"title": "Event-Specific Properties",
"type": "object",
"description": "Properties specific to this event type (extends BaseEvent)",
"extends": "https://event-catalog.prod.otc.fts.d-3.de/schemas/analytics-track.yaml#/TrackEvent",
"eventType": "InnersupplySaveClicked",
"properties": {},
"note": "This event uses only BaseEvent properties with no additional event-specific properties",
"components": {
"schemas": {
"BlobSource": {
"description": "The blob content type that was targeted for download",
"enum": [
"blob",
"mainBlobContent",
"dependentBlobContent"
],
"type": "string"
},
"ContextActionOrigin": {
"description": "The UI area from which a context action was triggered. Emitted by the context action service; falls back to \"unknown\" when the caller provides no origin.",
"enum": [
"Details",
"DetailsPerspectives",
"FolderNavigator",
"SearchResult",
"SearchResultGrid",
"SearchResultList",
"unknown"
],
"type": "string"
},
"DocexOrigin": {
"description": "The UI area from which a Docex-specific action was triggered",
"enum": [
"DetailsPerspectivesDocex",
"NewVersionDocex"
],
"type": "string"
},
"DocumentState": {
"description": "The release state of a document",
"enum": [
"PROCESSING",
"RELEASE"
],
"type": "string"
},
"PreviewOrigin": {
"description": "The UI area from which a preview-related action was triggered",
"enum": [
"Details",
"DetailsPreview"
],
"type": "string"
}
}
}
}
---
id: dms-app.LinkedDmsObjectSelected
name: LinkedDmsObjectSelected
version: 1.0.0
summary: "When a user clicks on a linked DMS object in the perspectives panel"
producers:
- dms-app
consumers: []
schemaPath: 'schema.json'
---
# LinkedDmsObjectSelected
When a user clicks on a linked DMS object in the perspectives panel
## Base Schema
All analytics events are based on the **TrackEvent** schema which provides common properties like `messageId`, `userId`, `context`, timestamps, and more.
**Base Schema Reference**: [analytics-track.yaml](https://event-catalog.prod.otc.fts.d-3.de/schemas/analytics-track.yaml)
## Event-Specific Properties
This schema shows only the event-specific properties that extend the base TrackEvent schema:
## Raw Schema:schema.json
{
"title": "Event-Specific Properties",
"type": "object",
"description": "Properties specific to this event type (extends BaseEvent)",
"extends": "https://event-catalog.prod.otc.fts.d-3.de/schemas/analytics-track.yaml#/TrackEvent",
"eventType": "LinkedDmsObjectSelected",
"properties": {
"origin": {
"const": "DetailsPerspectives",
"type": "string"
}
},
"components": {
"schemas": {
"BlobSource": {
"description": "The blob content type that was targeted for download",
"enum": [
"blob",
"mainBlobContent",
"dependentBlobContent"
],
"type": "string"
},
"ContextActionOrigin": {
"description": "The UI area from which a context action was triggered. Emitted by the context action service; falls back to \"unknown\" when the caller provides no origin.",
"enum": [
"Details",
"DetailsPerspectives",
"FolderNavigator",
"SearchResult",
"SearchResultGrid",
"SearchResultList",
"unknown"
],
"type": "string"
},
"DocexOrigin": {
"description": "The UI area from which a Docex-specific action was triggered",
"enum": [
"DetailsPerspectivesDocex",
"NewVersionDocex"
],
"type": "string"
},
"DocumentState": {
"description": "The release state of a document",
"enum": [
"PROCESSING",
"RELEASE"
],
"type": "string"
},
"PreviewOrigin": {
"description": "The UI area from which a preview-related action was triggered",
"enum": [
"Details",
"DetailsPreview"
],
"type": "string"
}
}
}
}
---
id: dms-app.LinkElementsClicked
name: LinkElementsClicked
version: 1.0.0
summary: "When a user clicks the action to link two DMS objects together"
producers:
- dms-app
consumers: []
schemaPath: 'schema.json'
---
# LinkElementsClicked
When a user clicks the action to link two DMS objects together
## Base Schema
All analytics events are based on the **TrackEvent** schema which provides common properties like `messageId`, `userId`, `context`, timestamps, and more.
**Base Schema Reference**: [analytics-track.yaml](https://event-catalog.prod.otc.fts.d-3.de/schemas/analytics-track.yaml)
## Event-Specific Properties
This schema shows only the event-specific properties that extend the base TrackEvent schema:
## Raw Schema:schema.json
{
"title": "Event-Specific Properties",
"type": "object",
"description": "Properties specific to this event type (extends BaseEvent)",
"extends": "https://event-catalog.prod.otc.fts.d-3.de/schemas/analytics-track.yaml#/TrackEvent",
"eventType": "LinkElementsClicked",
"properties": {
"origin": {
"$ref": "#/components/schemas/ContextActionOrigin"
}
},
"components": {
"schemas": {
"BlobSource": {
"description": "The blob content type that was targeted for download",
"enum": [
"blob",
"mainBlobContent",
"dependentBlobContent"
],
"type": "string"
},
"ContextActionOrigin": {
"description": "The UI area from which a context action was triggered. Emitted by the context action service; falls back to \"unknown\" when the caller provides no origin.",
"enum": [
"Details",
"DetailsPerspectives",
"FolderNavigator",
"SearchResult",
"SearchResultGrid",
"SearchResultList",
"unknown"
],
"type": "string"
},
"DocexOrigin": {
"description": "The UI area from which a Docex-specific action was triggered",
"enum": [
"DetailsPerspectivesDocex",
"NewVersionDocex"
],
"type": "string"
},
"DocumentState": {
"description": "The release state of a document",
"enum": [
"PROCESSING",
"RELEASE"
],
"type": "string"
},
"PreviewOrigin": {
"description": "The UI area from which a preview-related action was triggered",
"enum": [
"Details",
"DetailsPreview"
],
"type": "string"
}
}
}
}
---
id: dms-app.MarkSelectedClicked
name: MarkSelectedClicked
version: 1.0.0
summary: "When a user clicks the mark-as-selected action on a DMS object"
producers:
- dms-app
consumers: []
schemaPath: 'schema.json'
---
# MarkSelectedClicked
When a user clicks the mark-as-selected action on a DMS object
## Base Schema
All analytics events are based on the **TrackEvent** schema which provides common properties like `messageId`, `userId`, `context`, timestamps, and more.
**Base Schema Reference**: [analytics-track.yaml](https://event-catalog.prod.otc.fts.d-3.de/schemas/analytics-track.yaml)
## Event-Specific Properties
This schema shows only the event-specific properties that extend the base TrackEvent schema:
## Raw Schema:schema.json
{
"title": "Event-Specific Properties",
"type": "object",
"description": "Properties specific to this event type (extends BaseEvent)",
"extends": "https://event-catalog.prod.otc.fts.d-3.de/schemas/analytics-track.yaml#/TrackEvent",
"eventType": "MarkSelectedClicked",
"properties": {
"origin": {
"$ref": "#/components/schemas/ContextActionOrigin"
}
},
"components": {
"schemas": {
"BlobSource": {
"description": "The blob content type that was targeted for download",
"enum": [
"blob",
"mainBlobContent",
"dependentBlobContent"
],
"type": "string"
},
"ContextActionOrigin": {
"description": "The UI area from which a context action was triggered. Emitted by the context action service; falls back to \"unknown\" when the caller provides no origin.",
"enum": [
"Details",
"DetailsPerspectives",
"FolderNavigator",
"SearchResult",
"SearchResultGrid",
"SearchResultList",
"unknown"
],
"type": "string"
},
"DocexOrigin": {
"description": "The UI area from which a Docex-specific action was triggered",
"enum": [
"DetailsPerspectivesDocex",
"NewVersionDocex"
],
"type": "string"
},
"DocumentState": {
"description": "The release state of a document",
"enum": [
"PROCESSING",
"RELEASE"
],
"type": "string"
},
"PreviewOrigin": {
"description": "The UI area from which a preview-related action was triggered",
"enum": [
"Details",
"DetailsPreview"
],
"type": "string"
}
}
}
}
---
id: dms-app.NewVersionDialogCheckPropertiesClicked
name: NewVersionDialogCheckPropertiesClicked
version: 1.0.0
summary: "When a user clicks the validate properties button in the new-version dialog form"
producers:
- dms-app
consumers: []
schemaPath: 'schema.json'
---
# NewVersionDialogCheckPropertiesClicked
When a user clicks the validate properties button in the new-version dialog form
## Base Schema
All analytics events are based on the **TrackEvent** schema which provides common properties like `messageId`, `userId`, `context`, timestamps, and more.
**Base Schema Reference**: [analytics-track.yaml](https://event-catalog.prod.otc.fts.d-3.de/schemas/analytics-track.yaml)
## Event-Specific Properties
This schema shows only the event-specific properties that extend the base TrackEvent schema:
## Raw Schema:schema.json
{
"title": "Event-Specific Properties",
"type": "object",
"description": "Properties specific to this event type (extends BaseEvent)",
"extends": "https://event-catalog.prod.otc.fts.d-3.de/schemas/analytics-track.yaml#/TrackEvent",
"eventType": "NewVersionDialogCheckPropertiesClicked",
"properties": {},
"note": "This event uses only BaseEvent properties with no additional event-specific properties",
"components": {
"schemas": {
"BlobSource": {
"description": "The blob content type that was targeted for download",
"enum": [
"blob",
"mainBlobContent",
"dependentBlobContent"
],
"type": "string"
},
"ContextActionOrigin": {
"description": "The UI area from which a context action was triggered. Emitted by the context action service; falls back to \"unknown\" when the caller provides no origin.",
"enum": [
"Details",
"DetailsPerspectives",
"FolderNavigator",
"SearchResult",
"SearchResultGrid",
"SearchResultList",
"unknown"
],
"type": "string"
},
"DocexOrigin": {
"description": "The UI area from which a Docex-specific action was triggered",
"enum": [
"DetailsPerspectivesDocex",
"NewVersionDocex"
],
"type": "string"
},
"DocumentState": {
"description": "The release state of a document",
"enum": [
"PROCESSING",
"RELEASE"
],
"type": "string"
},
"PreviewOrigin": {
"description": "The UI area from which a preview-related action was triggered",
"enum": [
"Details",
"DetailsPreview"
],
"type": "string"
}
}
}
}
---
id: dms-app.NewVersionDialogCloseClicked
name: NewVersionDialogCloseClicked
version: 1.0.0
summary: "When a user clicks the close button in the new-version shell dialog form"
producers:
- dms-app
consumers: []
schemaPath: 'schema.json'
---
# NewVersionDialogCloseClicked
When a user clicks the close button in the new-version shell dialog form
## Base Schema
All analytics events are based on the **TrackEvent** schema which provides common properties like `messageId`, `userId`, `context`, timestamps, and more.
**Base Schema Reference**: [analytics-track.yaml](https://event-catalog.prod.otc.fts.d-3.de/schemas/analytics-track.yaml)
## Event-Specific Properties
This schema shows only the event-specific properties that extend the base TrackEvent schema:
## Raw Schema:schema.json
{
"title": "Event-Specific Properties",
"type": "object",
"description": "Properties specific to this event type (extends BaseEvent)",
"extends": "https://event-catalog.prod.otc.fts.d-3.de/schemas/analytics-track.yaml#/TrackEvent",
"eventType": "NewVersionDialogCloseClicked",
"properties": {},
"note": "This event uses only BaseEvent properties with no additional event-specific properties",
"components": {
"schemas": {
"BlobSource": {
"description": "The blob content type that was targeted for download",
"enum": [
"blob",
"mainBlobContent",
"dependentBlobContent"
],
"type": "string"
},
"ContextActionOrigin": {
"description": "The UI area from which a context action was triggered. Emitted by the context action service; falls back to \"unknown\" when the caller provides no origin.",
"enum": [
"Details",
"DetailsPerspectives",
"FolderNavigator",
"SearchResult",
"SearchResultGrid",
"SearchResultList",
"unknown"
],
"type": "string"
},
"DocexOrigin": {
"description": "The UI area from which a Docex-specific action was triggered",
"enum": [
"DetailsPerspectivesDocex",
"NewVersionDocex"
],
"type": "string"
},
"DocumentState": {
"description": "The release state of a document",
"enum": [
"PROCESSING",
"RELEASE"
],
"type": "string"
},
"PreviewOrigin": {
"description": "The UI area from which a preview-related action was triggered",
"enum": [
"Details",
"DetailsPreview"
],
"type": "string"
}
}
}
}
---
id: dms-app.NewVersionDialogSaveAndCloseClicked
name: NewVersionDialogSaveAndCloseClicked
version: 1.0.0
summary: "When a user clicks the save-and-close button in the new-version shell dialog form"
producers:
- dms-app
consumers: []
schemaPath: 'schema.json'
---
# NewVersionDialogSaveAndCloseClicked
When a user clicks the save-and-close button in the new-version shell dialog form
## Base Schema
All analytics events are based on the **TrackEvent** schema which provides common properties like `messageId`, `userId`, `context`, timestamps, and more.
**Base Schema Reference**: [analytics-track.yaml](https://event-catalog.prod.otc.fts.d-3.de/schemas/analytics-track.yaml)
## Event-Specific Properties
This schema shows only the event-specific properties that extend the base TrackEvent schema:
## Raw Schema:schema.json
{
"title": "Event-Specific Properties",
"type": "object",
"description": "Properties specific to this event type (extends BaseEvent)",
"extends": "https://event-catalog.prod.otc.fts.d-3.de/schemas/analytics-track.yaml#/TrackEvent",
"eventType": "NewVersionDialogSaveAndCloseClicked",
"properties": {
"propertiesUpdated": {
"description": "True when the user edited at least one property of the document during the new-version dialog session. False when the user only replaced the file (blob) and left all properties unchanged. Programmatic mutations to the property values during initialization and validation are excluded.",
"type": "boolean"
}
},
"components": {
"schemas": {
"BlobSource": {
"description": "The blob content type that was targeted for download",
"enum": [
"blob",
"mainBlobContent",
"dependentBlobContent"
],
"type": "string"
},
"ContextActionOrigin": {
"description": "The UI area from which a context action was triggered. Emitted by the context action service; falls back to \"unknown\" when the caller provides no origin.",
"enum": [
"Details",
"DetailsPerspectives",
"FolderNavigator",
"SearchResult",
"SearchResultGrid",
"SearchResultList",
"unknown"
],
"type": "string"
},
"DocexOrigin": {
"description": "The UI area from which a Docex-specific action was triggered",
"enum": [
"DetailsPerspectivesDocex",
"NewVersionDocex"
],
"type": "string"
},
"DocumentState": {
"description": "The release state of a document",
"enum": [
"PROCESSING",
"RELEASE"
],
"type": "string"
},
"PreviewOrigin": {
"description": "The UI area from which a preview-related action was triggered",
"enum": [
"Details",
"DetailsPreview"
],
"type": "string"
}
}
}
}
---
id: dms-app.NewVersionDialogSaveClicked
name: NewVersionDialogSaveClicked
version: 1.0.0
summary: "When a user clicks the save button in the new-version shell dialog form"
producers:
- dms-app
consumers: []
schemaPath: 'schema.json'
---
# NewVersionDialogSaveClicked
When a user clicks the save button in the new-version shell dialog form
## Base Schema
All analytics events are based on the **TrackEvent** schema which provides common properties like `messageId`, `userId`, `context`, timestamps, and more.
**Base Schema Reference**: [analytics-track.yaml](https://event-catalog.prod.otc.fts.d-3.de/schemas/analytics-track.yaml)
## Event-Specific Properties
This schema shows only the event-specific properties that extend the base TrackEvent schema:
## Raw Schema:schema.json
{
"title": "Event-Specific Properties",
"type": "object",
"description": "Properties specific to this event type (extends BaseEvent)",
"extends": "https://event-catalog.prod.otc.fts.d-3.de/schemas/analytics-track.yaml#/TrackEvent",
"eventType": "NewVersionDialogSaveClicked",
"properties": {
"propertiesUpdated": {
"description": "True when the user edited at least one property of the document during the new-version dialog session. False when the user only replaced the file (blob) and left all properties unchanged. Programmatic mutations to the property values during initialization and validation are excluded.",
"type": "boolean"
}
},
"components": {
"schemas": {
"BlobSource": {
"description": "The blob content type that was targeted for download",
"enum": [
"blob",
"mainBlobContent",
"dependentBlobContent"
],
"type": "string"
},
"ContextActionOrigin": {
"description": "The UI area from which a context action was triggered. Emitted by the context action service; falls back to \"unknown\" when the caller provides no origin.",
"enum": [
"Details",
"DetailsPerspectives",
"FolderNavigator",
"SearchResult",
"SearchResultGrid",
"SearchResultList",
"unknown"
],
"type": "string"
},
"DocexOrigin": {
"description": "The UI area from which a Docex-specific action was triggered",
"enum": [
"DetailsPerspectivesDocex",
"NewVersionDocex"
],
"type": "string"
},
"DocumentState": {
"description": "The release state of a document",
"enum": [
"PROCESSING",
"RELEASE"
],
"type": "string"
},
"PreviewOrigin": {
"description": "The UI area from which a preview-related action was triggered",
"enum": [
"Details",
"DetailsPreview"
],
"type": "string"
}
}
}
}
---
id: dms-app.NewVersionFileSelected
name: NewVersionFileSelected
version: 1.0.0
summary: "When a user selects one or more files in the OS file picker during the new version upload flow"
producers:
- dms-app
consumers: []
schemaPath: 'schema.json'
---
# NewVersionFileSelected
When a user selects one or more files in the OS file picker during the new version upload flow
## Base Schema
All analytics events are based on the **TrackEvent** schema which provides common properties like `messageId`, `userId`, `context`, timestamps, and more.
**Base Schema Reference**: [analytics-track.yaml](https://event-catalog.prod.otc.fts.d-3.de/schemas/analytics-track.yaml)
## Event-Specific Properties
This schema shows only the event-specific properties that extend the base TrackEvent schema:
## Raw Schema:schema.json
{
"title": "Event-Specific Properties",
"type": "object",
"description": "Properties specific to this event type (extends BaseEvent)",
"extends": "https://event-catalog.prod.otc.fts.d-3.de/schemas/analytics-track.yaml#/TrackEvent",
"eventType": "NewVersionFileSelected",
"properties": {
"origin": {
"$ref": "#/components/schemas/ContextActionOrigin"
}
},
"components": {
"schemas": {
"BlobSource": {
"description": "The blob content type that was targeted for download",
"enum": [
"blob",
"mainBlobContent",
"dependentBlobContent"
],
"type": "string"
},
"ContextActionOrigin": {
"description": "The UI area from which a context action was triggered. Emitted by the context action service; falls back to \"unknown\" when the caller provides no origin.",
"enum": [
"Details",
"DetailsPerspectives",
"FolderNavigator",
"SearchResult",
"SearchResultGrid",
"SearchResultList",
"unknown"
],
"type": "string"
},
"DocexOrigin": {
"description": "The UI area from which a Docex-specific action was triggered",
"enum": [
"DetailsPerspectivesDocex",
"NewVersionDocex"
],
"type": "string"
},
"DocumentState": {
"description": "The release state of a document",
"enum": [
"PROCESSING",
"RELEASE"
],
"type": "string"
},
"PreviewOrigin": {
"description": "The UI area from which a preview-related action was triggered",
"enum": [
"Details",
"DetailsPreview"
],
"type": "string"
}
}
}
}
---
id: dms-app.NewVersionFileSelectionCancelled
name: NewVersionFileSelectionCancelled
version: 1.0.0
summary: "When a user dismisses the OS file picker without selecting a file during the new version upload flow"
producers:
- dms-app
consumers: []
schemaPath: 'schema.json'
---
# NewVersionFileSelectionCancelled
When a user dismisses the OS file picker without selecting a file during the new version upload flow
## Base Schema
All analytics events are based on the **TrackEvent** schema which provides common properties like `messageId`, `userId`, `context`, timestamps, and more.
**Base Schema Reference**: [analytics-track.yaml](https://event-catalog.prod.otc.fts.d-3.de/schemas/analytics-track.yaml)
## Event-Specific Properties
This schema shows only the event-specific properties that extend the base TrackEvent schema:
## Raw Schema:schema.json
{
"title": "Event-Specific Properties",
"type": "object",
"description": "Properties specific to this event type (extends BaseEvent)",
"extends": "https://event-catalog.prod.otc.fts.d-3.de/schemas/analytics-track.yaml#/TrackEvent",
"eventType": "NewVersionFileSelectionCancelled",
"properties": {
"origin": {
"$ref": "#/components/schemas/ContextActionOrigin"
}
},
"components": {
"schemas": {
"BlobSource": {
"description": "The blob content type that was targeted for download",
"enum": [
"blob",
"mainBlobContent",
"dependentBlobContent"
],
"type": "string"
},
"ContextActionOrigin": {
"description": "The UI area from which a context action was triggered. Emitted by the context action service; falls back to \"unknown\" when the caller provides no origin.",
"enum": [
"Details",
"DetailsPerspectives",
"FolderNavigator",
"SearchResult",
"SearchResultGrid",
"SearchResultList",
"unknown"
],
"type": "string"
},
"DocexOrigin": {
"description": "The UI area from which a Docex-specific action was triggered",
"enum": [
"DetailsPerspectivesDocex",
"NewVersionDocex"
],
"type": "string"
},
"DocumentState": {
"description": "The release state of a document",
"enum": [
"PROCESSING",
"RELEASE"
],
"type": "string"
},
"PreviewOrigin": {
"description": "The UI area from which a preview-related action was triggered",
"enum": [
"Details",
"DetailsPreview"
],
"type": "string"
}
}
}
}
---
id: dms-app.NoteCreated
name: NoteCreated
version: 1.0.0
summary: "When a user creates a new note on a DMS object"
producers:
- dms-app
consumers: []
schemaPath: 'schema.json'
---
# NoteCreated
When a user creates a new note on a DMS object
## Base Schema
All analytics events are based on the **TrackEvent** schema which provides common properties like `messageId`, `userId`, `context`, timestamps, and more.
**Base Schema Reference**: [analytics-track.yaml](https://event-catalog.prod.otc.fts.d-3.de/schemas/analytics-track.yaml)
## Event-Specific Properties
This schema shows only the event-specific properties that extend the base TrackEvent schema:
## Raw Schema:schema.json
{
"title": "Event-Specific Properties",
"type": "object",
"description": "Properties specific to this event type (extends BaseEvent)",
"extends": "https://event-catalog.prod.otc.fts.d-3.de/schemas/analytics-track.yaml#/TrackEvent",
"eventType": "NoteCreated",
"properties": {
"origin": {
"const": "DetailsPerspectives",
"type": "string"
},
"length": {
"description": "The character length of the created note",
"type": "integer"
}
},
"components": {
"schemas": {
"BlobSource": {
"description": "The blob content type that was targeted for download",
"enum": [
"blob",
"mainBlobContent",
"dependentBlobContent"
],
"type": "string"
},
"ContextActionOrigin": {
"description": "The UI area from which a context action was triggered. Emitted by the context action service; falls back to \"unknown\" when the caller provides no origin.",
"enum": [
"Details",
"DetailsPerspectives",
"FolderNavigator",
"SearchResult",
"SearchResultGrid",
"SearchResultList",
"unknown"
],
"type": "string"
},
"DocexOrigin": {
"description": "The UI area from which a Docex-specific action was triggered",
"enum": [
"DetailsPerspectivesDocex",
"NewVersionDocex"
],
"type": "string"
},
"DocumentState": {
"description": "The release state of a document",
"enum": [
"PROCESSING",
"RELEASE"
],
"type": "string"
},
"PreviewOrigin": {
"description": "The UI area from which a preview-related action was triggered",
"enum": [
"Details",
"DetailsPreview"
],
"type": "string"
}
}
}
}
---
id: dms-app.OpenPerspectivesClicked
name: OpenPerspectivesClicked
version: 1.0.0
summary: "When a user opens or closes the perspectives panel"
producers:
- dms-app
consumers: []
schemaPath: 'schema.json'
---
# OpenPerspectivesClicked
When a user opens or closes the perspectives panel
## Base Schema
All analytics events are based on the **TrackEvent** schema which provides common properties like `messageId`, `userId`, `context`, timestamps, and more.
**Base Schema Reference**: [analytics-track.yaml](https://event-catalog.prod.otc.fts.d-3.de/schemas/analytics-track.yaml)
## Event-Specific Properties
This schema shows only the event-specific properties that extend the base TrackEvent schema:
## Raw Schema:schema.json
{
"title": "Event-Specific Properties",
"type": "object",
"description": "Properties specific to this event type (extends BaseEvent)",
"extends": "https://event-catalog.prod.otc.fts.d-3.de/schemas/analytics-track.yaml#/TrackEvent",
"eventType": "OpenPerspectivesClicked",
"properties": {
"origin": {
"$ref": "#/components/schemas/ContextActionOrigin"
},
"open": {
"description": "Whether the perspectives panel is being opened (true) or closed (false). Only present when triggered from the perspectives button.",
"type": "boolean"
}
},
"components": {
"schemas": {
"BlobSource": {
"description": "The blob content type that was targeted for download",
"enum": [
"blob",
"mainBlobContent",
"dependentBlobContent"
],
"type": "string"
},
"ContextActionOrigin": {
"description": "The UI area from which a context action was triggered. Emitted by the context action service; falls back to \"unknown\" when the caller provides no origin.",
"enum": [
"Details",
"DetailsPerspectives",
"FolderNavigator",
"SearchResult",
"SearchResultGrid",
"SearchResultList",
"unknown"
],
"type": "string"
},
"DocexOrigin": {
"description": "The UI area from which a Docex-specific action was triggered",
"enum": [
"DetailsPerspectivesDocex",
"NewVersionDocex"
],
"type": "string"
},
"DocumentState": {
"description": "The release state of a document",
"enum": [
"PROCESSING",
"RELEASE"
],
"type": "string"
},
"PreviewOrigin": {
"description": "The UI area from which a preview-related action was triggered",
"enum": [
"Details",
"DetailsPreview"
],
"type": "string"
}
}
}
}
---
id: dms-app.OpenPreviewClicked
name: OpenPreviewClicked
version: 1.0.0
summary: "When a user opens the document preview"
producers:
- dms-app
consumers: []
schemaPath: 'schema.json'
---
# OpenPreviewClicked
When a user opens the document preview
## Base Schema
All analytics events are based on the **TrackEvent** schema which provides common properties like `messageId`, `userId`, `context`, timestamps, and more.
**Base Schema Reference**: [analytics-track.yaml](https://event-catalog.prod.otc.fts.d-3.de/schemas/analytics-track.yaml)
## Event-Specific Properties
This schema shows only the event-specific properties that extend the base TrackEvent schema:
## Raw Schema:schema.json
{
"title": "Event-Specific Properties",
"type": "object",
"description": "Properties specific to this event type (extends BaseEvent)",
"extends": "https://event-catalog.prod.otc.fts.d-3.de/schemas/analytics-track.yaml#/TrackEvent",
"eventType": "OpenPreviewClicked",
"properties": {
"origin": {
"$ref": "#/components/schemas/ContextActionOrigin"
}
},
"components": {
"schemas": {
"BlobSource": {
"description": "The blob content type that was targeted for download",
"enum": [
"blob",
"mainBlobContent",
"dependentBlobContent"
],
"type": "string"
},
"ContextActionOrigin": {
"description": "The UI area from which a context action was triggered. Emitted by the context action service; falls back to \"unknown\" when the caller provides no origin.",
"enum": [
"Details",
"DetailsPerspectives",
"FolderNavigator",
"SearchResult",
"SearchResultGrid",
"SearchResultList",
"unknown"
],
"type": "string"
},
"DocexOrigin": {
"description": "The UI area from which a Docex-specific action was triggered",
"enum": [
"DetailsPerspectivesDocex",
"NewVersionDocex"
],
"type": "string"
},
"DocumentState": {
"description": "The release state of a document",
"enum": [
"PROCESSING",
"RELEASE"
],
"type": "string"
},
"PreviewOrigin": {
"description": "The UI area from which a preview-related action was triggered",
"enum": [
"Details",
"DetailsPreview"
],
"type": "string"
}
}
}
}
---
id: dms-app.PersonalListsClicked
name: PersonalListsClicked
version: 1.0.0
summary: "When a user opens the personal lists action for a DMS object"
producers:
- dms-app
consumers: []
schemaPath: 'schema.json'
---
# PersonalListsClicked
When a user opens the personal lists action for a DMS object
## Base Schema
All analytics events are based on the **TrackEvent** schema which provides common properties like `messageId`, `userId`, `context`, timestamps, and more.
**Base Schema Reference**: [analytics-track.yaml](https://event-catalog.prod.otc.fts.d-3.de/schemas/analytics-track.yaml)
## Event-Specific Properties
This schema shows only the event-specific properties that extend the base TrackEvent schema:
## Raw Schema:schema.json
{
"title": "Event-Specific Properties",
"type": "object",
"description": "Properties specific to this event type (extends BaseEvent)",
"extends": "https://event-catalog.prod.otc.fts.d-3.de/schemas/analytics-track.yaml#/TrackEvent",
"eventType": "PersonalListsClicked",
"properties": {
"origin": {
"$ref": "#/components/schemas/ContextActionOrigin"
}
},
"components": {
"schemas": {
"BlobSource": {
"description": "The blob content type that was targeted for download",
"enum": [
"blob",
"mainBlobContent",
"dependentBlobContent"
],
"type": "string"
},
"ContextActionOrigin": {
"description": "The UI area from which a context action was triggered. Emitted by the context action service; falls back to \"unknown\" when the caller provides no origin.",
"enum": [
"Details",
"DetailsPerspectives",
"FolderNavigator",
"SearchResult",
"SearchResultGrid",
"SearchResultList",
"unknown"
],
"type": "string"
},
"DocexOrigin": {
"description": "The UI area from which a Docex-specific action was triggered",
"enum": [
"DetailsPerspectivesDocex",
"NewVersionDocex"
],
"type": "string"
},
"DocumentState": {
"description": "The release state of a document",
"enum": [
"PROCESSING",
"RELEASE"
],
"type": "string"
},
"PreviewOrigin": {
"description": "The UI area from which a preview-related action was triggered",
"enum": [
"Details",
"DetailsPreview"
],
"type": "string"
}
}
}
}
---
id: dms-app.PreviewFormatChanged
name: PreviewFormatChanged
version: 1.0.0
summary: "When a user changes the preview format of a document"
producers:
- dms-app
consumers: []
schemaPath: 'schema.json'
---
# PreviewFormatChanged
When a user changes the preview format of a document
## Base Schema
All analytics events are based on the **TrackEvent** schema which provides common properties like `messageId`, `userId`, `context`, timestamps, and more.
**Base Schema Reference**: [analytics-track.yaml](https://event-catalog.prod.otc.fts.d-3.de/schemas/analytics-track.yaml)
## Event-Specific Properties
This schema shows only the event-specific properties that extend the base TrackEvent schema:
## Raw Schema:schema.json
{
"title": "Event-Specific Properties",
"type": "object",
"description": "Properties specific to this event type (extends BaseEvent)",
"extends": "https://event-catalog.prod.otc.fts.d-3.de/schemas/analytics-track.yaml#/TrackEvent",
"eventType": "PreviewFormatChanged",
"properties": {
"type": {
"description": "The display name of the selected preview format",
"type": "string"
},
"origin": {
"$ref": "#/components/schemas/PreviewOrigin"
}
},
"components": {
"schemas": {
"BlobSource": {
"description": "The blob content type that was targeted for download",
"enum": [
"blob",
"mainBlobContent",
"dependentBlobContent"
],
"type": "string"
},
"ContextActionOrigin": {
"description": "The UI area from which a context action was triggered. Emitted by the context action service; falls back to \"unknown\" when the caller provides no origin.",
"enum": [
"Details",
"DetailsPerspectives",
"FolderNavigator",
"SearchResult",
"SearchResultGrid",
"SearchResultList",
"unknown"
],
"type": "string"
},
"DocexOrigin": {
"description": "The UI area from which a Docex-specific action was triggered",
"enum": [
"DetailsPerspectivesDocex",
"NewVersionDocex"
],
"type": "string"
},
"DocumentState": {
"description": "The release state of a document",
"enum": [
"PROCESSING",
"RELEASE"
],
"type": "string"
},
"PreviewOrigin": {
"description": "The UI area from which a preview-related action was triggered",
"enum": [
"Details",
"DetailsPreview"
],
"type": "string"
}
}
}
}
---
id: dms-app.PropertiesFormCategorySelected
name: PropertiesFormCategorySelected
version: 1.0.0
summary: "When a user selects a category or import template in the import form"
producers:
- dms-app
consumers: []
schemaPath: 'schema.json'
---
# PropertiesFormCategorySelected
When a user selects a category or import template in the import form
## Base Schema
All analytics events are based on the **TrackEvent** schema which provides common properties like `messageId`, `userId`, `context`, timestamps, and more.
**Base Schema Reference**: [analytics-track.yaml](https://event-catalog.prod.otc.fts.d-3.de/schemas/analytics-track.yaml)
## Event-Specific Properties
This schema shows only the event-specific properties that extend the base TrackEvent schema:
## Raw Schema:schema.json
{
"title": "Event-Specific Properties",
"type": "object",
"description": "Properties specific to this event type (extends BaseEvent)",
"extends": "https://event-catalog.prod.otc.fts.d-3.de/schemas/analytics-track.yaml#/TrackEvent",
"eventType": "PropertiesFormCategorySelected",
"properties": {
"kind": {
"description": "The kind of the selected object definition (FOLDER corresponds to a dossier)",
"enum": [
"DOCUMENT",
"FOLDER",
"TEMPLATE"
],
"type": "string"
},
"formContext": {
"description": "Whether the form was opened for updating an existing object or importing a new one",
"enum": [
"update",
"import"
],
"type": "string"
},
"origin": {
"description": "DetailsPerspectives when opened from the perspectives panel (update flow), ImportFormDialog when in a shell dialog, ImportForm otherwise",
"enum": [
"DetailsPerspectives",
"ImportFormDialog",
"ImportForm"
],
"type": "string"
}
},
"components": {
"schemas": {
"BlobSource": {
"description": "The blob content type that was targeted for download",
"enum": [
"blob",
"mainBlobContent",
"dependentBlobContent"
],
"type": "string"
},
"ContextActionOrigin": {
"description": "The UI area from which a context action was triggered. Emitted by the context action service; falls back to \"unknown\" when the caller provides no origin.",
"enum": [
"Details",
"DetailsPerspectives",
"FolderNavigator",
"SearchResult",
"SearchResultGrid",
"SearchResultList",
"unknown"
],
"type": "string"
},
"DocexOrigin": {
"description": "The UI area from which a Docex-specific action was triggered",
"enum": [
"DetailsPerspectivesDocex",
"NewVersionDocex"
],
"type": "string"
},
"DocumentState": {
"description": "The release state of a document",
"enum": [
"PROCESSING",
"RELEASE"
],
"type": "string"
},
"PreviewOrigin": {
"description": "The UI area from which a preview-related action was triggered",
"enum": [
"Details",
"DetailsPreview"
],
"type": "string"
}
}
}
}
---
id: dms-app.PropertiesFormTabClicked
name: PropertiesFormTabClicked
version: 1.0.0
summary: "When a user switches between the common and extended property tabs in the DMS object form"
producers:
- dms-app
consumers: []
schemaPath: 'schema.json'
---
# PropertiesFormTabClicked
When a user switches between the common and extended property tabs in the DMS object form
## Base Schema
All analytics events are based on the **TrackEvent** schema which provides common properties like `messageId`, `userId`, `context`, timestamps, and more.
**Base Schema Reference**: [analytics-track.yaml](https://event-catalog.prod.otc.fts.d-3.de/schemas/analytics-track.yaml)
## Event-Specific Properties
This schema shows only the event-specific properties that extend the base TrackEvent schema:
## Raw Schema:schema.json
{
"title": "Event-Specific Properties",
"type": "object",
"description": "Properties specific to this event type (extends BaseEvent)",
"extends": "https://event-catalog.prod.otc.fts.d-3.de/schemas/analytics-track.yaml#/TrackEvent",
"eventType": "PropertiesFormTabClicked",
"properties": {
"tab": {
"description": "The tab the user switched to",
"enum": [
"extended",
"multivalue",
"system"
],
"type": "string"
},
"formContext": {
"description": "Whether the form was opened for updating an existing object or importing a new one",
"enum": [
"update",
"import"
],
"type": "string"
},
"origin": {
"description": "DetailsPerspectives when opened from the perspectives panel (update flow), ImportFormDialog or ImportForm when in the import flow",
"enum": [
"DetailsPerspectives",
"ImportFormDialog",
"ImportForm"
],
"type": "string"
}
},
"components": {
"schemas": {
"BlobSource": {
"description": "The blob content type that was targeted for download",
"enum": [
"blob",
"mainBlobContent",
"dependentBlobContent"
],
"type": "string"
},
"ContextActionOrigin": {
"description": "The UI area from which a context action was triggered. Emitted by the context action service; falls back to \"unknown\" when the caller provides no origin.",
"enum": [
"Details",
"DetailsPerspectives",
"FolderNavigator",
"SearchResult",
"SearchResultGrid",
"SearchResultList",
"unknown"
],
"type": "string"
},
"DocexOrigin": {
"description": "The UI area from which a Docex-specific action was triggered",
"enum": [
"DetailsPerspectivesDocex",
"NewVersionDocex"
],
"type": "string"
},
"DocumentState": {
"description": "The release state of a document",
"enum": [
"PROCESSING",
"RELEASE"
],
"type": "string"
},
"PreviewOrigin": {
"description": "The UI area from which a preview-related action was triggered",
"enum": [
"Details",
"DetailsPreview"
],
"type": "string"
}
}
}
}
---
id: dms-app.RefreshClicked
name: RefreshClicked
version: 1.0.0
summary: "When a user clicks the refresh button in the toolbar"
producers:
- dms-app
consumers: []
schemaPath: 'schema.json'
---
# RefreshClicked
When a user clicks the refresh button in the toolbar
## Base Schema
All analytics events are based on the **TrackEvent** schema which provides common properties like `messageId`, `userId`, `context`, timestamps, and more.
**Base Schema Reference**: [analytics-track.yaml](https://event-catalog.prod.otc.fts.d-3.de/schemas/analytics-track.yaml)
## Event-Specific Properties
This schema shows only the event-specific properties that extend the base TrackEvent schema:
## Raw Schema:schema.json
{
"title": "Event-Specific Properties",
"type": "object",
"description": "Properties specific to this event type (extends BaseEvent)",
"extends": "https://event-catalog.prod.otc.fts.d-3.de/schemas/analytics-track.yaml#/TrackEvent",
"eventType": "RefreshClicked",
"properties": {
"origin": {
"const": "Details",
"type": "string"
}
},
"components": {
"schemas": {
"BlobSource": {
"description": "The blob content type that was targeted for download",
"enum": [
"blob",
"mainBlobContent",
"dependentBlobContent"
],
"type": "string"
},
"ContextActionOrigin": {
"description": "The UI area from which a context action was triggered. Emitted by the context action service; falls back to \"unknown\" when the caller provides no origin.",
"enum": [
"Details",
"DetailsPerspectives",
"FolderNavigator",
"SearchResult",
"SearchResultGrid",
"SearchResultList",
"unknown"
],
"type": "string"
},
"DocexOrigin": {
"description": "The UI area from which a Docex-specific action was triggered",
"enum": [
"DetailsPerspectivesDocex",
"NewVersionDocex"
],
"type": "string"
},
"DocumentState": {
"description": "The release state of a document",
"enum": [
"PROCESSING",
"RELEASE"
],
"type": "string"
},
"PreviewOrigin": {
"description": "The UI area from which a preview-related action was triggered",
"enum": [
"Details",
"DetailsPreview"
],
"type": "string"
}
}
}
}
---
id: dms-app.RegisterChanged
name: RegisterChanged
version: 1.0.0
summary: "When a user switches to a different register (perspective tab) in the details view"
producers:
- dms-app
consumers: []
schemaPath: 'schema.json'
---
# RegisterChanged
When a user switches to a different register (perspective tab) in the details view
## Base Schema
All analytics events are based on the **TrackEvent** schema which provides common properties like `messageId`, `userId`, `context`, timestamps, and more.
**Base Schema Reference**: [analytics-track.yaml](https://event-catalog.prod.otc.fts.d-3.de/schemas/analytics-track.yaml)
## Event-Specific Properties
This schema shows only the event-specific properties that extend the base TrackEvent schema:
## Raw Schema:schema.json
{
"title": "Event-Specific Properties",
"type": "object",
"description": "Properties specific to this event type (extends BaseEvent)",
"extends": "https://event-catalog.prod.otc.fts.d-3.de/schemas/analytics-track.yaml#/TrackEvent",
"eventType": "RegisterChanged",
"properties": {
"perspective": {
"description": "The identifier of the perspective (register tab) the user switched to",
"type": "string"
},
"origin": {
"const": "DetailsPerspectives",
"type": "string"
}
},
"components": {
"schemas": {
"BlobSource": {
"description": "The blob content type that was targeted for download",
"enum": [
"blob",
"mainBlobContent",
"dependentBlobContent"
],
"type": "string"
},
"ContextActionOrigin": {
"description": "The UI area from which a context action was triggered. Emitted by the context action service; falls back to \"unknown\" when the caller provides no origin.",
"enum": [
"Details",
"DetailsPerspectives",
"FolderNavigator",
"SearchResult",
"SearchResultGrid",
"SearchResultList",
"unknown"
],
"type": "string"
},
"DocexOrigin": {
"description": "The UI area from which a Docex-specific action was triggered",
"enum": [
"DetailsPerspectivesDocex",
"NewVersionDocex"
],
"type": "string"
},
"DocumentState": {
"description": "The release state of a document",
"enum": [
"PROCESSING",
"RELEASE"
],
"type": "string"
},
"PreviewOrigin": {
"description": "The UI area from which a preview-related action was triggered",
"enum": [
"Details",
"DetailsPreview"
],
"type": "string"
}
}
}
}
---
id: dms-app.ShowInFolderClicked
name: ShowInFolderClicked
version: 1.0.0
summary: "When a user clicks the action to navigate to the containing folder"
producers:
- dms-app
consumers: []
schemaPath: 'schema.json'
---
# ShowInFolderClicked
When a user clicks the action to navigate to the containing folder
## Base Schema
All analytics events are based on the **TrackEvent** schema which provides common properties like `messageId`, `userId`, `context`, timestamps, and more.
**Base Schema Reference**: [analytics-track.yaml](https://event-catalog.prod.otc.fts.d-3.de/schemas/analytics-track.yaml)
## Event-Specific Properties
This schema shows only the event-specific properties that extend the base TrackEvent schema:
## Raw Schema:schema.json
{
"title": "Event-Specific Properties",
"type": "object",
"description": "Properties specific to this event type (extends BaseEvent)",
"extends": "https://event-catalog.prod.otc.fts.d-3.de/schemas/analytics-track.yaml#/TrackEvent",
"eventType": "ShowInFolderClicked",
"properties": {
"origin": {
"$ref": "#/components/schemas/ContextActionOrigin"
}
},
"components": {
"schemas": {
"BlobSource": {
"description": "The blob content type that was targeted for download",
"enum": [
"blob",
"mainBlobContent",
"dependentBlobContent"
],
"type": "string"
},
"ContextActionOrigin": {
"description": "The UI area from which a context action was triggered. Emitted by the context action service; falls back to \"unknown\" when the caller provides no origin.",
"enum": [
"Details",
"DetailsPerspectives",
"FolderNavigator",
"SearchResult",
"SearchResultGrid",
"SearchResultList",
"unknown"
],
"type": "string"
},
"DocexOrigin": {
"description": "The UI area from which a Docex-specific action was triggered",
"enum": [
"DetailsPerspectivesDocex",
"NewVersionDocex"
],
"type": "string"
},
"DocumentState": {
"description": "The release state of a document",
"enum": [
"PROCESSING",
"RELEASE"
],
"type": "string"
},
"PreviewOrigin": {
"description": "The UI area from which a preview-related action was triggered",
"enum": [
"Details",
"DetailsPreview"
],
"type": "string"
}
}
}
}
---
id: dms-app.SubscriptionsClicked
name: SubscriptionsClicked
version: 1.0.0
summary: "When a user opens the subscriptions action for a DMS object"
producers:
- dms-app
consumers: []
schemaPath: 'schema.json'
---
# SubscriptionsClicked
When a user opens the subscriptions action for a DMS object
## Base Schema
All analytics events are based on the **TrackEvent** schema which provides common properties like `messageId`, `userId`, `context`, timestamps, and more.
**Base Schema Reference**: [analytics-track.yaml](https://event-catalog.prod.otc.fts.d-3.de/schemas/analytics-track.yaml)
## Event-Specific Properties
This schema shows only the event-specific properties that extend the base TrackEvent schema:
## Raw Schema:schema.json
{
"title": "Event-Specific Properties",
"type": "object",
"description": "Properties specific to this event type (extends BaseEvent)",
"extends": "https://event-catalog.prod.otc.fts.d-3.de/schemas/analytics-track.yaml#/TrackEvent",
"eventType": "SubscriptionsClicked",
"properties": {
"origin": {
"$ref": "#/components/schemas/ContextActionOrigin"
}
},
"components": {
"schemas": {
"BlobSource": {
"description": "The blob content type that was targeted for download",
"enum": [
"blob",
"mainBlobContent",
"dependentBlobContent"
],
"type": "string"
},
"ContextActionOrigin": {
"description": "The UI area from which a context action was triggered. Emitted by the context action service; falls back to \"unknown\" when the caller provides no origin.",
"enum": [
"Details",
"DetailsPerspectives",
"FolderNavigator",
"SearchResult",
"SearchResultGrid",
"SearchResultList",
"unknown"
],
"type": "string"
},
"DocexOrigin": {
"description": "The UI area from which a Docex-specific action was triggered",
"enum": [
"DetailsPerspectivesDocex",
"NewVersionDocex"
],
"type": "string"
},
"DocumentState": {
"description": "The release state of a document",
"enum": [
"PROCESSING",
"RELEASE"
],
"type": "string"
},
"PreviewOrigin": {
"description": "The UI area from which a preview-related action was triggered",
"enum": [
"Details",
"DetailsPreview"
],
"type": "string"
}
}
}
}
---
id: dms-app.UnlinkElementsClicked
name: UnlinkElementsClicked
version: 1.0.0
summary: "When a user clicks the action to remove a link between two DMS objects"
producers:
- dms-app
consumers: []
schemaPath: 'schema.json'
---
# UnlinkElementsClicked
When a user clicks the action to remove a link between two DMS objects
## Base Schema
All analytics events are based on the **TrackEvent** schema which provides common properties like `messageId`, `userId`, `context`, timestamps, and more.
**Base Schema Reference**: [analytics-track.yaml](https://event-catalog.prod.otc.fts.d-3.de/schemas/analytics-track.yaml)
## Event-Specific Properties
This schema shows only the event-specific properties that extend the base TrackEvent schema:
## Raw Schema:schema.json
{
"title": "Event-Specific Properties",
"type": "object",
"description": "Properties specific to this event type (extends BaseEvent)",
"extends": "https://event-catalog.prod.otc.fts.d-3.de/schemas/analytics-track.yaml#/TrackEvent",
"eventType": "UnlinkElementsClicked",
"properties": {
"origin": {
"$ref": "#/components/schemas/ContextActionOrigin"
}
},
"components": {
"schemas": {
"BlobSource": {
"description": "The blob content type that was targeted for download",
"enum": [
"blob",
"mainBlobContent",
"dependentBlobContent"
],
"type": "string"
},
"ContextActionOrigin": {
"description": "The UI area from which a context action was triggered. Emitted by the context action service; falls back to \"unknown\" when the caller provides no origin.",
"enum": [
"Details",
"DetailsPerspectives",
"FolderNavigator",
"SearchResult",
"SearchResultGrid",
"SearchResultList",
"unknown"
],
"type": "string"
},
"DocexOrigin": {
"description": "The UI area from which a Docex-specific action was triggered",
"enum": [
"DetailsPerspectivesDocex",
"NewVersionDocex"
],
"type": "string"
},
"DocumentState": {
"description": "The release state of a document",
"enum": [
"PROCESSING",
"RELEASE"
],
"type": "string"
},
"PreviewOrigin": {
"description": "The UI area from which a preview-related action was triggered",
"enum": [
"Details",
"DetailsPreview"
],
"type": "string"
}
}
}
}
---
id: dms-app.UploadClicked
name: UploadClicked
version: 1.0.0
summary: "When a user clicks the upload action to attach a new document blob"
producers:
- dms-app
consumers: []
schemaPath: 'schema.json'
---
# UploadClicked
When a user clicks the upload action to attach a new document blob
## Base Schema
All analytics events are based on the **TrackEvent** schema which provides common properties like `messageId`, `userId`, `context`, timestamps, and more.
**Base Schema Reference**: [analytics-track.yaml](https://event-catalog.prod.otc.fts.d-3.de/schemas/analytics-track.yaml)
## Event-Specific Properties
This schema shows only the event-specific properties that extend the base TrackEvent schema:
## Raw Schema:schema.json
{
"title": "Event-Specific Properties",
"type": "object",
"description": "Properties specific to this event type (extends BaseEvent)",
"extends": "https://event-catalog.prod.otc.fts.d-3.de/schemas/analytics-track.yaml#/TrackEvent",
"eventType": "UploadClicked",
"properties": {
"origin": {
"$ref": "#/components/schemas/ContextActionOrigin"
},
"dmsobjectType": {
"description": "The type identifier of the DMS object being uploaded to",
"type": "string"
}
},
"components": {
"schemas": {
"BlobSource": {
"description": "The blob content type that was targeted for download",
"enum": [
"blob",
"mainBlobContent",
"dependentBlobContent"
],
"type": "string"
},
"ContextActionOrigin": {
"description": "The UI area from which a context action was triggered. Emitted by the context action service; falls back to \"unknown\" when the caller provides no origin.",
"enum": [
"Details",
"DetailsPerspectives",
"FolderNavigator",
"SearchResult",
"SearchResultGrid",
"SearchResultList",
"unknown"
],
"type": "string"
},
"DocexOrigin": {
"description": "The UI area from which a Docex-specific action was triggered",
"enum": [
"DetailsPerspectivesDocex",
"NewVersionDocex"
],
"type": "string"
},
"DocumentState": {
"description": "The release state of a document",
"enum": [
"PROCESSING",
"RELEASE"
],
"type": "string"
},
"PreviewOrigin": {
"description": "The UI area from which a preview-related action was triggered",
"enum": [
"Details",
"DetailsPreview"
],
"type": "string"
}
}
}
}
---
id: dms-app.VersionSelected
name: VersionSelected
version: 1.0.0
summary: "When a user selects a specific document version in the version list"
producers:
- dms-app
consumers: []
schemaPath: 'schema.json'
---
# VersionSelected
When a user selects a specific document version in the version list
## Base Schema
All analytics events are based on the **TrackEvent** schema which provides common properties like `messageId`, `userId`, `context`, timestamps, and more.
**Base Schema Reference**: [analytics-track.yaml](https://event-catalog.prod.otc.fts.d-3.de/schemas/analytics-track.yaml)
## Event-Specific Properties
This schema shows only the event-specific properties that extend the base TrackEvent schema:
## Raw Schema:schema.json
{
"title": "Event-Specific Properties",
"type": "object",
"description": "Properties specific to this event type (extends BaseEvent)",
"extends": "https://event-catalog.prod.otc.fts.d-3.de/schemas/analytics-track.yaml#/TrackEvent",
"eventType": "VersionSelected",
"properties": {
"origin": {
"const": "DetailsPerspectives",
"type": "string"
},
"DmsObjectVersionNumber": {
"description": "The version number or label of the selected version",
"type": "string"
}
},
"components": {
"schemas": {
"BlobSource": {
"description": "The blob content type that was targeted for download",
"enum": [
"blob",
"mainBlobContent",
"dependentBlobContent"
],
"type": "string"
},
"ContextActionOrigin": {
"description": "The UI area from which a context action was triggered. Emitted by the context action service; falls back to \"unknown\" when the caller provides no origin.",
"enum": [
"Details",
"DetailsPerspectives",
"FolderNavigator",
"SearchResult",
"SearchResultGrid",
"SearchResultList",
"unknown"
],
"type": "string"
},
"DocexOrigin": {
"description": "The UI area from which a Docex-specific action was triggered",
"enum": [
"DetailsPerspectivesDocex",
"NewVersionDocex"
],
"type": "string"
},
"DocumentState": {
"description": "The release state of a document",
"enum": [
"PROCESSING",
"RELEASE"
],
"type": "string"
},
"PreviewOrigin": {
"description": "The UI area from which a preview-related action was triggered",
"enum": [
"Details",
"DetailsPreview"
],
"type": "string"
}
}
}
}
---
id: dms-app.ViewFullscreenToggled
name: ViewFullscreenToggled
version: 1.0.0
summary: "When a user toggles the fullscreen view of a document preview"
producers:
- dms-app
consumers: []
schemaPath: 'schema.json'
---
# ViewFullscreenToggled
When a user toggles the fullscreen view of a document preview
## Base Schema
All analytics events are based on the **TrackEvent** schema which provides common properties like `messageId`, `userId`, `context`, timestamps, and more.
**Base Schema Reference**: [analytics-track.yaml](https://event-catalog.prod.otc.fts.d-3.de/schemas/analytics-track.yaml)
## Event-Specific Properties
This schema shows only the event-specific properties that extend the base TrackEvent schema:
## Raw Schema:schema.json
{
"title": "Event-Specific Properties",
"type": "object",
"description": "Properties specific to this event type (extends BaseEvent)",
"extends": "https://event-catalog.prod.otc.fts.d-3.de/schemas/analytics-track.yaml#/TrackEvent",
"eventType": "ViewFullscreenToggled",
"properties": {
"wasFullscreen": {
"description": "The fullscreen state before the toggle was triggered",
"type": "boolean"
}
},
"components": {
"schemas": {
"BlobSource": {
"description": "The blob content type that was targeted for download",
"enum": [
"blob",
"mainBlobContent",
"dependentBlobContent"
],
"type": "string"
},
"ContextActionOrigin": {
"description": "The UI area from which a context action was triggered. Emitted by the context action service; falls back to \"unknown\" when the caller provides no origin.",
"enum": [
"Details",
"DetailsPerspectives",
"FolderNavigator",
"SearchResult",
"SearchResultGrid",
"SearchResultList",
"unknown"
],
"type": "string"
},
"DocexOrigin": {
"description": "The UI area from which a Docex-specific action was triggered",
"enum": [
"DetailsPerspectivesDocex",
"NewVersionDocex"
],
"type": "string"
},
"DocumentState": {
"description": "The release state of a document",
"enum": [
"PROCESSING",
"RELEASE"
],
"type": "string"
},
"PreviewOrigin": {
"description": "The UI area from which a preview-related action was triggered",
"enum": [
"Details",
"DetailsPreview"
],
"type": "string"
}
}
}
}
---
id: docex.DetailsViewModeChanged
name: DetailsViewModeChanged
version: 1.0.0
summary: "When a user toggles the details view between the preview and the properties mode"
producers:
- docex
consumers: []
schemaPath: 'schema.json'
---
# DetailsViewModeChanged
When a user toggles the details view between the preview and the properties mode
## Base Schema
All analytics events are based on the **TrackEvent** schema which provides common properties like `messageId`, `userId`, `context`, timestamps, and more.
**Base Schema Reference**: [analytics-track.yaml](https://event-catalog.prod.otc.fts.d-3.de/schemas/analytics-track.yaml)
## Event-Specific Properties
This schema shows only the event-specific properties that extend the base TrackEvent schema:
## Raw Schema:schema.json
{
"title": "Event-Specific Properties",
"type": "object",
"description": "Properties specific to this event type (extends BaseEvent)",
"extends": "https://event-catalog.prod.otc.fts.d-3.de/schemas/analytics-track.yaml#/TrackEvent",
"eventType": "DetailsViewModeChanged",
"properties": {
"mode": {
"description": "The view mode the user switched to",
"enum": [
"preview",
"properties"
],
"type": "string"
}
},
"components": {
"schemas": {
"Source": {
"description": "The UI area the toolbar select (format or state) was rendered in",
"enum": [
"detailsPreview",
"detailsPage"
],
"type": "string"
}
}
}
}
---
id: docex.DocumentOpened
name: DocumentOpened
version: 1.0.0
summary: "When a DMS object is opened in the details fragment, recording whether it was served from a preload"
producers:
- docex
consumers: []
schemaPath: 'schema.json'
---
# DocumentOpened
When a DMS object is opened in the details fragment, recording whether it was served from a preload
## Base Schema
All analytics events are based on the **TrackEvent** schema which provides common properties like `messageId`, `userId`, `context`, timestamps, and more.
**Base Schema Reference**: [analytics-track.yaml](https://event-catalog.prod.otc.fts.d-3.de/schemas/analytics-track.yaml)
## Event-Specific Properties
This schema shows only the event-specific properties that extend the base TrackEvent schema:
## Raw Schema:schema.json
{
"title": "Event-Specific Properties",
"type": "object",
"description": "Properties specific to this event type (extends BaseEvent)",
"extends": "https://event-catalog.prod.otc.fts.d-3.de/schemas/analytics-track.yaml#/TrackEvent",
"eventType": "DocumentOpened",
"properties": {
"servedFromPreload": {
"description": "True when the opened object was served from a prior preload (preload hit), false on a fresh fetch (miss)",
"type": "boolean"
},
"outcome": {
"description": "Whether the DMS object load resolved successfully or failed",
"enum": [
"loaded",
"error"
],
"type": "string"
},
"durationMs": {
"description": "Time in milliseconds from opening the object to the load settling. On a preload hit this is the residual wait at open time (the preload is already in flight); on a miss it is the full fetch.",
"type": "integer"
}
},
"components": {
"schemas": {
"Source": {
"description": "The UI area the toolbar select (format or state) was rendered in",
"enum": [
"detailsPreview",
"detailsPage"
],
"type": "string"
}
}
}
}
---
id: docex.DocumentPreloaded
name: DocumentPreloaded
version: 1.0.0
summary: "When the details fragment eagerly preloads a DMS object so it is warm for the next opening"
producers:
- docex
consumers: []
schemaPath: 'schema.json'
---
# DocumentPreloaded
When the details fragment eagerly preloads a DMS object so it is warm for the next opening
## Base Schema
All analytics events are based on the **TrackEvent** schema which provides common properties like `messageId`, `userId`, `context`, timestamps, and more.
**Base Schema Reference**: [analytics-track.yaml](https://event-catalog.prod.otc.fts.d-3.de/schemas/analytics-track.yaml)
## Event-Specific Properties
This schema shows only the event-specific properties that extend the base TrackEvent schema:
## Raw Schema:schema.json
{
"title": "Event-Specific Properties",
"type": "object",
"description": "Properties specific to this event type (extends BaseEvent)",
"extends": "https://event-catalog.prod.otc.fts.d-3.de/schemas/analytics-track.yaml#/TrackEvent",
"eventType": "DocumentPreloaded",
"properties": {},
"note": "This event uses only BaseEvent properties with no additional event-specific properties",
"components": {
"schemas": {
"Source": {
"description": "The UI area the toolbar select (format or state) was rendered in",
"enum": [
"detailsPreview",
"detailsPage"
],
"type": "string"
}
}
}
}
---
id: docex.DocumentStateChanged
name: DocumentStateChanged
version: 1.0.0
summary: "When a user releases a document, changing its release state (e.g. from Processing to Release)"
producers:
- docex
consumers: []
schemaPath: 'schema.json'
---
# DocumentStateChanged
When a user releases a document, changing its release state (e.g. from Processing to Release)
## Base Schema
All analytics events are based on the **TrackEvent** schema which provides common properties like `messageId`, `userId`, `context`, timestamps, and more.
**Base Schema Reference**: [analytics-track.yaml](https://event-catalog.prod.otc.fts.d-3.de/schemas/analytics-track.yaml)
## Event-Specific Properties
This schema shows only the event-specific properties that extend the base TrackEvent schema:
## Raw Schema:schema.json
{
"title": "Event-Specific Properties",
"type": "object",
"description": "Properties specific to this event type (extends BaseEvent)",
"extends": "https://event-catalog.prod.otc.fts.d-3.de/schemas/analytics-track.yaml#/TrackEvent",
"eventType": "DocumentStateChanged",
"properties": {
"newState": {
"description": "The release state the document was changed to (the DmsObjectVersionState name, e.g. \"Release\")",
"type": "string"
},
"source": {
"$ref": "#/components/schemas/Source"
},
"previousState": {
"description": "The release state of the document before the change (the DmsObjectVersionState name, or \"Unknown\")",
"type": "string"
}
},
"components": {
"schemas": {
"Source": {
"description": "The UI area the toolbar select (format or state) was rendered in",
"enum": [
"detailsPreview",
"detailsPage"
],
"type": "string"
}
}
}
}
---
id: docex.MimeTypeChanged
name: MimeTypeChanged
version: 1.0.0
summary: "When a user selects a different display format (MIME type) for the document preview"
producers:
- docex
consumers: []
schemaPath: 'schema.json'
---
# MimeTypeChanged
When a user selects a different display format (MIME type) for the document preview
## Base Schema
All analytics events are based on the **TrackEvent** schema which provides common properties like `messageId`, `userId`, `context`, timestamps, and more.
**Base Schema Reference**: [analytics-track.yaml](https://event-catalog.prod.otc.fts.d-3.de/schemas/analytics-track.yaml)
## Event-Specific Properties
This schema shows only the event-specific properties that extend the base TrackEvent schema:
## Raw Schema:schema.json
{
"title": "Event-Specific Properties",
"type": "object",
"description": "Properties specific to this event type (extends BaseEvent)",
"extends": "https://event-catalog.prod.otc.fts.d-3.de/schemas/analytics-track.yaml#/TrackEvent",
"eventType": "MimeTypeChanged",
"properties": {
"previousMimeType": {
"description": "The MIME type that was selected before the change",
"type": "string"
},
"newMimeType": {
"description": "The MIME type the user switched to",
"type": "string"
},
"source": {
"$ref": "#/components/schemas/Source"
}
},
"components": {
"schemas": {
"Source": {
"description": "The UI area the toolbar select (format or state) was rendered in",
"enum": [
"detailsPreview",
"detailsPage"
],
"type": "string"
}
}
}
}
---
id: docex.NewVersionFileSelected
name: NewVersionFileSelected
version: 1.0.0
summary: "When a user selects a file for a new version upload, via drag-and-drop or the file dialog"
producers:
- docex
consumers: []
schemaPath: 'schema.json'
---
# NewVersionFileSelected
When a user selects a file for a new version upload, via drag-and-drop or the file dialog
## Base Schema
All analytics events are based on the **TrackEvent** schema which provides common properties like `messageId`, `userId`, `context`, timestamps, and more.
**Base Schema Reference**: [analytics-track.yaml](https://event-catalog.prod.otc.fts.d-3.de/schemas/analytics-track.yaml)
## Event-Specific Properties
This schema shows only the event-specific properties that extend the base TrackEvent schema:
## Raw Schema:schema.json
{
"title": "Event-Specific Properties",
"type": "object",
"description": "Properties specific to this event type (extends BaseEvent)",
"extends": "https://event-catalog.prod.otc.fts.d-3.de/schemas/analytics-track.yaml#/TrackEvent",
"eventType": "NewVersionFileSelected",
"properties": {
"method": {
"description": "How the file was selected — by dropping it onto the drop zone or via the OS file dialog",
"enum": [
"dragAndDrop",
"fileDialog"
],
"type": "string"
},
"fileSizeBytes": {
"description": "The size of the selected file in bytes",
"type": "integer"
},
"mimeType": {
"description": "The MIME type of the selected file as reported by the browser",
"type": "string"
}
},
"components": {
"schemas": {
"Source": {
"description": "The UI area the toolbar select (format or state) was rendered in",
"enum": [
"detailsPreview",
"detailsPage"
],
"type": "string"
}
}
}
}
---
id: docex.NewVersionFileSelectionCancelled
name: NewVersionFileSelectionCancelled
version: 1.0.0
summary: "When a user dismisses the OS file picker without selecting a file during the new version upload flow"
producers:
- docex
consumers: []
schemaPath: 'schema.json'
---
# NewVersionFileSelectionCancelled
When a user dismisses the OS file picker without selecting a file during the new version upload flow
## Base Schema
All analytics events are based on the **TrackEvent** schema which provides common properties like `messageId`, `userId`, `context`, timestamps, and more.
**Base Schema Reference**: [analytics-track.yaml](https://event-catalog.prod.otc.fts.d-3.de/schemas/analytics-track.yaml)
## Event-Specific Properties
This schema shows only the event-specific properties that extend the base TrackEvent schema:
## Raw Schema:schema.json
{
"title": "Event-Specific Properties",
"type": "object",
"description": "Properties specific to this event type (extends BaseEvent)",
"extends": "https://event-catalog.prod.otc.fts.d-3.de/schemas/analytics-track.yaml#/TrackEvent",
"eventType": "NewVersionFileSelectionCancelled",
"properties": {},
"note": "This event uses only BaseEvent properties with no additional event-specific properties",
"components": {
"schemas": {
"Source": {
"description": "The UI area the toolbar select (format or state) was rendered in",
"enum": [
"detailsPreview",
"detailsPage"
],
"type": "string"
}
}
}
}
---
id: docex.NewVersionFileSelectionOpened
name: NewVersionFileSelectionOpened
version: 1.0.0
summary: "When a user clicks the upload button to open the OS file picker during the new version upload flow"
producers:
- docex
consumers: []
schemaPath: 'schema.json'
---
# NewVersionFileSelectionOpened
When a user clicks the upload button to open the OS file picker during the new version upload flow
## Base Schema
All analytics events are based on the **TrackEvent** schema which provides common properties like `messageId`, `userId`, `context`, timestamps, and more.
**Base Schema Reference**: [analytics-track.yaml](https://event-catalog.prod.otc.fts.d-3.de/schemas/analytics-track.yaml)
## Event-Specific Properties
This schema shows only the event-specific properties that extend the base TrackEvent schema:
## Raw Schema:schema.json
{
"title": "Event-Specific Properties",
"type": "object",
"description": "Properties specific to this event type (extends BaseEvent)",
"extends": "https://event-catalog.prod.otc.fts.d-3.de/schemas/analytics-track.yaml#/TrackEvent",
"eventType": "NewVersionFileSelectionOpened",
"properties": {},
"note": "This event uses only BaseEvent properties with no additional event-specific properties",
"components": {
"schemas": {
"Source": {
"description": "The UI area the toolbar select (format or state) was rendered in",
"enum": [
"detailsPreview",
"detailsPage"
],
"type": "string"
}
}
}
}
---
id: dvelop-actions.ExecuteAction
name: ExecuteAction
version: 1.0.0
summary: "Indicates that an action has been executed successfully"
producers:
- dvelop-actions
consumers: []
schemaPath: 'schema.json'
---
# ExecuteAction
Indicates that an action has been executed successfully
## Base Schema
All analytics events are based on the **TrackEvent** schema which provides common properties like `messageId`, `userId`, `context`, timestamps, and more.
**Base Schema Reference**: [analytics-track.yaml](https://event-catalog.prod.otc.fts.d-3.de/schemas/analytics-track.yaml)
## Event-Specific Properties
This schema shows only the event-specific properties that extend the base TrackEvent schema:
## Raw Schema:schema.json
{
"title": "Event-Specific Properties",
"type": "object",
"description": "Properties specific to this event type (extends BaseEvent)",
"extends": "https://event-catalog.prod.otc.fts.d-3.de/schemas/analytics-track.yaml#/TrackEvent",
"eventType": "ExecuteAction",
"properties": {
"actionId": {
"description": "Unique identifier of the executed action",
"example": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
"type": "string"
},
"executionMode": {
"description": "Whether the action was executed synchronously or asynchronously",
"enum": [
"sync",
"async"
],
"example": "sync",
"type": "string"
},
"volatile": {
"description": "Whether the action is marked as volatile or long term stable",
"example": false,
"type": "boolean"
}
},
"components": {
"schemas": {
"ExecuteActionPayload": {
"allOf": [
{
"$ref": "https://event-catalog.prod.otc.fts.d-3.de/schemas/analytics-track.yaml#/TrackEvent"
},
{
"properties": {
"event": {
"const": "ExecuteAction"
},
"properties": {
"properties": {
"actionId": {
"description": "Unique identifier of the executed action",
"example": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
"type": "string"
},
"executionMode": {
"description": "Whether the action was executed synchronously or asynchronously",
"enum": [
"sync",
"async"
],
"example": "sync",
"type": "string"
},
"volatile": {
"description": "Whether the action is marked as volatile or long term stable",
"example": false,
"type": "boolean"
}
},
"type": "object"
}
},
"title": "Specific event properties",
"type": "object"
}
]
},
"ExecuteEventPayload": {
"allOf": [
{
"$ref": "https://event-catalog.prod.otc.fts.d-3.de/schemas/analytics-track.yaml#/TrackEvent"
},
{
"properties": {
"event": {
"const": "ExecuteEvent"
},
"properties": {
"properties": {
"eventDefinitionId": {
"description": "Composite identifier of the event definition that was received. Derived from CloudEvent headers in the format \"{appName}_{ceType}\".\n",
"example": "documents_dvelop.documents.document.created.v1",
"type": "string"
}
},
"type": "object"
}
},
"title": "Specific event properties",
"type": "object"
}
]
},
"ExecuteRoutineWithActionPayload": {
"allOf": [
{
"$ref": "https://event-catalog.prod.otc.fts.d-3.de/schemas/analytics-track.yaml#/TrackEvent"
},
{
"properties": {
"event": {
"const": "ExecuteRoutineWithAction"
},
"properties": {
"properties": {
"actionId": {
"description": "Unique identifier of the action invoked by this routine",
"example": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
"type": "string"
},
"eventDefinitionId": {
"description": "Identifier of the event definition that triggered this routine",
"example": "documents_dvelop.documents.document.created.v1",
"type": "string"
},
"mappingCount": {
"description": "Number of JSONPath mapping entries configured on the routine",
"example": 3,
"minimum": 0,
"type": "integer"
},
"rulesCount": {
"description": "Number of top-level conditions in the routine's JSONLogic rules expression",
"example": 2,
"minimum": 0,
"type": "integer"
}
},
"type": "object"
}
},
"title": "Specific event properties",
"type": "object"
}
]
},
"ExecuteRoutineWithRelativeURLPayload": {
"allOf": [
{
"$ref": "https://event-catalog.prod.otc.fts.d-3.de/schemas/analytics-track.yaml#/TrackEvent"
},
{
"properties": {
"event": {
"const": "ExecuteRoutineWithRelativeURL"
},
"properties": {
"properties": {
"eventDefinitionId": {
"description": "Identifier of the event definition that triggered this routine",
"example": "documents_dvelop.documents.document.created.v1",
"type": "string"
},
"mappingCount": {
"description": "Number of JSONPath mapping entries configured on the routine",
"example": 3,
"minimum": 0,
"type": "integer"
},
"rulesCount": {
"description": "Number of top-level conditions in the routine's JSONLogic rules expression",
"example": 2,
"minimum": 0,
"type": "integer"
},
"url": {
"description": "The relative URL endpoint called by the routine",
"example": "/api/myapp/webhook",
"type": "string"
}
},
"type": "object"
}
},
"title": "Specific event properties",
"type": "object"
}
]
}
}
}
}
---
id: dvelop-actions.ExecuteEvent
name: ExecuteEvent
version: 1.0.0
summary: "Indicates that an incoming CloudEvent has been accepted and published to the event bus"
producers:
- dvelop-actions
consumers: []
schemaPath: 'schema.json'
---
# ExecuteEvent
Indicates that an incoming CloudEvent has been accepted and published to the event bus
## Base Schema
All analytics events are based on the **TrackEvent** schema which provides common properties like `messageId`, `userId`, `context`, timestamps, and more.
**Base Schema Reference**: [analytics-track.yaml](https://event-catalog.prod.otc.fts.d-3.de/schemas/analytics-track.yaml)
## Event-Specific Properties
This schema shows only the event-specific properties that extend the base TrackEvent schema:
## Raw Schema:schema.json
{
"title": "Event-Specific Properties",
"type": "object",
"description": "Properties specific to this event type (extends BaseEvent)",
"extends": "https://event-catalog.prod.otc.fts.d-3.de/schemas/analytics-track.yaml#/TrackEvent",
"eventType": "ExecuteEvent",
"properties": {
"eventDefinitionId": {
"description": "Composite identifier of the event definition that was received. Derived from CloudEvent headers in the format \"{appName}_{ceType}\".\n",
"example": "documents_dvelop.documents.document.created.v1",
"type": "string"
}
},
"components": {
"schemas": {
"ExecuteActionPayload": {
"allOf": [
{
"$ref": "https://event-catalog.prod.otc.fts.d-3.de/schemas/analytics-track.yaml#/TrackEvent"
},
{
"properties": {
"event": {
"const": "ExecuteAction"
},
"properties": {
"properties": {
"actionId": {
"description": "Unique identifier of the executed action",
"example": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
"type": "string"
},
"executionMode": {
"description": "Whether the action was executed synchronously or asynchronously",
"enum": [
"sync",
"async"
],
"example": "sync",
"type": "string"
},
"volatile": {
"description": "Whether the action is marked as volatile or long term stable",
"example": false,
"type": "boolean"
}
},
"type": "object"
}
},
"title": "Specific event properties",
"type": "object"
}
]
},
"ExecuteEventPayload": {
"allOf": [
{
"$ref": "https://event-catalog.prod.otc.fts.d-3.de/schemas/analytics-track.yaml#/TrackEvent"
},
{
"properties": {
"event": {
"const": "ExecuteEvent"
},
"properties": {
"properties": {
"eventDefinitionId": {
"description": "Composite identifier of the event definition that was received. Derived from CloudEvent headers in the format \"{appName}_{ceType}\".\n",
"example": "documents_dvelop.documents.document.created.v1",
"type": "string"
}
},
"type": "object"
}
},
"title": "Specific event properties",
"type": "object"
}
]
},
"ExecuteRoutineWithActionPayload": {
"allOf": [
{
"$ref": "https://event-catalog.prod.otc.fts.d-3.de/schemas/analytics-track.yaml#/TrackEvent"
},
{
"properties": {
"event": {
"const": "ExecuteRoutineWithAction"
},
"properties": {
"properties": {
"actionId": {
"description": "Unique identifier of the action invoked by this routine",
"example": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
"type": "string"
},
"eventDefinitionId": {
"description": "Identifier of the event definition that triggered this routine",
"example": "documents_dvelop.documents.document.created.v1",
"type": "string"
},
"mappingCount": {
"description": "Number of JSONPath mapping entries configured on the routine",
"example": 3,
"minimum": 0,
"type": "integer"
},
"rulesCount": {
"description": "Number of top-level conditions in the routine's JSONLogic rules expression",
"example": 2,
"minimum": 0,
"type": "integer"
}
},
"type": "object"
}
},
"title": "Specific event properties",
"type": "object"
}
]
},
"ExecuteRoutineWithRelativeURLPayload": {
"allOf": [
{
"$ref": "https://event-catalog.prod.otc.fts.d-3.de/schemas/analytics-track.yaml#/TrackEvent"
},
{
"properties": {
"event": {
"const": "ExecuteRoutineWithRelativeURL"
},
"properties": {
"properties": {
"eventDefinitionId": {
"description": "Identifier of the event definition that triggered this routine",
"example": "documents_dvelop.documents.document.created.v1",
"type": "string"
},
"mappingCount": {
"description": "Number of JSONPath mapping entries configured on the routine",
"example": 3,
"minimum": 0,
"type": "integer"
},
"rulesCount": {
"description": "Number of top-level conditions in the routine's JSONLogic rules expression",
"example": 2,
"minimum": 0,
"type": "integer"
},
"url": {
"description": "The relative URL endpoint called by the routine",
"example": "/api/myapp/webhook",
"type": "string"
}
},
"type": "object"
}
},
"title": "Specific event properties",
"type": "object"
}
]
}
}
}
}
---
id: dvelop-actions.ExecuteRoutineWithAction
name: ExecuteRoutineWithAction
version: 1.0.0
summary: "Indicates that a routine has been triggered and routed to a registered action"
producers:
- dvelop-actions
consumers: []
schemaPath: 'schema.json'
---
# ExecuteRoutineWithAction
Indicates that a routine has been triggered and routed to a registered action
## Base Schema
All analytics events are based on the **TrackEvent** schema which provides common properties like `messageId`, `userId`, `context`, timestamps, and more.
**Base Schema Reference**: [analytics-track.yaml](https://event-catalog.prod.otc.fts.d-3.de/schemas/analytics-track.yaml)
## Event-Specific Properties
This schema shows only the event-specific properties that extend the base TrackEvent schema:
## Raw Schema:schema.json
{
"title": "Event-Specific Properties",
"type": "object",
"description": "Properties specific to this event type (extends BaseEvent)",
"extends": "https://event-catalog.prod.otc.fts.d-3.de/schemas/analytics-track.yaml#/TrackEvent",
"eventType": "ExecuteRoutineWithAction",
"properties": {
"actionId": {
"description": "Unique identifier of the action invoked by this routine",
"example": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
"type": "string"
},
"mappingCount": {
"description": "Number of JSONPath mapping entries configured on the routine",
"example": 3,
"minimum": 0,
"type": "integer"
},
"rulesCount": {
"description": "Number of top-level conditions in the routine's JSONLogic rules expression",
"example": 2,
"minimum": 0,
"type": "integer"
},
"eventDefinitionId": {
"description": "Identifier of the event definition that triggered this routine",
"example": "documents_dvelop.documents.document.created.v1",
"type": "string"
}
},
"components": {
"schemas": {
"ExecuteActionPayload": {
"allOf": [
{
"$ref": "https://event-catalog.prod.otc.fts.d-3.de/schemas/analytics-track.yaml#/TrackEvent"
},
{
"properties": {
"event": {
"const": "ExecuteAction"
},
"properties": {
"properties": {
"actionId": {
"description": "Unique identifier of the executed action",
"example": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
"type": "string"
},
"executionMode": {
"description": "Whether the action was executed synchronously or asynchronously",
"enum": [
"sync",
"async"
],
"example": "sync",
"type": "string"
},
"volatile": {
"description": "Whether the action is marked as volatile or long term stable",
"example": false,
"type": "boolean"
}
},
"type": "object"
}
},
"title": "Specific event properties",
"type": "object"
}
]
},
"ExecuteEventPayload": {
"allOf": [
{
"$ref": "https://event-catalog.prod.otc.fts.d-3.de/schemas/analytics-track.yaml#/TrackEvent"
},
{
"properties": {
"event": {
"const": "ExecuteEvent"
},
"properties": {
"properties": {
"eventDefinitionId": {
"description": "Composite identifier of the event definition that was received. Derived from CloudEvent headers in the format \"{appName}_{ceType}\".\n",
"example": "documents_dvelop.documents.document.created.v1",
"type": "string"
}
},
"type": "object"
}
},
"title": "Specific event properties",
"type": "object"
}
]
},
"ExecuteRoutineWithActionPayload": {
"allOf": [
{
"$ref": "https://event-catalog.prod.otc.fts.d-3.de/schemas/analytics-track.yaml#/TrackEvent"
},
{
"properties": {
"event": {
"const": "ExecuteRoutineWithAction"
},
"properties": {
"properties": {
"actionId": {
"description": "Unique identifier of the action invoked by this routine",
"example": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
"type": "string"
},
"eventDefinitionId": {
"description": "Identifier of the event definition that triggered this routine",
"example": "documents_dvelop.documents.document.created.v1",
"type": "string"
},
"mappingCount": {
"description": "Number of JSONPath mapping entries configured on the routine",
"example": 3,
"minimum": 0,
"type": "integer"
},
"rulesCount": {
"description": "Number of top-level conditions in the routine's JSONLogic rules expression",
"example": 2,
"minimum": 0,
"type": "integer"
}
},
"type": "object"
}
},
"title": "Specific event properties",
"type": "object"
}
]
},
"ExecuteRoutineWithRelativeURLPayload": {
"allOf": [
{
"$ref": "https://event-catalog.prod.otc.fts.d-3.de/schemas/analytics-track.yaml#/TrackEvent"
},
{
"properties": {
"event": {
"const": "ExecuteRoutineWithRelativeURL"
},
"properties": {
"properties": {
"eventDefinitionId": {
"description": "Identifier of the event definition that triggered this routine",
"example": "documents_dvelop.documents.document.created.v1",
"type": "string"
},
"mappingCount": {
"description": "Number of JSONPath mapping entries configured on the routine",
"example": 3,
"minimum": 0,
"type": "integer"
},
"rulesCount": {
"description": "Number of top-level conditions in the routine's JSONLogic rules expression",
"example": 2,
"minimum": 0,
"type": "integer"
},
"url": {
"description": "The relative URL endpoint called by the routine",
"example": "/api/myapp/webhook",
"type": "string"
}
},
"type": "object"
}
},
"title": "Specific event properties",
"type": "object"
}
]
}
}
}
}
---
id: dvelop-actions.ExecuteRoutineWithRelativeURL
name: ExecuteRoutineWithRelativeURL
version: 1.0.0
summary: "Indicates that a routine has been triggered and routed to a relative URL endpoint"
producers:
- dvelop-actions
consumers: []
schemaPath: 'schema.json'
---
# ExecuteRoutineWithRelativeURL
Indicates that a routine has been triggered and routed to a relative URL endpoint
## Base Schema
All analytics events are based on the **TrackEvent** schema which provides common properties like `messageId`, `userId`, `context`, timestamps, and more.
**Base Schema Reference**: [analytics-track.yaml](https://event-catalog.prod.otc.fts.d-3.de/schemas/analytics-track.yaml)
## Event-Specific Properties
This schema shows only the event-specific properties that extend the base TrackEvent schema:
## Raw Schema:schema.json
{
"title": "Event-Specific Properties",
"type": "object",
"description": "Properties specific to this event type (extends BaseEvent)",
"extends": "https://event-catalog.prod.otc.fts.d-3.de/schemas/analytics-track.yaml#/TrackEvent",
"eventType": "ExecuteRoutineWithRelativeURL",
"properties": {
"eventDefinitionId": {
"description": "Identifier of the event definition that triggered this routine",
"example": "documents_dvelop.documents.document.created.v1",
"type": "string"
},
"url": {
"description": "The relative URL endpoint called by the routine",
"example": "/api/myapp/webhook",
"type": "string"
},
"mappingCount": {
"description": "Number of JSONPath mapping entries configured on the routine",
"example": 3,
"minimum": 0,
"type": "integer"
},
"rulesCount": {
"description": "Number of top-level conditions in the routine's JSONLogic rules expression",
"example": 2,
"minimum": 0,
"type": "integer"
}
},
"components": {
"schemas": {
"ExecuteActionPayload": {
"allOf": [
{
"$ref": "https://event-catalog.prod.otc.fts.d-3.de/schemas/analytics-track.yaml#/TrackEvent"
},
{
"properties": {
"event": {
"const": "ExecuteAction"
},
"properties": {
"properties": {
"actionId": {
"description": "Unique identifier of the executed action",
"example": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
"type": "string"
},
"executionMode": {
"description": "Whether the action was executed synchronously or asynchronously",
"enum": [
"sync",
"async"
],
"example": "sync",
"type": "string"
},
"volatile": {
"description": "Whether the action is marked as volatile or long term stable",
"example": false,
"type": "boolean"
}
},
"type": "object"
}
},
"title": "Specific event properties",
"type": "object"
}
]
},
"ExecuteEventPayload": {
"allOf": [
{
"$ref": "https://event-catalog.prod.otc.fts.d-3.de/schemas/analytics-track.yaml#/TrackEvent"
},
{
"properties": {
"event": {
"const": "ExecuteEvent"
},
"properties": {
"properties": {
"eventDefinitionId": {
"description": "Composite identifier of the event definition that was received. Derived from CloudEvent headers in the format \"{appName}_{ceType}\".\n",
"example": "documents_dvelop.documents.document.created.v1",
"type": "string"
}
},
"type": "object"
}
},
"title": "Specific event properties",
"type": "object"
}
]
},
"ExecuteRoutineWithActionPayload": {
"allOf": [
{
"$ref": "https://event-catalog.prod.otc.fts.d-3.de/schemas/analytics-track.yaml#/TrackEvent"
},
{
"properties": {
"event": {
"const": "ExecuteRoutineWithAction"
},
"properties": {
"properties": {
"actionId": {
"description": "Unique identifier of the action invoked by this routine",
"example": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
"type": "string"
},
"eventDefinitionId": {
"description": "Identifier of the event definition that triggered this routine",
"example": "documents_dvelop.documents.document.created.v1",
"type": "string"
},
"mappingCount": {
"description": "Number of JSONPath mapping entries configured on the routine",
"example": 3,
"minimum": 0,
"type": "integer"
},
"rulesCount": {
"description": "Number of top-level conditions in the routine's JSONLogic rules expression",
"example": 2,
"minimum": 0,
"type": "integer"
}
},
"type": "object"
}
},
"title": "Specific event properties",
"type": "object"
}
]
},
"ExecuteRoutineWithRelativeURLPayload": {
"allOf": [
{
"$ref": "https://event-catalog.prod.otc.fts.d-3.de/schemas/analytics-track.yaml#/TrackEvent"
},
{
"properties": {
"event": {
"const": "ExecuteRoutineWithRelativeURL"
},
"properties": {
"properties": {
"eventDefinitionId": {
"description": "Identifier of the event definition that triggered this routine",
"example": "documents_dvelop.documents.document.created.v1",
"type": "string"
},
"mappingCount": {
"description": "Number of JSONPath mapping entries configured on the routine",
"example": 3,
"minimum": 0,
"type": "integer"
},
"rulesCount": {
"description": "Number of top-level conditions in the routine's JSONLogic rules expression",
"example": 2,
"minimum": 0,
"type": "integer"
},
"url": {
"description": "The relative URL endpoint called by the routine",
"example": "/api/myapp/webhook",
"type": "string"
}
},
"type": "object"
}
},
"title": "Specific event properties",
"type": "object"
}
]
}
}
}
}
---
id: analytics-platform
name: Analytics Platform - Analytics Events
version: 0.0.1
summary: "This AsyncAPI document describes analytics and tracking events related to the Analytics Platform application. These events are primarily used to analyze the use and development of the Analytics Platform. Essentially, certain log information from the Apache Superset analysis tool is used for this purpose."
sends:
- id: analytics-platform.ChartCreated
version: 1.0.0
to:
- id: analytics
- id: analytics-platform.DashboardViewed
version: 1.0.0
to:
- id: analytics
- id: analytics-platform.DashboardUpdated
version: 1.0.0
to:
- id: analytics
- id: analytics-platform.SqlLabQueryExecutionFailed
version: 1.0.0
to:
- id: analytics
- id: analytics-platform.ChartDataLoaded
version: 1.0.0
to:
- id: analytics
- id: analytics-platform.ChartDeleted
version: 1.0.0
to:
- id: analytics
- id: analytics-platform.DashboardDeleted
version: 1.0.0
to:
- id: analytics
- id: analytics-platform.ChartUnfavorited
version: 1.0.0
to:
- id: analytics
- id: analytics-platform.DashboardUnfavorited
version: 1.0.0
to:
- id: analytics
- id: analytics-platform.DatasetCreated
version: 1.0.0
to:
- id: analytics
- id: analytics-platform.SavedQueryCreated
version: 1.0.0
to:
- id: analytics
- id: analytics-platform.SqlLabQueryExecutionSucceeded
version: 1.0.0
to:
- id: analytics
- id: analytics-platform.ChartUpdated
version: 1.0.0
to:
- id: analytics
- id: analytics-platform.DashboardCreated
version: 1.0.0
to:
- id: analytics
- id: analytics-platform.DatasetDeleted
version: 1.0.0
to:
- id: analytics
- id: analytics-platform.ChartFavorited
version: 1.0.0
to:
- id: analytics
- id: analytics-platform.DashboardFavorited
version: 1.0.0
to:
- id: analytics
receives: []
---
# Analytics Platform - Analytics Events
This AsyncAPI document describes analytics and tracking events related to the Analytics Platform application.
These events are primarily used to analyze the use and development of the Analytics Platform.
Essentially, certain log information from the Apache Superset analysis tool is used for this purpose.
## Events Sent
- [analytics-platform.ChartCreated](/docs/events/analytics-platform.ChartCreated/1.0.0)
- [analytics-platform.DashboardViewed](/docs/events/analytics-platform.DashboardViewed/1.0.0)
- [analytics-platform.DashboardUpdated](/docs/events/analytics-platform.DashboardUpdated/1.0.0)
- [analytics-platform.SqlLabQueryExecutionFailed](/docs/events/analytics-platform.SqlLabQueryExecutionFailed/1.0.0)
- [analytics-platform.ChartDataLoaded](/docs/events/analytics-platform.ChartDataLoaded/1.0.0)
- [analytics-platform.ChartDeleted](/docs/events/analytics-platform.ChartDeleted/1.0.0)
- [analytics-platform.DashboardDeleted](/docs/events/analytics-platform.DashboardDeleted/1.0.0)
- [analytics-platform.ChartUnfavorited](/docs/events/analytics-platform.ChartUnfavorited/1.0.0)
- [analytics-platform.DashboardUnfavorited](/docs/events/analytics-platform.DashboardUnfavorited/1.0.0)
- [analytics-platform.DatasetCreated](/docs/events/analytics-platform.DatasetCreated/1.0.0)
- [analytics-platform.SavedQueryCreated](/docs/events/analytics-platform.SavedQueryCreated/1.0.0)
- [analytics-platform.SqlLabQueryExecutionSucceeded](/docs/events/analytics-platform.SqlLabQueryExecutionSucceeded/1.0.0)
- [analytics-platform.ChartUpdated](/docs/events/analytics-platform.ChartUpdated/1.0.0)
- [analytics-platform.DashboardCreated](/docs/events/analytics-platform.DashboardCreated/1.0.0)
- [analytics-platform.DatasetDeleted](/docs/events/analytics-platform.DatasetDeleted/1.0.0)
- [analytics-platform.ChartFavorited](/docs/events/analytics-platform.ChartFavorited/1.0.0)
- [analytics-platform.DashboardFavorited](/docs/events/analytics-platform.DashboardFavorited/1.0.0)
---
id: businessobjects
name: Business Objects - Analytics Events
version: 0.0.2
summary: "This AsyncAPI document describes analytics and tracking events related to the Business Objects application. These events are primarily used for lifecycle tracking and product usage analysis within the d.velop Analytics Platform."
sends:
- id: businessobjects.TenantComputedTierChanged
version: 1.0.0
to:
- id: analytics
- id: businessobjects.TenantDatabaseStatisticsBuilt
version: 1.0.0
to:
- id: analytics
- id: businessobjects.EntitySetQueryMetricsAggregated
version: 1.0.0
to:
- id: analytics
- id: businessobjects.AppSubscribed
version: 1.0.0
to:
- id: analytics
- id: businessobjects.AppPurgeReceived
version: 1.0.0
to:
- id: analytics
- id: businessobjects.DatabaseStatisticsBuilt
version: 1.0.0
to:
- id: analytics
- id: businessobjects.EntitySetStatisticsBuilt
version: 1.0.0
to:
- id: analytics
- id: businessobjects.AppResubscribed
version: 1.0.0
to:
- id: analytics
- id: businessobjects.AppUnsubscribed
version: 1.0.0
to:
- id: analytics
receives: []
---
# Business Objects - Analytics Events
This AsyncAPI document describes analytics and tracking events related to the Business Objects application.
These events are primarily used for lifecycle tracking and product usage analysis within the d.velop Analytics
Platform.
## Events Sent
- [businessobjects.TenantComputedTierChanged](/docs/events/businessobjects.TenantComputedTierChanged/1.0.0)
- [businessobjects.TenantDatabaseStatisticsBuilt](/docs/events/businessobjects.TenantDatabaseStatisticsBuilt/1.0.0)
- [businessobjects.EntitySetQueryMetricsAggregated](/docs/events/businessobjects.EntitySetQueryMetricsAggregated/1.0.0)
- [businessobjects.AppSubscribed](/docs/events/businessobjects.AppSubscribed/1.0.0)
- [businessobjects.AppPurgeReceived](/docs/events/businessobjects.AppPurgeReceived/1.0.0)
- [businessobjects.DatabaseStatisticsBuilt](/docs/events/businessobjects.DatabaseStatisticsBuilt/1.0.0)
- [businessobjects.EntitySetStatisticsBuilt](/docs/events/businessobjects.EntitySetStatisticsBuilt/1.0.0)
- [businessobjects.AppResubscribed](/docs/events/businessobjects.AppResubscribed/1.0.0)
- [businessobjects.AppUnsubscribed](/docs/events/businessobjects.AppUnsubscribed/1.0.0)
---
id: contextaction
name: Context Action UI Gateway - Analytics Events
version: 0.0.1
summary: "Describes the analytics and tracking events emitted by the Context Action UI Gateway (the context action menu micro-frontend), primarily used to analyze usage and feature adoption of context actions. Events are sent client-side via the in-app /contextaction/analytics/track endpoint, which forwards them to the d.velop Analytics Platform (DAP) using the RudderStack SDK."
sends:
- id: contextaction.ContextActionInvoked
version: 1.0.0
to:
- id: analytics
- id: contextaction.ContextActionMenuOpened
version: 1.0.0
to:
- id: analytics
- id: contextaction.ContextActionDmsObjectFetched
version: 1.0.0
to:
- id: analytics
- id: contextaction.ContextActionDialogDismissed
version: 1.0.0
to:
- id: analytics
- id: contextaction.ContextActionDialogPrimaryAction
version: 1.0.0
to:
- id: analytics
- id: contextaction.ContextActionDialogSecondaryAction
version: 1.0.0
to:
- id: analytics
receives: []
---
# Context Action UI Gateway - Analytics Events
Describes the analytics and tracking events emitted by the Context Action UI Gateway (the context action menu micro-frontend), primarily used to analyze usage and feature adoption of context actions. Events are sent client-side via the in-app /contextaction/analytics/track endpoint, which forwards them to the d.velop Analytics Platform (DAP) using the RudderStack SDK.
## Events Sent
- [contextaction.ContextActionInvoked](/docs/events/contextaction.ContextActionInvoked/1.0.0)
- [contextaction.ContextActionMenuOpened](/docs/events/contextaction.ContextActionMenuOpened/1.0.0)
- [contextaction.ContextActionDmsObjectFetched](/docs/events/contextaction.ContextActionDmsObjectFetched/1.0.0)
- [contextaction.ContextActionDialogDismissed](/docs/events/contextaction.ContextActionDialogDismissed/1.0.0)
- [contextaction.ContextActionDialogPrimaryAction](/docs/events/contextaction.ContextActionDialogPrimaryAction/1.0.0)
- [contextaction.ContextActionDialogSecondaryAction](/docs/events/contextaction.ContextActionDialogSecondaryAction/1.0.0)
---
id: dash
name: Dashboard-App - Analytics Events
version: 0.0.1
summary: "This AsyncAPI document describes analytics and tracking events related to the Dashboard-App. These events are primarily used to analyze the usage and development of the Dashboard-App."
sends:
- id: dash.WidgetAdded
version: 1.0.0
to:
- id: analytics
- id: dash.DashboardPublicAPIRequestReceived
version: 1.0.0
to:
- id: analytics
- id: dash.WidgetAPIV2Used
version: 1.0.0
to:
- id: analytics
- id: dash.TenantDashboardCreated
version: 1.0.0
to:
- id: analytics
- id: dash.DashboardEdited
version: 1.0.0
to:
- id: analytics
- id: dash.ResetAllCustomDashboards
version: 1.0.0
to:
- id: analytics
- id: dash.DashboardPublicAPIRequestSuccessful
version: 1.0.0
to:
- id: analytics
- id: dash.TenantDashboardDeleted
version: 1.0.0
to:
- id: analytics
- id: dash.NavigatedViaAppsMenu
version: 1.0.0
to:
- id: analytics
- id: dash.ResetUserDashboard
version: 1.0.0
to:
- id: analytics
- id: dash.DashboardMetricsCollected
version: 1.0.0
to:
- id: analytics
- id: dash.FavoritesUpdated
version: 1.0.0
to:
- id: analytics
- id: dash.WidgetRemoved
version: 1.0.0
to:
- id: analytics
- id: dash.EnableHomeAppChanged
version: 1.0.0
to:
- id: analytics
- id: dash.LegacyWidgetsConverted
version: 1.0.0
to:
- id: analytics
- id: dash.WidgetDeregistered
version: 1.0.0
to:
- id: analytics
- id: dash.NavigatedViaWidget
version: 1.0.0
to:
- id: analytics
- id: dash.WidgetSettingsUpdated
version: 1.0.0
to:
- id: analytics
- id: dash.DisableDashboardV2Changed
version: 1.0.0
to:
- id: analytics
- id: dash.WidgetRegistered
version: 1.0.0
to:
- id: analytics
- id: dash.WidgetV2ReplacedOnDashboards
version: 1.0.0
to:
- id: analytics
receives: []
---
# Dashboard-App - Analytics Events
This AsyncAPI document describes analytics and tracking events related to the Dashboard-App.
These events are primarily used to analyze the usage and development of the Dashboard-App.
## Events Sent
- [dash.WidgetAdded](/docs/events/dash.WidgetAdded/1.0.0)
- [dash.DashboardPublicAPIRequestReceived](/docs/events/dash.DashboardPublicAPIRequestReceived/1.0.0)
- [dash.WidgetAPIV2Used](/docs/events/dash.WidgetAPIV2Used/1.0.0)
- [dash.TenantDashboardCreated](/docs/events/dash.TenantDashboardCreated/1.0.0)
- [dash.DashboardEdited](/docs/events/dash.DashboardEdited/1.0.0)
- [dash.ResetAllCustomDashboards](/docs/events/dash.ResetAllCustomDashboards/1.0.0)
- [dash.DashboardPublicAPIRequestSuccessful](/docs/events/dash.DashboardPublicAPIRequestSuccessful/1.0.0)
- [dash.TenantDashboardDeleted](/docs/events/dash.TenantDashboardDeleted/1.0.0)
- [dash.NavigatedViaAppsMenu](/docs/events/dash.NavigatedViaAppsMenu/1.0.0)
- [dash.ResetUserDashboard](/docs/events/dash.ResetUserDashboard/1.0.0)
- [dash.DashboardMetricsCollected](/docs/events/dash.DashboardMetricsCollected/1.0.0)
- [dash.FavoritesUpdated](/docs/events/dash.FavoritesUpdated/1.0.0)
- [dash.WidgetRemoved](/docs/events/dash.WidgetRemoved/1.0.0)
- [dash.EnableHomeAppChanged](/docs/events/dash.EnableHomeAppChanged/1.0.0)
- [dash.LegacyWidgetsConverted](/docs/events/dash.LegacyWidgetsConverted/1.0.0)
- [dash.WidgetDeregistered](/docs/events/dash.WidgetDeregistered/1.0.0)
- [dash.NavigatedViaWidget](/docs/events/dash.NavigatedViaWidget/1.0.0)
- [dash.WidgetSettingsUpdated](/docs/events/dash.WidgetSettingsUpdated/1.0.0)
- [dash.DisableDashboardV2Changed](/docs/events/dash.DisableDashboardV2Changed/1.0.0)
- [dash.WidgetRegistered](/docs/events/dash.WidgetRegistered/1.0.0)
- [dash.WidgetV2ReplacedOnDashboards](/docs/events/dash.WidgetV2ReplacedOnDashboards/1.0.0)
---
id: dms-app
name: DMS App - Analytics Events
version: 0.0.1
summary: "Describes analytics and tracking events related to the DMS App (DMSApp), primarily used to analyze usage and feature development."
sends:
- id: dms-app.EditInOfficeClicked
version: 1.0.0
to:
- id: analytics
- id: dms-app.DocumentDownloaded
version: 1.0.0
to:
- id: analytics
- id: dms-app.NewVersionDialogCloseClicked
version: 1.0.0
to:
- id: analytics
- id: dms-app.NewVersionDialogSaveAndCloseClicked
version: 1.0.0
to:
- id: analytics
- id: dms-app.InnersupplyNavigateToClicked
version: 1.0.0
to:
- id: analytics
- id: dms-app.DocexUpdatePropertiesValidateClicked
version: 1.0.0
to:
- id: analytics
- id: dms-app.DocexUpdatePropertiesSaveClicked
version: 1.0.0
to:
- id: analytics
- id: dms-app.EditPropertiesClicked
version: 1.0.0
to:
- id: analytics
- id: dms-app.EditorChanged
version: 1.0.0
to:
- id: analytics
- id: dms-app.RegisterChanged
version: 1.0.0
to:
- id: analytics
- id: dms-app.LinkElementsClicked
version: 1.0.0
to:
- id: analytics
- id: dms-app.ExtensionContextActionClicked
version: 1.0.0
to:
- id: analytics
- id: dms-app.PropertiesFormCategorySelected
version: 1.0.0
to:
- id: analytics
- id: dms-app.DocexRegisterChanged
version: 1.0.0
to:
- id: analytics
- id: dms-app.DocexEditPropertiesClicked
version: 1.0.0
to:
- id: analytics
- id: dms-app.SubscriptionsClicked
version: 1.0.0
to:
- id: analytics
- id: dms-app.UnlinkElementsClicked
version: 1.0.0
to:
- id: analytics
- id: dms-app.DeleteDmsObjectLinkClicked
version: 1.0.0
to:
- id: analytics
- id: dms-app.CopyLinkToClipboard
version: 1.0.0
to:
- id: analytics
- id: dms-app.InnersupplyCancelClicked
version: 1.0.0
to:
- id: analytics
- id: dms-app.AlterationTextOkClicked
version: 1.0.0
to:
- id: analytics
- id: dms-app.AlterationTextCancelClicked
version: 1.0.0
to:
- id: analytics
- id: dms-app.PreviewFormatChanged
version: 1.0.0
to:
- id: analytics
- id: dms-app.VersionSelected
version: 1.0.0
to:
- id: analytics
- id: dms-app.ViewFullscreenToggled
version: 1.0.0
to:
- id: analytics
- id: dms-app.UploadClicked
version: 1.0.0
to:
- id: analytics
- id: dms-app.MarkSelectedClicked
version: 1.0.0
to:
- id: analytics
- id: dms-app.FavoriteClicked
version: 1.0.0
to:
- id: analytics
- id: dms-app.NewVersionFileSelectionCancelled
version: 1.0.0
to:
- id: analytics
- id: dms-app.InnersupplyCloseClicked
version: 1.0.0
to:
- id: analytics
- id: dms-app.DocumentStatusChanged
version: 1.0.0
to:
- id: analytics
- id: dms-app.OpenPreviewClicked
version: 1.0.0
to:
- id: analytics
- id: dms-app.DocexPropertiesFormTabClicked
version: 1.0.0
to:
- id: analytics
- id: dms-app.DocexPropertiesFormCategorySelected
version: 1.0.0
to:
- id: analytics
- id: dms-app.DocexDocumentDownloaded
version: 1.0.0
to:
- id: analytics
- id: dms-app.RefreshClicked
version: 1.0.0
to:
- id: analytics
- id: dms-app.DocumentDownloadClicked
version: 1.0.0
to:
- id: analytics
- id: dms-app.DViewClicked
version: 1.0.0
to:
- id: analytics
- id: dms-app.LinkedDmsObjectSelected
version: 1.0.0
to:
- id: analytics
- id: dms-app.DocumentDownloadDialogDismissed
version: 1.0.0
to:
- id: analytics
- id: dms-app.PropertiesFormTabClicked
version: 1.0.0
to:
- id: analytics
- id: dms-app.InnersupplyCheckPropertiesClicked
version: 1.0.0
to:
- id: analytics
- id: dms-app.NewVersionDialogCheckPropertiesClicked
version: 1.0.0
to:
- id: analytics
- id: dms-app.ShowInFolderClicked
version: 1.0.0
to:
- id: analytics
- id: dms-app.PersonalListsClicked
version: 1.0.0
to:
- id: analytics
- id: dms-app.DeleteClicked
version: 1.0.0
to:
- id: analytics
- id: dms-app.InnersupplySaveClicked
version: 1.0.0
to:
- id: analytics
- id: dms-app.NewVersionDialogSaveClicked
version: 1.0.0
to:
- id: analytics
- id: dms-app.NewVersionFileSelected
version: 1.0.0
to:
- id: analytics
- id: dms-app.DocexUpdatePropertiesCancelClicked
version: 1.0.0
to:
- id: analytics
- id: dms-app.OpenPerspectivesClicked
version: 1.0.0
to:
- id: analytics
- id: dms-app.BrowserPreviewUsed
version: 1.0.0
to:
- id: analytics
- id: dms-app.NoteCreated
version: 1.0.0
to:
- id: analytics
- id: dms-app.EditLocallyClicked
version: 1.0.0
to:
- id: analytics
- id: dms-app.DocexNewVersionDialogSaveClicked
version: 1.0.0
to:
- id: analytics
receives: []
---
# DMS App - Analytics Events
Describes analytics and tracking events related to the DMS App (DMSApp), primarily used to analyze usage and feature development.
## Events Sent
- [dms-app.EditInOfficeClicked](/docs/events/dms-app.EditInOfficeClicked/1.0.0)
- [dms-app.DocumentDownloaded](/docs/events/dms-app.DocumentDownloaded/1.0.0)
- [dms-app.NewVersionDialogCloseClicked](/docs/events/dms-app.NewVersionDialogCloseClicked/1.0.0)
- [dms-app.NewVersionDialogSaveAndCloseClicked](/docs/events/dms-app.NewVersionDialogSaveAndCloseClicked/1.0.0)
- [dms-app.InnersupplyNavigateToClicked](/docs/events/dms-app.InnersupplyNavigateToClicked/1.0.0)
- [dms-app.DocexUpdatePropertiesValidateClicked](/docs/events/dms-app.DocexUpdatePropertiesValidateClicked/1.0.0)
- [dms-app.DocexUpdatePropertiesSaveClicked](/docs/events/dms-app.DocexUpdatePropertiesSaveClicked/1.0.0)
- [dms-app.EditPropertiesClicked](/docs/events/dms-app.EditPropertiesClicked/1.0.0)
- [dms-app.EditorChanged](/docs/events/dms-app.EditorChanged/1.0.0)
- [dms-app.RegisterChanged](/docs/events/dms-app.RegisterChanged/1.0.0)
- [dms-app.LinkElementsClicked](/docs/events/dms-app.LinkElementsClicked/1.0.0)
- [dms-app.ExtensionContextActionClicked](/docs/events/dms-app.ExtensionContextActionClicked/1.0.0)
- [dms-app.PropertiesFormCategorySelected](/docs/events/dms-app.PropertiesFormCategorySelected/1.0.0)
- [dms-app.DocexRegisterChanged](/docs/events/dms-app.DocexRegisterChanged/1.0.0)
- [dms-app.DocexEditPropertiesClicked](/docs/events/dms-app.DocexEditPropertiesClicked/1.0.0)
- [dms-app.SubscriptionsClicked](/docs/events/dms-app.SubscriptionsClicked/1.0.0)
- [dms-app.UnlinkElementsClicked](/docs/events/dms-app.UnlinkElementsClicked/1.0.0)
- [dms-app.DeleteDmsObjectLinkClicked](/docs/events/dms-app.DeleteDmsObjectLinkClicked/1.0.0)
- [dms-app.CopyLinkToClipboard](/docs/events/dms-app.CopyLinkToClipboard/1.0.0)
- [dms-app.InnersupplyCancelClicked](/docs/events/dms-app.InnersupplyCancelClicked/1.0.0)
- [dms-app.AlterationTextOkClicked](/docs/events/dms-app.AlterationTextOkClicked/1.0.0)
- [dms-app.AlterationTextCancelClicked](/docs/events/dms-app.AlterationTextCancelClicked/1.0.0)
- [dms-app.PreviewFormatChanged](/docs/events/dms-app.PreviewFormatChanged/1.0.0)
- [dms-app.VersionSelected](/docs/events/dms-app.VersionSelected/1.0.0)
- [dms-app.ViewFullscreenToggled](/docs/events/dms-app.ViewFullscreenToggled/1.0.0)
- [dms-app.UploadClicked](/docs/events/dms-app.UploadClicked/1.0.0)
- [dms-app.MarkSelectedClicked](/docs/events/dms-app.MarkSelectedClicked/1.0.0)
- [dms-app.FavoriteClicked](/docs/events/dms-app.FavoriteClicked/1.0.0)
- [dms-app.NewVersionFileSelectionCancelled](/docs/events/dms-app.NewVersionFileSelectionCancelled/1.0.0)
- [dms-app.InnersupplyCloseClicked](/docs/events/dms-app.InnersupplyCloseClicked/1.0.0)
- [dms-app.DocumentStatusChanged](/docs/events/dms-app.DocumentStatusChanged/1.0.0)
- [dms-app.OpenPreviewClicked](/docs/events/dms-app.OpenPreviewClicked/1.0.0)
- [dms-app.DocexPropertiesFormTabClicked](/docs/events/dms-app.DocexPropertiesFormTabClicked/1.0.0)
- [dms-app.DocexPropertiesFormCategorySelected](/docs/events/dms-app.DocexPropertiesFormCategorySelected/1.0.0)
- [dms-app.DocexDocumentDownloaded](/docs/events/dms-app.DocexDocumentDownloaded/1.0.0)
- [dms-app.RefreshClicked](/docs/events/dms-app.RefreshClicked/1.0.0)
- [dms-app.DocumentDownloadClicked](/docs/events/dms-app.DocumentDownloadClicked/1.0.0)
- [dms-app.DViewClicked](/docs/events/dms-app.DViewClicked/1.0.0)
- [dms-app.LinkedDmsObjectSelected](/docs/events/dms-app.LinkedDmsObjectSelected/1.0.0)
- [dms-app.DocumentDownloadDialogDismissed](/docs/events/dms-app.DocumentDownloadDialogDismissed/1.0.0)
- [dms-app.PropertiesFormTabClicked](/docs/events/dms-app.PropertiesFormTabClicked/1.0.0)
- [dms-app.InnersupplyCheckPropertiesClicked](/docs/events/dms-app.InnersupplyCheckPropertiesClicked/1.0.0)
- [dms-app.NewVersionDialogCheckPropertiesClicked](/docs/events/dms-app.NewVersionDialogCheckPropertiesClicked/1.0.0)
- [dms-app.ShowInFolderClicked](/docs/events/dms-app.ShowInFolderClicked/1.0.0)
- [dms-app.PersonalListsClicked](/docs/events/dms-app.PersonalListsClicked/1.0.0)
- [dms-app.DeleteClicked](/docs/events/dms-app.DeleteClicked/1.0.0)
- [dms-app.InnersupplySaveClicked](/docs/events/dms-app.InnersupplySaveClicked/1.0.0)
- [dms-app.NewVersionDialogSaveClicked](/docs/events/dms-app.NewVersionDialogSaveClicked/1.0.0)
- [dms-app.NewVersionFileSelected](/docs/events/dms-app.NewVersionFileSelected/1.0.0)
- [dms-app.DocexUpdatePropertiesCancelClicked](/docs/events/dms-app.DocexUpdatePropertiesCancelClicked/1.0.0)
- [dms-app.OpenPerspectivesClicked](/docs/events/dms-app.OpenPerspectivesClicked/1.0.0)
- [dms-app.BrowserPreviewUsed](/docs/events/dms-app.BrowserPreviewUsed/1.0.0)
- [dms-app.NoteCreated](/docs/events/dms-app.NoteCreated/1.0.0)
- [dms-app.EditLocallyClicked](/docs/events/dms-app.EditLocallyClicked/1.0.0)
- [dms-app.DocexNewVersionDialogSaveClicked](/docs/events/dms-app.DocexNewVersionDialogSaveClicked/1.0.0)
---
id: docex
name: Documents Experience UI Gateway - Analytics Events
version: 0.0.1
summary: "Describes the analytics and tracking events emitted by the Documents Experience UI Gateway (the dv-docex-details micro-frontend), primarily used to analyze usage and feature adoption. Events are sent client-side via the in-app /docex/analytics/track endpoint, which forwards them to the d.velop Analytics Platform (DAP) using the RudderStack SDK."
sends:
- id: docex.DocumentStateChanged
version: 1.0.0
to:
- id: analytics
- id: docex.DocumentPreloaded
version: 1.0.0
to:
- id: analytics
- id: docex.DocumentOpened
version: 1.0.0
to:
- id: analytics
- id: docex.MimeTypeChanged
version: 1.0.0
to:
- id: analytics
- id: docex.NewVersionFileSelected
version: 1.0.0
to:
- id: analytics
- id: docex.NewVersionFileSelectionOpened
version: 1.0.0
to:
- id: analytics
- id: docex.NewVersionFileSelectionCancelled
version: 1.0.0
to:
- id: analytics
- id: docex.DetailsViewModeChanged
version: 1.0.0
to:
- id: analytics
receives: []
---
# Documents Experience UI Gateway - Analytics Events
Describes the analytics and tracking events emitted by the Documents Experience UI Gateway (the dv-docex-details micro-frontend), primarily used to analyze usage and feature adoption. Events are sent client-side via the in-app /docex/analytics/track endpoint, which forwards them to the d.velop Analytics Platform (DAP) using the RudderStack SDK.
## Events Sent
- [docex.DocumentStateChanged](/docs/events/docex.DocumentStateChanged/1.0.0)
- [docex.DocumentPreloaded](/docs/events/docex.DocumentPreloaded/1.0.0)
- [docex.DocumentOpened](/docs/events/docex.DocumentOpened/1.0.0)
- [docex.MimeTypeChanged](/docs/events/docex.MimeTypeChanged/1.0.0)
- [docex.NewVersionFileSelected](/docs/events/docex.NewVersionFileSelected/1.0.0)
- [docex.NewVersionFileSelectionOpened](/docs/events/docex.NewVersionFileSelectionOpened/1.0.0)
- [docex.NewVersionFileSelectionCancelled](/docs/events/docex.NewVersionFileSelectionCancelled/1.0.0)
- [docex.DetailsViewModeChanged](/docs/events/docex.DetailsViewModeChanged/1.0.0)
---
id: dvelop-actions
name: Actions - Analytics Events
version: 1.0.0
summary: "This AsyncAPI document describes analytics and tracking events emitted by the d.velop Actions service. These events are primarily used for usage tracking and product analysis within the d.velop Analytics Platform."
sends:
- id: dvelop-actions.ExecuteEvent
version: 1.0.0
to:
- id: analytics
- id: dvelop-actions.ExecuteRoutineWithAction
version: 1.0.0
to:
- id: analytics
- id: dvelop-actions.ExecuteRoutineWithRelativeURL
version: 1.0.0
to:
- id: analytics
- id: dvelop-actions.ExecuteAction
version: 1.0.0
to:
- id: analytics
receives: []
---
# Actions - Analytics Events
This AsyncAPI document describes analytics and tracking events emitted by the d.velop Actions service.
These events are primarily used for usage tracking and product analysis within the d.velop Analytics Platform.
## Events Sent
- [dvelop-actions.ExecuteEvent](/docs/events/dvelop-actions.ExecuteEvent/1.0.0)
- [dvelop-actions.ExecuteRoutineWithAction](/docs/events/dvelop-actions.ExecuteRoutineWithAction/1.0.0)
- [dvelop-actions.ExecuteRoutineWithRelativeURL](/docs/events/dvelop-actions.ExecuteRoutineWithRelativeURL/1.0.0)
- [dvelop-actions.ExecuteAction](/docs/events/dvelop-actions.ExecuteAction/1.0.0)
---
id: analytics
name: Analytics
version: 1.0.0
summary: |
Channel used for emitting analytics events, such as application subscription updates
---
## Overview
Channel used for emitting analytics events, such as application subscription updates
## Messages
This channel handles the following messages:
- [analytics-platform.ChartFavorited](/docs/services/analytics-platform/events/analytics-platform.ChartFavorited/1.0.0) - 1.0.0
- [analytics-platform.DashboardFavorited](/docs/services/analytics-platform/events/analytics-platform.DashboardFavorited/1.0.0) - 1.0.0
- [analytics-platform.ChartCreated](/docs/services/analytics-platform/events/analytics-platform.ChartCreated/1.0.0) - 1.0.0
- [analytics-platform.DashboardViewed](/docs/services/analytics-platform/events/analytics-platform.DashboardViewed/1.0.0) - 1.0.0
- [analytics-platform.DashboardUpdated](/docs/services/analytics-platform/events/analytics-platform.DashboardUpdated/1.0.0) - 1.0.0
- [analytics-platform.SqlLabQueryExecutionFailed](/docs/services/analytics-platform/events/analytics-platform.SqlLabQueryExecutionFailed/1.0.0) - 1.0.0
- [analytics-platform.ChartDataLoaded](/docs/services/analytics-platform/events/analytics-platform.ChartDataLoaded/1.0.0) - 1.0.0
- [analytics-platform.ChartDeleted](/docs/services/analytics-platform/events/analytics-platform.ChartDeleted/1.0.0) - 1.0.0
- [analytics-platform.DashboardDeleted](/docs/services/analytics-platform/events/analytics-platform.DashboardDeleted/1.0.0) - 1.0.0
- [analytics-platform.ChartUnfavorited](/docs/services/analytics-platform/events/analytics-platform.ChartUnfavorited/1.0.0) - 1.0.0
- [analytics-platform.DashboardUnfavorited](/docs/services/analytics-platform/events/analytics-platform.DashboardUnfavorited/1.0.0) - 1.0.0
- [analytics-platform.DatasetCreated](/docs/services/analytics-platform/events/analytics-platform.DatasetCreated/1.0.0) - 1.0.0
- [analytics-platform.SavedQueryCreated](/docs/services/analytics-platform/events/analytics-platform.SavedQueryCreated/1.0.0) - 1.0.0
- [analytics-platform.SqlLabQueryExecutionSucceeded](/docs/services/analytics-platform/events/analytics-platform.SqlLabQueryExecutionSucceeded/1.0.0) - 1.0.0
- [analytics-platform.ChartUpdated](/docs/services/analytics-platform/events/analytics-platform.ChartUpdated/1.0.0) - 1.0.0
- [analytics-platform.DashboardCreated](/docs/services/analytics-platform/events/analytics-platform.DashboardCreated/1.0.0) - 1.0.0
- [analytics-platform.DatasetDeleted](/docs/services/analytics-platform/events/analytics-platform.DatasetDeleted/1.0.0) - 1.0.0
- [businessobjects.TenantDatabaseStatisticsBuilt](/docs/services/businessobjects/events/businessobjects.TenantDatabaseStatisticsBuilt/1.0.0) - 1.0.0
- [businessobjects.EntitySetQueryMetricsAggregated](/docs/services/businessobjects/events/businessobjects.EntitySetQueryMetricsAggregated/1.0.0) - 1.0.0
- [businessobjects.AppSubscribed](/docs/services/businessobjects/events/businessobjects.AppSubscribed/1.0.0) - 1.0.0
- [businessobjects.AppPurgeReceived](/docs/services/businessobjects/events/businessobjects.AppPurgeReceived/1.0.0) - 1.0.0
- [businessobjects.DatabaseStatisticsBuilt](/docs/services/businessobjects/events/businessobjects.DatabaseStatisticsBuilt/1.0.0) - 1.0.0
- [businessobjects.EntitySetStatisticsBuilt](/docs/services/businessobjects/events/businessobjects.EntitySetStatisticsBuilt/1.0.0) - 1.0.0
- [businessobjects.AppResubscribed](/docs/services/businessobjects/events/businessobjects.AppResubscribed/1.0.0) - 1.0.0
- [businessobjects.AppUnsubscribed](/docs/services/businessobjects/events/businessobjects.AppUnsubscribed/1.0.0) - 1.0.0
- [businessobjects.TenantComputedTierChanged](/docs/services/businessobjects/events/businessobjects.TenantComputedTierChanged/1.0.0) - 1.0.0
- [contextaction.ContextActionInvoked](/docs/services/contextaction/events/contextaction.ContextActionInvoked/1.0.0) - 1.0.0
- [contextaction.ContextActionMenuOpened](/docs/services/contextaction/events/contextaction.ContextActionMenuOpened/1.0.0) - 1.0.0
- [contextaction.ContextActionDmsObjectFetched](/docs/services/contextaction/events/contextaction.ContextActionDmsObjectFetched/1.0.0) - 1.0.0
- [contextaction.ContextActionDialogDismissed](/docs/services/contextaction/events/contextaction.ContextActionDialogDismissed/1.0.0) - 1.0.0
- [contextaction.ContextActionDialogPrimaryAction](/docs/services/contextaction/events/contextaction.ContextActionDialogPrimaryAction/1.0.0) - 1.0.0
- [contextaction.ContextActionDialogSecondaryAction](/docs/services/contextaction/events/contextaction.ContextActionDialogSecondaryAction/1.0.0) - 1.0.0
- [dash.WidgetSettingsUpdated](/docs/services/dash/events/dash.WidgetSettingsUpdated/1.0.0) - 1.0.0
- [dash.DisableDashboardV2Changed](/docs/services/dash/events/dash.DisableDashboardV2Changed/1.0.0) - 1.0.0
- [dash.WidgetRegistered](/docs/services/dash/events/dash.WidgetRegistered/1.0.0) - 1.0.0
- [dash.WidgetV2ReplacedOnDashboards](/docs/services/dash/events/dash.WidgetV2ReplacedOnDashboards/1.0.0) - 1.0.0
- [dash.WidgetAdded](/docs/services/dash/events/dash.WidgetAdded/1.0.0) - 1.0.0
- [dash.DashboardPublicAPIRequestReceived](/docs/services/dash/events/dash.DashboardPublicAPIRequestReceived/1.0.0) - 1.0.0
- [dash.WidgetAPIV2Used](/docs/services/dash/events/dash.WidgetAPIV2Used/1.0.0) - 1.0.0
- [dash.TenantDashboardCreated](/docs/services/dash/events/dash.TenantDashboardCreated/1.0.0) - 1.0.0
- [dash.DashboardEdited](/docs/services/dash/events/dash.DashboardEdited/1.0.0) - 1.0.0
- [dash.ResetAllCustomDashboards](/docs/services/dash/events/dash.ResetAllCustomDashboards/1.0.0) - 1.0.0
- [dash.DashboardPublicAPIRequestSuccessful](/docs/services/dash/events/dash.DashboardPublicAPIRequestSuccessful/1.0.0) - 1.0.0
- [dash.TenantDashboardDeleted](/docs/services/dash/events/dash.TenantDashboardDeleted/1.0.0) - 1.0.0
- [dash.NavigatedViaAppsMenu](/docs/services/dash/events/dash.NavigatedViaAppsMenu/1.0.0) - 1.0.0
- [dash.ResetUserDashboard](/docs/services/dash/events/dash.ResetUserDashboard/1.0.0) - 1.0.0
- [dash.DashboardMetricsCollected](/docs/services/dash/events/dash.DashboardMetricsCollected/1.0.0) - 1.0.0
- [dash.FavoritesUpdated](/docs/services/dash/events/dash.FavoritesUpdated/1.0.0) - 1.0.0
- [dash.WidgetRemoved](/docs/services/dash/events/dash.WidgetRemoved/1.0.0) - 1.0.0
- [dash.EnableHomeAppChanged](/docs/services/dash/events/dash.EnableHomeAppChanged/1.0.0) - 1.0.0
- [dash.LegacyWidgetsConverted](/docs/services/dash/events/dash.LegacyWidgetsConverted/1.0.0) - 1.0.0
- [dash.WidgetDeregistered](/docs/services/dash/events/dash.WidgetDeregistered/1.0.0) - 1.0.0
- [dash.NavigatedViaWidget](/docs/services/dash/events/dash.NavigatedViaWidget/1.0.0) - 1.0.0
- [dms-app.InnersupplyCloseClicked](/docs/services/dms-app/events/dms-app.InnersupplyCloseClicked/1.0.0) - 1.0.0
- [dms-app.DocumentStatusChanged](/docs/services/dms-app/events/dms-app.DocumentStatusChanged/1.0.0) - 1.0.0
- [dms-app.OpenPreviewClicked](/docs/services/dms-app/events/dms-app.OpenPreviewClicked/1.0.0) - 1.0.0
- [dms-app.DocexPropertiesFormTabClicked](/docs/services/dms-app/events/dms-app.DocexPropertiesFormTabClicked/1.0.0) - 1.0.0
- [dms-app.DocexPropertiesFormCategorySelected](/docs/services/dms-app/events/dms-app.DocexPropertiesFormCategorySelected/1.0.0) - 1.0.0
- [dms-app.DocexDocumentDownloaded](/docs/services/dms-app/events/dms-app.DocexDocumentDownloaded/1.0.0) - 1.0.0
- [dms-app.RefreshClicked](/docs/services/dms-app/events/dms-app.RefreshClicked/1.0.0) - 1.0.0
- [dms-app.DocumentDownloadClicked](/docs/services/dms-app/events/dms-app.DocumentDownloadClicked/1.0.0) - 1.0.0
- [dms-app.DViewClicked](/docs/services/dms-app/events/dms-app.DViewClicked/1.0.0) - 1.0.0
- [dms-app.LinkedDmsObjectSelected](/docs/services/dms-app/events/dms-app.LinkedDmsObjectSelected/1.0.0) - 1.0.0
- [dms-app.DocumentDownloadDialogDismissed](/docs/services/dms-app/events/dms-app.DocumentDownloadDialogDismissed/1.0.0) - 1.0.0
- [dms-app.PropertiesFormTabClicked](/docs/services/dms-app/events/dms-app.PropertiesFormTabClicked/1.0.0) - 1.0.0
- [dms-app.InnersupplyCheckPropertiesClicked](/docs/services/dms-app/events/dms-app.InnersupplyCheckPropertiesClicked/1.0.0) - 1.0.0
- [dms-app.NewVersionDialogCheckPropertiesClicked](/docs/services/dms-app/events/dms-app.NewVersionDialogCheckPropertiesClicked/1.0.0) - 1.0.0
- [dms-app.ShowInFolderClicked](/docs/services/dms-app/events/dms-app.ShowInFolderClicked/1.0.0) - 1.0.0
- [dms-app.PersonalListsClicked](/docs/services/dms-app/events/dms-app.PersonalListsClicked/1.0.0) - 1.0.0
- [dms-app.DeleteClicked](/docs/services/dms-app/events/dms-app.DeleteClicked/1.0.0) - 1.0.0
- [dms-app.InnersupplySaveClicked](/docs/services/dms-app/events/dms-app.InnersupplySaveClicked/1.0.0) - 1.0.0
- [dms-app.NewVersionDialogSaveClicked](/docs/services/dms-app/events/dms-app.NewVersionDialogSaveClicked/1.0.0) - 1.0.0
- [dms-app.NewVersionFileSelected](/docs/services/dms-app/events/dms-app.NewVersionFileSelected/1.0.0) - 1.0.0
- [dms-app.DocexUpdatePropertiesCancelClicked](/docs/services/dms-app/events/dms-app.DocexUpdatePropertiesCancelClicked/1.0.0) - 1.0.0
- [dms-app.OpenPerspectivesClicked](/docs/services/dms-app/events/dms-app.OpenPerspectivesClicked/1.0.0) - 1.0.0
- [dms-app.BrowserPreviewUsed](/docs/services/dms-app/events/dms-app.BrowserPreviewUsed/1.0.0) - 1.0.0
- [dms-app.NoteCreated](/docs/services/dms-app/events/dms-app.NoteCreated/1.0.0) - 1.0.0
- [dms-app.EditLocallyClicked](/docs/services/dms-app/events/dms-app.EditLocallyClicked/1.0.0) - 1.0.0
- [dms-app.DocexNewVersionDialogSaveClicked](/docs/services/dms-app/events/dms-app.DocexNewVersionDialogSaveClicked/1.0.0) - 1.0.0
- [dms-app.EditInOfficeClicked](/docs/services/dms-app/events/dms-app.EditInOfficeClicked/1.0.0) - 1.0.0
- [dms-app.DocumentDownloaded](/docs/services/dms-app/events/dms-app.DocumentDownloaded/1.0.0) - 1.0.0
- [dms-app.NewVersionDialogCloseClicked](/docs/services/dms-app/events/dms-app.NewVersionDialogCloseClicked/1.0.0) - 1.0.0
- [dms-app.NewVersionDialogSaveAndCloseClicked](/docs/services/dms-app/events/dms-app.NewVersionDialogSaveAndCloseClicked/1.0.0) - 1.0.0
- [dms-app.InnersupplyNavigateToClicked](/docs/services/dms-app/events/dms-app.InnersupplyNavigateToClicked/1.0.0) - 1.0.0
- [dms-app.DocexUpdatePropertiesValidateClicked](/docs/services/dms-app/events/dms-app.DocexUpdatePropertiesValidateClicked/1.0.0) - 1.0.0
- [dms-app.DocexUpdatePropertiesSaveClicked](/docs/services/dms-app/events/dms-app.DocexUpdatePropertiesSaveClicked/1.0.0) - 1.0.0
- [dms-app.EditPropertiesClicked](/docs/services/dms-app/events/dms-app.EditPropertiesClicked/1.0.0) - 1.0.0
- [dms-app.EditorChanged](/docs/services/dms-app/events/dms-app.EditorChanged/1.0.0) - 1.0.0
- [dms-app.RegisterChanged](/docs/services/dms-app/events/dms-app.RegisterChanged/1.0.0) - 1.0.0
- [dms-app.LinkElementsClicked](/docs/services/dms-app/events/dms-app.LinkElementsClicked/1.0.0) - 1.0.0
- [dms-app.ExtensionContextActionClicked](/docs/services/dms-app/events/dms-app.ExtensionContextActionClicked/1.0.0) - 1.0.0
- [dms-app.PropertiesFormCategorySelected](/docs/services/dms-app/events/dms-app.PropertiesFormCategorySelected/1.0.0) - 1.0.0
- [dms-app.DocexRegisterChanged](/docs/services/dms-app/events/dms-app.DocexRegisterChanged/1.0.0) - 1.0.0
- [dms-app.DocexEditPropertiesClicked](/docs/services/dms-app/events/dms-app.DocexEditPropertiesClicked/1.0.0) - 1.0.0
- [dms-app.SubscriptionsClicked](/docs/services/dms-app/events/dms-app.SubscriptionsClicked/1.0.0) - 1.0.0
- [dms-app.UnlinkElementsClicked](/docs/services/dms-app/events/dms-app.UnlinkElementsClicked/1.0.0) - 1.0.0
- [dms-app.DeleteDmsObjectLinkClicked](/docs/services/dms-app/events/dms-app.DeleteDmsObjectLinkClicked/1.0.0) - 1.0.0
- [dms-app.CopyLinkToClipboard](/docs/services/dms-app/events/dms-app.CopyLinkToClipboard/1.0.0) - 1.0.0
- [dms-app.InnersupplyCancelClicked](/docs/services/dms-app/events/dms-app.InnersupplyCancelClicked/1.0.0) - 1.0.0
- [dms-app.AlterationTextOkClicked](/docs/services/dms-app/events/dms-app.AlterationTextOkClicked/1.0.0) - 1.0.0
- [dms-app.AlterationTextCancelClicked](/docs/services/dms-app/events/dms-app.AlterationTextCancelClicked/1.0.0) - 1.0.0
- [dms-app.PreviewFormatChanged](/docs/services/dms-app/events/dms-app.PreviewFormatChanged/1.0.0) - 1.0.0
- [dms-app.VersionSelected](/docs/services/dms-app/events/dms-app.VersionSelected/1.0.0) - 1.0.0
- [dms-app.ViewFullscreenToggled](/docs/services/dms-app/events/dms-app.ViewFullscreenToggled/1.0.0) - 1.0.0
- [dms-app.UploadClicked](/docs/services/dms-app/events/dms-app.UploadClicked/1.0.0) - 1.0.0
- [dms-app.MarkSelectedClicked](/docs/services/dms-app/events/dms-app.MarkSelectedClicked/1.0.0) - 1.0.0
- [dms-app.FavoriteClicked](/docs/services/dms-app/events/dms-app.FavoriteClicked/1.0.0) - 1.0.0
- [dms-app.NewVersionFileSelectionCancelled](/docs/services/dms-app/events/dms-app.NewVersionFileSelectionCancelled/1.0.0) - 1.0.0
- [docex.DetailsViewModeChanged](/docs/services/docex/events/docex.DetailsViewModeChanged/1.0.0) - 1.0.0
- [docex.DocumentStateChanged](/docs/services/docex/events/docex.DocumentStateChanged/1.0.0) - 1.0.0
- [docex.DocumentPreloaded](/docs/services/docex/events/docex.DocumentPreloaded/1.0.0) - 1.0.0
- [docex.DocumentOpened](/docs/services/docex/events/docex.DocumentOpened/1.0.0) - 1.0.0
- [docex.MimeTypeChanged](/docs/services/docex/events/docex.MimeTypeChanged/1.0.0) - 1.0.0
- [docex.NewVersionFileSelected](/docs/services/docex/events/docex.NewVersionFileSelected/1.0.0) - 1.0.0
- [docex.NewVersionFileSelectionOpened](/docs/services/docex/events/docex.NewVersionFileSelectionOpened/1.0.0) - 1.0.0
- [docex.NewVersionFileSelectionCancelled](/docs/services/docex/events/docex.NewVersionFileSelectionCancelled/1.0.0) - 1.0.0
- [dvelop-actions.ExecuteRoutineWithAction](/docs/services/dvelop-actions/events/dvelop-actions.ExecuteRoutineWithAction/1.0.0) - 1.0.0
- [dvelop-actions.ExecuteRoutineWithRelativeURL](/docs/services/dvelop-actions/events/dvelop-actions.ExecuteRoutineWithRelativeURL/1.0.0) - 1.0.0
- [dvelop-actions.ExecuteAction](/docs/services/dvelop-actions/events/dvelop-actions.ExecuteAction/1.0.0) - 1.0.0
- [dvelop-actions.ExecuteEvent](/docs/services/dvelop-actions/events/dvelop-actions.ExecuteEvent/1.0.0) - 1.0.0
## Operations
- sendChartUpdated
- sendDashboardViewed
- sendSqlLabQueryExecutionSucceeded
- sendChartCreated
- sendChartFavorited
- sendSavedQueryCreated
- sendSqlLabQueryExecutionFailed
- sendChartDataLoaded
- sendChartDeleted
- sendDashboardCreated
- sendDatasetCreated
- sendDashboardUpdated
- sendDashboardDeleted
- sendChartUnfavorited
- sendDashboardFavorited
- sendDashboardUnfavorited
- sendDatasetDeleted
- sendEntitySetQueryMetricsAggregated
- sendAppUnsubscribed
- sendTenantComputedTierChanged
- sendEntitySetStatisticsBuilt
- sendAppSubscribed
- sendAppResubscribed
- sendAppPurgeReceived
- sendDatabaseStatisticsBuilt
- sendTenantDatabaseStatisticsBuilt
- sendContextActionInvoked
- sendContextActionMenuOpened
- sendContextActionDmsObjectFetched
- sendContextActionDialogDismissed
- sendContextActionDialogPrimaryAction
- sendContextActionDialogSecondaryAction
- sendWidgetRemoved
- sendDashboardPublicAPIRequestReceived
- sendLegacyWidgetsConverted
- sendWidgetAPIV2Used
- sendResetAllCustomDashboards
- sendDashboardMetricsCollected
- sendDashboardPublicAPIRequestSuccessful
- sendTenantDashboardCreated
- sendDisableDashboardV2Changed
- sendEnableHomeAppChanged
- sendWidgetV2ReplacedOnDashboards
- sendResetUserDashboard
- sendWidgetAdded
- sendWidgetSettingsUpdated
- sendTenantDashboardDeleted
- sendWidgetRegistered
- sendWidgetDeregistered
- sendFavoritesUpdated
- sendNavigatedViaAppsMenu
- sendNavigatedViaWidget
- sendDashboardEdited
- sendDocumentDownloadDialogDismissed
- sendNewVersionDialogCloseClicked
- sendDocexRegisterChanged
- sendDocexEditPropertiesClicked
- sendDocexUpdatePropertiesSaveClicked
- sendRegisterChanged
- sendShowInFolderClicked
- sendDocumentDownloaded
- sendInnersupplyCloseClicked
- sendInnersupplyNavigateToClicked
- sendDocexNewVersionDialogSaveClicked
- sendDocexDocumentDownloaded
- sendBrowserPreviewUsed
- sendOpenPerspectivesClicked
- sendOpenPreviewClicked
- sendUploadClicked
- sendEditLocallyClicked
- sendPropertiesFormTabClicked
- sendVersionSelected
- sendDeleteClicked
- sendEditInOfficeClicked
- sendNewVersionDialogSaveClicked
- sendAlterationTextCancelClicked
- sendRefreshClicked
- sendPersonalListsClicked
- sendMarkSelectedClicked
- sendLinkedDmsObjectSelected
- sendPropertiesFormCategorySelected
- sendAlterationTextOkClicked
- sendDocexPropertiesFormCategorySelected
- sendEditPropertiesClicked
- sendViewFullscreenToggled
- sendDocumentStatusChanged
- sendDocumentDownloadClicked
- sendInnersupplyCancelClicked
- sendInnersupplySaveClicked
- sendNewVersionFileSelected
- sendDocexUpdatePropertiesValidateClicked
- sendSubscriptionsClicked
- sendFavoriteClicked
- sendExtensionContextActionClicked
- sendInnersupplyCheckPropertiesClicked
- sendNewVersionDialogSaveAndCloseClicked
- sendDocexPropertiesFormTabClicked
- sendDocexUpdatePropertiesCancelClicked
- sendNoteCreated
- sendPreviewFormatChanged
- sendUnlinkElementsClicked
- sendDViewClicked
- sendDeleteDmsObjectLinkClicked
- sendCopyLinkToClipboard
- sendNewVersionDialogCheckPropertiesClicked
- sendNewVersionFileSelectionCancelled
- sendEditorChanged
- sendLinkElementsClicked
- sendDetailsViewModeChanged
- sendDocumentStateChanged
- sendDocumentPreloaded
- sendDocumentOpened
- sendMimeTypeChanged
- sendNewVersionFileSelectionOpened
- sendExecuteEvent
- sendExecuteRoutineWithAction
- sendExecuteRoutineWithRelativeURL
- sendExecuteAction
## Server Endpoints
- **dap_cdp**