Menu
Platform
AI
Analytics
App store purchases
Credits
Database
Flags
Generated Assets
Monitoring
Notifications
Organizations
Payments
- Payments
- Payments quickstart
- Checkout policies
- Checkout sessions
- Customer subscriptions
- Entitlement grants
- Exchange rates
- Licence keys
- Licence tokens
- Merchant accounts
- Portal sessions
- Price catalogs
- Revenue
- Revenue facts
- Revenue sources
- Tax threshold statuses
- Usage events
- Usage invoices
- Usage meter prices
- Usage meters
- Usage reservations
- Usage settings
- Usage tiers
Queues
Realtime
Sandboxes
Webhooks
Getting Started
Authentication
KV Store
Deploy & Infrastructure
Reference
List analytics events
Lists the environment's raw events in a time range, newest first.
Lists the environment's raw events in a time range, newest first.
Not available yet. Sylphx Analytics is declared in the registry but no backend serves it: every call answers 501 with the problem code UNIMPLEMENTED.
- Path
GET https://api.sylphx.com/v1/orgs/acme/projects/shop/envs/production/analytics_events - Scope
analytics:read - Effect
read— nothing is written. - Collection analytics_events
- Query
start_time,end_time,event_name,subject_id,page_size,page_token - Pagination the answer carries
analytics_eventsand, when there is more,next_page_token
#Request
| Field | Type | What it is |
|---|---|---|
parent | string | The parent to list in. Required. |
start_time | timestamp | The interval start; required, at most 31 days before end_time. Required. |
end_time | timestamp | The interval end; default now. |
event_name | string | Only events with this name. |
subject_id | string | Only events of this subject (the user id, else the anon id). |
page_size | int32 | At most this many; default 100, clamped to 1000. |
page_token | string | next_page_token of the previous page; bound to the tenant, interval and filters. |
#Response
| Field | Type | What it is |
|---|---|---|
analytics_events | AnalyticsEvent[] | The page. |
next_page_token | string | The token of the next page; empty on the last page. |
#AnalyticsEvent
| Field | Type | What it is |
|---|---|---|
name | string | orgs/{org}/projects/{project}/envs/{env}/analytics_events/{event_id}. |
uid | string | The event id again, so a client can hold it without parsing the name. Output only. |
meta | ResourceMeta | Resource metadata. |
event_name | string | The event name, for example $pageview. Output only. |
event_time | timestamp | When it happened, on the sender's clock (corrected by sent_time). Output only. |
received_time | timestamp | When the service received it. Output only. |
anon_id | string | The device- or install-scoped id from the SDK. Output only. |
user_id | string | The signed-in end user, when known. Output only. |
session_id | string | The SDK session, when there is one. Output only. |
properties | struct | The event's properties. Output only. |
context | EventContext | The 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. |
source | EventSource | Where the event came from. Output only. One of client, server. |
#ResourceMeta
| Field | Type | What it is |
|---|---|---|
generation | int64 | Increases by one on every change to spec. Output only. |
etag | string | Strong ETag (AIP-154): changes on any change to spec, status, or metadata. Send it back as If-Match or etag to make Update and Delete conditional; a mismatch fails with ABORTED / 409 ETAG_MISMATCH. Output only. |
create_time | timestamp | When the Resource was created. Output only. |
update_time | timestamp | When the Resource last changed. Output only. |
delete_time | timestamp | Set while the Resource is being deleted. Output only. |
labels | map<string, string> | Caller-writable, indexed labels (AIP-122 label rules). |
annotations | map<string, string> | Caller-writable, unindexed annotations. |
display_name | string | Caller-writable human-readable name. |
creator | string | The principal that created the Resource. Output only. |
#EventContext
| Field | Type | What it is |
|---|---|---|
sdk_name | string | The SDK, for example @sylphx/sdk. |
sdk_version | string | The SDK version. |
platform | string | web, ios, android, unity, server,... |
app_version | string | The app's own version. |
locale | string | A BCP 47 locale, for example zh-HK. |
browser | string | The browser family, for example Chrome; filled by the service from the request, and ignored when a client sends it. Output only. |
os | string | The operating system family, for example Windows; filled by the service. Output only. |
experiments | map<string, string> | The experiments the subject is in when the event happens: experiment key to variant key, at most 20 entries. |
#Errors
UNAUTHENTICATED— No valid key or token was presented.PERMISSION_DENIED— The key lacks the method's permission.INVALID_FIELD— A field failed validation.PAGE_TOKEN_MISMATCH— A page token was reused with different parameters.
Every error arrives in the body Errors describes.
#Examples
curl "https://api.sylphx.com/v1/orgs/acme/projects/shop/envs/production/analytics_events" \
-H "Authorization: Bearer $SYLPHX_API_KEY"