GEgetsales
workflow_records

Workflow records metrics

Period-bound enrollment/outcome funnel: entered_count (created_at in the half-open [from,to) window), completed/failed/exited counts + completion_rate + avg_hours_to_complete (finished_at clock, same window). group_by one axis (status | workflow_sid | current_step_id | sender_profile_sid | entered_via_source_sid) adds groups[] with counts + metrics per value; current_step_id grouping requires workflow_sid.eq in filter (422). created_at operators in filter are ignored - period owns the window.

Contract:

  • MCP tool get_workflow_records_metrics, registry package mcp.playtables/workflow_records, mount playtables.journeys.
  • Operation metrics, response envelope metrics.
  • Flags: read only.
post/api/workflow-records/metrics

Request

  • Base URL
    https://beta.getsales.io/playtables/v1
  • Auth
    HTTP bearer and API key in header Team-SID

Request body

group_by'status' | 'workflow_sid' | 'current_step_id' | 'sender_profile_sid' | 'entered_via_source_sid'

Single axis - adds groups[] with per-value counts + metrics. current_step_id requires workflow_sid.eq in filter.

Response

metrics success envelope.

successtrue required
operation'metrics' required
applied_filtersobject

Changes

No recorded changes to this operation across all 1 revision of this API.