Skip to main content
POST
Companies metrics

Authorizations

Authorization
string
header
required

Access token issued by gs.service.id. Its access_identity claim carries team_sid, actor_sid and actor_type, and that team scope is authoritative.

Team-SID
string
header
required

Team scope for tokens that do not carry one. Ignored when the token already names a team.

Body

application/json

Request body of get_companies_metrics.

period
object
required

Required. Period column: created_at - created_at operators inside filter are silently ignored.

filter
object

Scopes the rows the metrics are computed over: the search filter operators. Omit for all rows.

group_by
enum<string>

Single-axis breakdown - one groups[] entry per value. Cap 500 groups (422 on overflow - narrow the filter).

Available options:
status,
playtable_sids,
data_source_sid,
pipeline_stage_sid

Response

metrics success envelope.

success
enum<boolean>
required
Available options:
true
operation
enum<string>
required
Available options:
metrics
metrics
object
required
meta
object
required
applied_filters
object