Skip to main content
This endpoint accepts client-side usage statistics rollups. It enforces a strict aggregate-only whitelist to ensure no cleartext memory contents or PII can ever be sent to the database.
Session JWT RequiredThis endpoint requires a WorkOS AuthKit session JWT.

1. Submit Telemetry Report

Push a daily rollup of numeric counters to the platform.

Request Body Schema

The request must contain only the following whitelist fields. Extra fields are rejected immediately to protect privacy.

Example Request Body


Processing Gates

  1. Opt-In Enforcement: The server retrieves the user’s dashboard settings. If telemetry_opt_in is not explicitly true, the write is rejected with 403 telemetry_disabled.
  2. Strict Whitelisting: If the request contains any keys outside the whitelist (e.g. memory_contents, metadata), it is rejected with 400 non_aggregate_field.
  3. Postgres Upsert: Statistics are upserted into the database. A unique constraint on (user_id, window_start) aggregates inputs to a single row per day.

Response Schema (201 Created)