class documentation

Represents a single telemetry event.

Class Method create Create a telemetry event with a UTC timestamp.
Method to_payload Serialize the event into a JSON-friendly dict.
Class Variable context Undocumented
Class Variable distinct_id Undocumented
Class Variable name Undocumented
Class Variable properties Undocumented
Class Variable schema_version Undocumented
Class Variable timestamp Undocumented
@classmethod
def create(cls, *, name: str, properties: dict[str, Any], context: dict[str, Any], distinct_id: str | None = None, schema_version: int = 1) -> TelemetryEvent:

Create a telemetry event with a UTC timestamp.

Parameters
name:strEvent name.
properties:dict[str, Any]Event properties after sanitization.
context:dict[str, Any]Merged context to attach to the event.
distinct_id:str | NoneOptional backend identity override.
schema_version:intEvent schema version.
Returns
TelemetryEventA telemetry event with a UTC timestamp.
def to_payload(self) -> dict[str, Any]:

Serialize the event into a JSON-friendly dict.

context: dict[str, Any] =

Undocumented

distinct_id: str | None =

Undocumented

name: str =

Undocumented

properties: dict[str, Any] =

Undocumented

schema_version: int =

Undocumented

timestamp: datetime =

Undocumented