Skip to main content
POST
Workflow records 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_workflow_records_metrics.

period
object
required

Required. Period column: created_at (entered_count); outcome metrics clock on finished_at in the same window.

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. current_step_id requires workflow_sid.eq in filter.

Available options:
status,
workflow_sid,
current_step_id,
sender_profile_sid,
entered_via_source_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