Skip to content
Console
Menu

Getting Started

Authentication

KV Store

Analytics events

An Analytics Event is one immutable thing a person or a game did, recorded by an SDK or a server.

An Analytics Event is one immutable thing a person or a game did, recorded by an SDK or a server. Its id is the sender's event_id, so a resend of the same event is the same record.

Service Sylphx Analytics · Resource type analytics.sylphx.com/AnalyticsEvent · Name pattern orgs/{org}/projects/{project}/envs/{env}/analytics_events/{analytics_event} · Shape record

Not available yet. Sylphx Analytics is declared in the registry but no backend serves it: every call answers 501 with the problem code UNIMPLEMENTED.

#Fields

FieldTypeWhat it is
namestringorgs/{org}/projects/{project}/envs/{env}/analytics_events/{event_id}.
uidstringThe event id again, so a client can hold it without parsing the name. Output only.
metaResourceMetaResource metadata.
event_namestringThe event name, for example $pageview. Output only.
event_timetimestampWhen it happened, on the sender's clock (corrected by sent_time). Output only.
received_timetimestampWhen the service received it. Output only.
anon_idstringThe device- or install-scoped id from the SDK. Output only.
user_idstringThe signed-in end user, when known. Output only.
session_idstringThe SDK session, when there is one. Output only.
propertiesstructThe event's properties. Output only.
contextEventContextThe sender's context, plus the platform and browser family the service parsed from the request. No IP address and no user agent string is kept. Output only.
sourceEventSourceWhere the event came from. Output only. One of client, server.

#Methods

Every method of the collection, in the registry's order, with the scope it needs. The full request, response and examples are one link away.

MethodCallWhat it does
POSTbatchRecords a batch of events. Each event is judged alone: a bad event is reported in results and the rest are stored. A duplicate event_id (in this or an earlier batch) is counted once. The response is sent only after the store holds the accepted events.
GETlistLists the environment's raw events in a time range, newest first.

#batch

Records a batch of events. Each event is judged alone: a bad event is reported in results and the rest are stored. A duplicate event_id (in this or an earlier batch) is counted once. The response is sent only after the store holds the accepted events.

POST https://api.sylphx.com/v1/orgs/acme/projects/shop/envs/production/analytics_events:batch · scope analytics:ingest · effect write · not available yet · callable with a publishable key · Request, response and examples

#list

Lists the environment's raw events in a time range, newest first.

GET https://api.sylphx.com/v1/orgs/acme/projects/shop/envs/production/analytics_events · scope analytics:read · effect read · not available yet · paginated · Request, response and examples