Ingest telemetry events
POST /v1/events
Ingest a batch of telemetry events from a game SDK.
The request body must be a Protobuf-encoded framedash.v1.TelemetryBatch
message (proto3), sent with Content-Type: application/x-protobuf.
Optional gzip compression is supported via Content-Encoding: gzip.
For the full proto3 schema, a raw curl example, and end-to-end sending
guidance, see the
Direct HTTP ingestion
guide.
Custom senders should keep the HTTP request body as sent (after gzip
compression, if used) at or below 126,000 bytes; larger production ingest
bodies are rejected with 413. Each decoded event
must also satisfy the telemetry data model limits: timestamp_us within
the last 30 days and no more than 48 hours in the future, non-empty
event_name and session_id, bounded string/map fields, finite numeric
metrics, and valid camera pairs. Official SDKs clamp these values
client-side before flushing.
Required headers:
X-API-Key— API key with theevents:writescopeContent-Type: application/x-protobufContent-Length— must match actual body sizeX-SDK-Version— SDK version identifier
This endpoint is served by the Ingest Worker, separate from the Web API.
Authorizations
Section titled “Authorizations ”Parameters
Section titled “ Parameters ”Header Parameters
Section titled “Header Parameters ”Set to gzip if the body is gzip-compressed.
SDK version identifier (e.g., unity-1.2.0).
Request Body required
Section titled “Request Body required ”Protobuf-encoded TelemetryBatch.
Responses
Section titled “ Responses ”Events accepted for processing.
object
Invalid payload or missing required headers.
object
Human-readable error message.
Missing API key.
object
Human-readable error message.
Invalid API key or insufficient permissions.
object
Human-readable error message.
Content-Length header is required.
object
Human-readable error message.
Payload exceeds maximum size.
object
Human-readable error message.
Unsupported Content-Type or Content-Encoding.
object
Human-readable error message.
Rate limit or monthly event budget exceeded.
object
Human-readable error message.