Get series or puzzle specific aggregate metrics

GET 
/api/v2/reporting

Fetches aggregated analytics data over a specified time range, grouped by one or more dimensions. The reporting system is designed around two types of data: loads (when a puzzle is loaded) and plays (when a user interacts with a puzzle). You must choose dimensions and metrics that belong to the same category.

Request

Responses

200

A JSON object containing the requested metrics, grouped by the specified dimensions.

400

Bad request. Possible errorCode values for this endpoint:

• INVALID_PARAMETER (116) — generic input validation; conditions include:
  • series, from, or duration is missing.
  • dimensions or metrics is missing or empty.
  • metrics mixes load metrics with play metrics (must be all load or all play).
  • dimensions includes a play-only dimension when load metrics were requested (or vice versa).
  • from is not in ISO 8601 format with a timezone offset, or duration is outside the allowed range.

401

Caller is not authenticated. Possible errorCode values:

• UNAUTHENTICATED_ACCESS (108) — no Authorization header presented.
• EXPIRED_TOKEN (98) — bearer token expired.
• INVALID_TOKEN (99) — bearer token malformed or signature invalid.

403

Caller is authenticated but not allowed to access the requested resource. Possible errorCode values for this endpoint:

• NO_ACCESS_TO_SET (84) — caller has no access to the requested series.
• DISALLOWED_OPERATION_FOR_SET (89) — operation not permitted for this specific series (series-level gating); fires when reporting is not enabled for the requested series.

500

An internal server error occurred while processing the request. Possible errorCode values include IO_FAILURE (128) and other internal failures.