Skip to main content
POST
Data sources 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_data_sources_metrics.

period
object
required

Required. {from, to} ISO 8601 UTC, half-open: compute the window from the date the client knows (the last 7 days = today minus 7 to now), never from a read. Bounds the funnel by data_source_items.created_at; filter (incl. created_at) scopes source rows.

filter
object

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

group_by
enum<string>

Single axis - adds groups[] with per-value counts + metrics. Cap 500 groups.

Available options:
status,
type,
object_type

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