Signal Cloud Events and Analytics
The published API separates tenant-scoped event exploration from projection-backed analytics and reports. Each operation is protected by the authenticated Console session and lists its own permission requirements.
Explore events
GET /v1/events returns the event explorer by default. The explorer requires an inclusive occurred_from time and an exclusive occurred_to time. Set view=live to use the live polling projection instead. Event type, server, server instance, mission, and participant filters are described in the operation schema.
For a first read, use the host and authorized signal_session from your deployment, provide both explorer range values, and leave optional filters out. A 200 explorer response contains events and a page object with snapshot_at and next_cursor. An empty array is still a successful query when no events match the chosen range. In live view, the response instead contains events and a live object with cursor, has_more, and poll_after_ms.
The API also publishes event detail and filter-value operations. Review their parameter and response schemas in the API reference before building a client.
Read analytics
The contract includes community activity analytics, player-session analytics, and a community activity PDF report. These endpoints are described as projection-backed and require analytics.read. The GET /v1/analytics/activity first read requires from, to, and scope=community. Its response includes the selected range, summary, buckets, and freshness labels (fresh, delayed, or stale) so a client can report how current the projection is.
Troubleshooting
- For a
400, check the operation's required time values,scope, and filter formats. - For a
403, confirm the operation's permission and ask the deployment administrator if the authorized session lacks it. - If an event query succeeds but returns no matching events, check the selected range and filters. This read-only contract does not diagnose event ingestion or adapter health.
- For analytics, use the response's
freshnessfields when explaining delayed or stale projections; do not present the report as real-time data.
Limits of this guide
This document covers reading and reporting. The OpenAPI description explicitly excludes event ingestion and adapter recovery. It does not define how events reach the Cloud or how an installation should configure an adapter.