Skip to main content
POST
Credit ledger entries 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_credit_ledger_entries_metrics.

period
object
required

Required. Half-open [from, to) window on created_at (the receipt clock) - 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 spend axis: playtable_sid | playtable_field_sid | tool_sid | created_date - adds groups[] with per-value counts + metrics. Cap 500 groups (§4.17).

Available options:
playtable_sid,
playtable_field_sid,
tool_sid,
created_date

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