Playground

Playground

AppEvent

/api/v1/telemetry/app-events

A telemetry event emitted by an Application.

listgetemit

Schema

FieldTypeNotes
id*uuidServer-assigned ULID with type prefix (e.g. per_…).
tenant_id*stringTenant scope — auto-stamped from the caller's JWT.
app_idstringApp scope. Stamped ONLY when the caller's JWT was minted for a specific Application (integration API keys). Absent for human-user sessions. Filters reads when present.
created_at*date-timeServer stamp.
updated_at*date-timeServer stamp; updated on every patch.
created_byuuidPerson id from the caller's JWT (sub).
updated_byuuidPerson id from the last writer's JWT (sub).
sourcestringProvenance tag — defaults to 'edm'.
source_typeenumfrontend | backend | server | system | apiWhere the write originated. Defaults to 'api'.
is_deletedbooleanSoft-delete flag. Excluded from default list queries.
deleted_atdate-timeStamped when soft-deleted; null otherwise.
deleted_byuuidPerson id who soft-deleted; null otherwise.
schema_versionnumberDocument schema version. Bumped on incompatible writes.
user_idstringIdentifier of the user who triggered the event. Null for anonymous events.
session_idstringBrowser or client session identifier.
event_typestringName of the event (e.g. 'page_view', 'record_create', 'search_query', 'rfp_response_approved').
event_categorystringBroad category grouping for the event.
entity_typestringEDM entity type of the target entity, if this event targets a specific resource.
entity_idstringIdentifier of the target entity, if applicable.
propertiesjsonFree-form event-specific properties (key-value pairs). Structure is determined by the emitting app.
page_urlstringFull URL of the page where the event occurred.
referrer_urlstringReferrer URL if the user navigated from another page.
user_agentstringUser-Agent string of the originating HTTP client.
ipstringIP address of the originating client, truncated or anonymised per tenant policy.
geojsonGeo-location derived from the source IP. Populated by the pipeline.
devicejsonDevice information parsed from the User-Agent string.
tsdate-timeISO 8601 UTC timestamp of when the event occurred.

API

Loading manifest…