IPluggableAppTelemetryEventData

Home > @gooddata/sdk-pluggable-application-model > IPluggableAppTelemetryEventData

IPluggableAppTelemetryEventData interface

This API is provided as an alpha preview for developers and may change based on feedback that we receive. Do not use this API in a production environment.

Transport-neutral structured data a pluggable application may attach to a telemetry event.

Signature:

export interface IPluggableAppTelemetryEventData 

Remarks

Pluggable applications describe an event with these neutral groups and must NOT assume any particular analytics backend (Matomo, Amplitude, …) — the host shell decides how to record them. identifiers are sensitive entity ids (workspace, dashboard, report, …) the shell may hash and aggregate; stats are contextual metrics (counts, types, …). Any other key is a free-form event property. Passed as the data argument of IPluggableAppTelemetryCallbacks.trackEvent.

Properties

Property	Modifiers	Type	Description
identifiers?		Record<string, string>	(ALPHA) (Optional) Sensitive entity identifiers for the event (e.g. { workspaceId, dashboardId }). The shell decides how to record them — modules must not hash, pack or otherwise format them for a specific backend.
stats?		Record<string, string | number | boolean>	(ALPHA) (Optional) Contextual metrics / stats for the event (e.g. { insightsCount, attributeFiltersCount }).