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
sylphx analytics analytics_events
Every sylphx analytics analytics_events command: its argument, its flags and a run line.
The analytics_events commands of Sylphx Analytics, as the CLI spells them: the same
calls as the analytics_events API page, typed for the
shell. Install, sign in and the grammar are on the CLI index.
Not available yet. Sylphx Analytics is declared in the registry but no backend serves it: every command answers 501 with the problem code UNIMPLEMENTED.
#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.
NAME — the resource's name; a bare id is enough below the linked
project.
CLI
sylphx analytics analytics-events batch orgs/acme/projects/shop/envs/productionPOST https://api.sylphx.com/v1/orgs/acme/projects/shop/envs/production/analytics_events:batch · scope analytics:ingest · effect write · Request, response and examples
Flags
| Flag | Type | What it does |
|---|---|---|
--events | json | The events, 1 to 500. Required. Repeat the flag for each value. |
--sent-time | timestamp | When the sender built the batch, on its clock. When it differs from the receive time by more than 10 minutes, every event time is shifted by the difference. |
--consent | enum | The app's current analytics consent; events are stored only when GRANTED. A publishable-key batch that is not GRANTED has every event rejected consent_not_granted (still 200, nothing stored). A secret-key batch with UNSPECIFIED counts as granted (the tenant's server attests); DENIED is always refused. One of granted, denied. |
#list
Lists the environment's raw events in a time range, newest first.
PARENT — optional: the CLI fills it from the linked project or the
key's scope when it is left out.
CLI
sylphx analytics analytics-events list orgs/acme/projects/shop/envs/productionGET https://api.sylphx.com/v1/orgs/acme/projects/shop/envs/production/analytics_events · scope analytics:read · effect read · Request, response and examples
Flags
| Flag | Type | What it does |
|---|---|---|
--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 | int | 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. |