class documentation
class TelemetryEvent:
Constructor: TelemetryEvent.create(name, properties, context, distinct_id, ...)
Represents a single telemetry event.
| Class Method | create |
Create a telemetry event with a UTC timestamp. |
| Method | to |
Serialize the event into a JSON-friendly dict. |
| Class Variable | context |
Undocumented |
| Class Variable | distinct |
Undocumented |
| Class Variable | name |
Undocumented |
| Class Variable | properties |
Undocumented |
| Class Variable | schema |
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:str | Event name. |
properties:dict[ | Event properties after sanitization. |
context:dict[ | Merged context to attach to the event. |
distinctstr | None | Optional backend identity override. |
schemaint | Event schema version. |
| Returns | |
TelemetryEvent | A telemetry event with a UTC timestamp. |