コンテンツにスキップ

Ingest telemetry events

POST
/v1/events

Ingest a batch of telemetry events from a game SDK. The request body must be a Protobuf-encoded TelemetryBatch. Optional gzip compression is supported via Content-Encoding: gzip.

Required headers:

  • X-API-Key — write or CI API key
  • Content-Type: application/x-protobuf
  • Content-Length — must match actual body size
  • X-SDK-Version — SDK version identifier

This endpoint is served by the Ingest Worker, separate from the Web API.

Content-Encoding
string
Allowed values: gzip

Set to gzip if the body is gzip-compressed.

X-SDK-Version
required
string

SDK version identifier (e.g., unity-1.2.0).

Protobuf-encoded TelemetryBatch.

string format: binary

Events accepted for processing.

object
status
string
Allowed values: accepted

Invalid payload or missing required headers.

object
error

Human-readable error message.

string

Missing API key.

object
error

Human-readable error message.

string

Invalid API key or insufficient permissions.

object
error

Human-readable error message.

string

Content-Length header is required.

object
error

Human-readable error message.

string

Payload exceeds maximum size.

object
error

Human-readable error message.

string

Unsupported Content-Type or Content-Encoding.

object
error

Human-readable error message.

string

Rate limit or monthly event budget exceeded.

object
error

Human-readable error message.

string