> ## Documentation Index > Fetch the complete documentation index at: https://docs.getsales.io/llms.txt > Use this file to discover all available pages before exploring further. # 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. ## OpenAPI ````yaml /api-reference/playtables/openapi.yaml post /api/workflow-records/metrics openapi: 3.0.3 info: title: 'GetSales public contract: gs.service.playtables' description: >- The data platform and the outreach engine: tables of people and companies, their enrichment columns, cells and runs, the data sources that feed them, sender profiles, the stoplist, the activity feed, the credit ledger, and the multichannel workflows with their per-person journeys and tasks. GENERATED. This document is projected from the Zod MCP tool registry in `product/mcp/gs.mcp` (one tool per public endpoint, 1:1). Do not edit it by hand; edit the tool definition and regenerate with `pnpm openapi:public`. Surface: the public `/api` contract of `gs.service.playtables`, 142 operations. This is the only OpenAPI document the platform publishes. Internal (`/internal`) and health endpoints are deliberately absent: they are not part of any contract, they can change without notice, and the service source is their only description. Conventions: - Auth is a bearer JWT, optionally narrowed by the `Team-SID` header. - Every success body is an MCP envelope: `success: true` plus one typed `operation` shape (`search`, `get`, `create`, `update`, `delete`, `metrics`, `group_by`, `action`), and a `meta` block with `trace_id` for support. - Every failure is the same `McpError` envelope with a code from a fixed 16-code taxonomy, so a client maps errors once. - Lists page with `page_size` (0 to 500, default 50) plus an opaque forward `cursor`; `page_size: 0` returns counts only. - On `GET` and `DELETE`, object-valued query parameters (`filter`, `sort`) travel as JSON text and array-valued ones repeat as `name[]=value`. - The MCP-only `_meta` field (usage analytics) never reaches the backend and is not part of this contract. version: '1.0' contact: name: GetSales url: https://getsales.io email: support@getsales.io license: name: Proprietary url: https://getsales.io/terms servers: - url: https://beta.getsales.io/playtables/v1 description: >- Production (the gateway path on the beta ring; the origin is provisioned per DEPLOY_MAP.md) security: - BearerJwt: [] TeamSid: [] tags: - name: activities description: >- Registry package `mcp.playtables/activities`, served on MCP mount `playtables.journeys`. - name: activity_objects description: >- Registry package `mcp.playtables/activity_objects`, served on MCP mount `playtables.people`. - name: companies description: >- Registry package `mcp.playtables/companies`, served on MCP mount `playtables.people`. - name: credit_ledger_entries description: >- Registry package `mcp.playtables/credit_ledger_entries`, served on MCP mount `id.billing`. - name: data_source_items description: >- Registry package `mcp.playtables/data_source_items`, served on MCP mount `playtables.sources`. - name: data_sources description: >- Registry package `mcp.playtables/data_sources`, served on MCP mount `playtables.sources`. - name: notes description: >- Registry package `mcp.playtables/notes`, served on MCP mount `playtables.pipeline`. - name: people description: >- Registry package `mcp.playtables/people`, served on MCP mount `playtables.people`. - name: pipeline_stages description: >- Registry package `mcp.playtables/pipeline_stages`, served on MCP mount `playtables.pipeline`. - name: plays description: >- Registry package `mcp.playtables/plays`, served on MCP mount `playtables.pipeline`. - name: playtable_field_values description: >- Registry package `mcp.playtables/playtable_field_values`, served on MCP mount `playtables.columns`. - name: playtable_fields description: >- Registry package `mcp.playtables/playtable_fields`, served on MCP mount `playtables.columns`. - name: playtable_runs description: >- Registry package `mcp.playtables/playtable_runs`, served on MCP mount `playtables.columns`. - name: playtable_views description: >- Registry package `mcp.playtables/playtable_views`, served on MCP mount `playtables.tables`. - name: playtables description: >- Registry package `mcp.playtables/playtables`, served on MCP mount `playtables.tables`. - name: result_pages description: >- Registry package `mcp.playtables/result_pages`, served on MCP mount `playtables.tables`. - name: sender_profiles description: >- Registry package `mcp.playtables/sender_profiles`, served on MCP mount `playtables.sources`. - name: stoplist_entries description: >- Registry package `mcp.playtables/stoplist_entries`, served on MCP mount `playtables.stoplist`. - name: tags description: >- Registry package `mcp.playtables/tags`, served on MCP mount `playtables.pipeline`. - name: workflow_attachments description: >- Registry package `mcp.playtables/workflow_attachments`, served on MCP mount `playtables.workflows`. - name: workflow_records description: >- Registry package `mcp.playtables/workflow_records`, served on MCP mount `playtables.journeys`. - name: workflow_sources description: >- Registry package `mcp.playtables/workflow_sources`, served on MCP mount `playtables.workflows`. - name: workflow_tasks description: >- Registry package `mcp.playtables/workflow_tasks`, served on MCP mount `playtables.journeys`. - name: workflow_versions description: >- Registry package `mcp.playtables/workflow_versions`, served on MCP mount `playtables.workflows`. - name: workflows description: >- Registry package `mcp.playtables/workflows`, served on MCP mount `playtables.workflows`. paths: /api/workflow-records/metrics: post: tags: - workflow_records summary: Workflow records metrics description: >- 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. operationId: get_workflow_records_metrics requestBody: required: true content: application/json: schema: $ref: '#/components/schemas/GetWorkflowRecordsMetricsRequest' responses: '200': description: '`metrics` success envelope.' content: application/json: schema: $ref: '#/components/schemas/GetWorkflowRecordsMetricsResponse' 4XX: $ref: '#/components/responses/McpClientError' 5XX: $ref: '#/components/responses/McpServerError' components: schemas: GetWorkflowRecordsMetricsRequest: type: object description: Request body of `get_workflow_records_metrics`. properties: filter: type: object properties: sid: type: object properties: eq: type: string minLength: 18 maxLength: 18 pattern: ^wf_rc_ description: Workflow record sid (wf_rc_…). in: type: array items: type: string minLength: 18 maxLength: 18 pattern: ^wf_rc_ description: Workflow record sid (wf_rc_…). additionalProperties: false description: >- Prefix-validated wf_rc_ sid(s); also the single-row read (no get tool). workflow_sid: type: object properties: eq: type: string minLength: 18 maxLength: 18 pattern: ^wf_wf_ in: type: array items: type: string minLength: 18 maxLength: 18 pattern: ^wf_wf_ additionalProperties: false description: Progress-board scope (wf_wf_…). workflow_version_sid: type: object properties: eq: type: string minLength: 18 maxLength: 18 pattern: ^wf_vr_ in: type: array items: type: string minLength: 18 maxLength: 18 pattern: ^wf_vr_ additionalProperties: false description: '"Who is still on the old version" (wf_vr_…).' people_sid: type: object properties: eq: type: string minLength: 18 maxLength: 18 pattern: ^cr_pp_ in: type: array items: type: string minLength: 18 maxLength: 18 pattern: ^cr_pp_ additionalProperties: false description: >- Person card (cr_pp_…); bulk ops take sids from people search first. entered_via_source_sid: type: object properties: eq: type: string minLength: 18 maxLength: 18 pattern: ^wf_sr_ in: type: array items: type: string minLength: 18 maxLength: 18 pattern: ^wf_sr_ additionalProperties: false description: Per-source cohort (wf_sr_…). sender_profile_sid: type: object properties: eq: type: string minLength: 18 maxLength: 18 pattern: ^ub_sp_ in: type: array items: type: string minLength: 18 maxLength: 18 pattern: ^ub_sp_ is_null: type: boolean additionalProperties: false description: >- Per-sender load (ub_sp_…); is_null:true = unpinned (no send steps). current_step_id: type: object properties: eq: type: integer in: type: array items: type: integer additionalProperties: false description: >- Step column of the board (int step id); meaningful only with a workflow_sid filter. status: type: object properties: eq: type: string enum: - waiting_limit - blocked - active - waiting - paused_on_reply - paused_manual - paused_blocked - failed - completed - exited ne: type: string enum: - waiting_limit - blocked - active - waiting - paused_on_reply - paused_manual - paused_blocked - failed - completed - exited in: type: array items: type: string enum: - waiting_limit - blocked - active - waiting - paused_on_reply - paused_manual - paused_blocked - failed - completed - exited nin: type: array items: type: string enum: - waiting_limit - blocked - active - waiting - paused_on_reply - paused_manual - paused_blocked - failed - completed - exited additionalProperties: false last_touch_at: type: object properties: gte: type: string lte: type: string gt: type: string lt: type: string additionalProperties: false description: Staleness - "no movement since …"; ISO 8601 bounds. finished_at: type: object properties: gte: type: string lte: type: string is_null: type: boolean additionalProperties: false description: >- { is_null: true } = live records; datetime bounds = terminal cohort. created_at: type: object properties: gte: type: string lte: type: string gt: type: string lt: type: string additionalProperties: false description: Enrollment window; ISO 8601 bounds, combine in one object. deleted_at: type: object properties: gte: type: string lte: type: string is_null: type: boolean additionalProperties: false description: >- Default scope is { is_null: true } (live rows); set only by parent cascades. description: >- Scopes the rows the metrics are computed over: the search filter operators. Omit for all rows. period: type: object properties: from: type: string description: ISO 8601 UTC window start (inclusive). to: type: string description: ISO 8601 UTC window end (exclusive); must be >= from. required: - from - to description: >- Required. Period column: created_at (entered_count); outcome metrics clock on finished_at in the same window. group_by: type: string enum: - status - workflow_sid - current_step_id - sender_profile_sid - entered_via_source_sid description: >- Single axis - adds groups[] with per-value counts + metrics. current_step_id requires workflow_sid.eq in filter. required: - period GetWorkflowRecordsMetricsResponse: type: object properties: success: type: boolean enum: - true operation: type: string enum: - metrics metrics: type: object properties: filter: anyOf: - type: object additionalProperties: {} - type: array items: {} description: >- Echo of the request WorkflowRecordSearchFilter (PHP empty map serialises as []). period: type: object properties: from: type: string to: type: string required: - from - to aggregated: type: object properties: counts: type: object properties: total_count: type: integer minimum: 0 description: Records matching the filter scope. groups: type: object properties: status: anyOf: - type: object additionalProperties: type: number - type: array items: {} description: >- The funnel axis - map keyed by the 8 WorkflowRecordStatusEnum values. workflow_sid: anyOf: - type: object additionalProperties: type: number - type: array items: {} description: Per-workflow distribution across the team. current_step_id: anyOf: - type: object additionalProperties: type: number - type: array items: {} description: >- Board columns - keys are STRINGIFIED step ids; read with a workflow_sid filter in scope. sender_profile_sid: anyOf: - type: object additionalProperties: type: number - type: array items: {} description: >- Per-sender load; "null" bucket = unpinned (no send steps). entered_via_source_sid: anyOf: - type: object additionalProperties: type: number - type: array items: {} description: Per-source funnel. required: - status - workflow_sid - current_step_id - sender_profile_sid - entered_via_source_sid required: - total_count - groups metrics: type: object properties: entered_count: type: integer minimum: 0 description: >- Records enrolled in the window: created_at in [period.from, period.to). completed_count: type: integer minimum: 0 description: >- finished_at in period AND status = completed - sequences finished successfully. failed_count: type: integer minimum: 0 description: >- finished_at in period AND status = failed (a stoplist hit no longer fails a journey: it blocks it, paused_blocked, and is not in this count). exited_count: type: integer minimum: 0 description: >- finished_at in period AND status = exited - manual/system removals. completion_rate: type: number nullable: true minimum: 0 maximum: 1 description: >- completed_count / (completed + failed + exited in period); null when the denominator is 0. avg_hours_to_complete: type: number nullable: true description: >- AVG(finished_at - created_at) in hours over completed in period; null when none. required: - entered_count - completed_count - failed_count - exited_count - completion_rate - avg_hours_to_complete required: - counts - metrics groups: type: array items: type: object properties: key: type: string nullable: true description: >- Value of the group_by axis (a status / workflow_sid / current_step_id / sender_profile_sid / entered_via_source_sid value); null = rows without a value on the axis (e.g. unpinned sender). counts: type: object properties: total_count: type: integer minimum: 0 description: Records matching the filter scope. groups: type: object properties: status: anyOf: - type: object additionalProperties: type: number - type: array items: {} description: >- The funnel axis - map keyed by the 8 WorkflowRecordStatusEnum values. workflow_sid: anyOf: - type: object additionalProperties: type: number - type: array items: {} description: Per-workflow distribution across the team. current_step_id: anyOf: - type: object additionalProperties: type: number - type: array items: {} description: >- Board columns - keys are STRINGIFIED step ids; read with a workflow_sid filter in scope. sender_profile_sid: anyOf: - type: object additionalProperties: type: number - type: array items: {} description: >- Per-sender load; "null" bucket = unpinned (no send steps). entered_via_source_sid: anyOf: - type: object additionalProperties: type: number - type: array items: {} description: Per-source funnel. required: - status - workflow_sid - current_step_id - sender_profile_sid - entered_via_source_sid required: - total_count - groups metrics: type: object properties: entered_count: type: integer minimum: 0 description: >- Records enrolled in the window: created_at in [period.from, period.to). completed_count: type: integer minimum: 0 description: >- finished_at in period AND status = completed - sequences finished successfully. failed_count: type: integer minimum: 0 description: >- finished_at in period AND status = failed (a stoplist hit no longer fails a journey: it blocks it, paused_blocked, and is not in this count). exited_count: type: integer minimum: 0 description: >- finished_at in period AND status = exited - manual/system removals. completion_rate: type: number nullable: true minimum: 0 maximum: 1 description: >- completed_count / (completed + failed + exited in period); null when the denominator is 0. avg_hours_to_complete: type: number nullable: true description: >- AVG(finished_at - created_at) in hours over completed in period; null when none. required: - entered_count - completed_count - failed_count - exited_count - completion_rate - avg_hours_to_complete required: - key - counts - metrics description: Present only when group_by was set - one entry per axis value. required: - period - aggregated applied_filters: type: object additionalProperties: {} meta: type: object properties: trace_id: type: string description: UUID v7; same 128-bit value as the X-Trace-Id header. span_id: type: string pattern: ^[0-9a-f]{16}$ description: 16 hex chars, root span of this request. timestamp: type: string description: ISO 8601 UTC (Y-m-dTH:i:sZ), response time. duration_ms: type: integer minimum: 0 description: Server-side wall clock. team_sid: type: string nullable: true description: >- The team this call ran in (the token team, or the team_sid override). Null when unauthenticated; absent from pre-2026-08-20 backends. actor_type: type: string nullable: true description: >- user | agent | api_key | system. Null when unauthenticated; absent from pre-2026-08-20 backends. required: - trace_id - span_id - timestamp - duration_ms required: - success - operation - metrics - meta McpError: type: object properties: success: type: boolean enum: - false error: type: object properties: code: type: string enum: - validation_failed - nothing_to_update - not_found - relation_not_found - invalid_transition - limit_exceeded - payment_required - duplicate_rejected - conflict - delete_blocked - unauthorized - forbidden - rate_limited - internal_error - service_unavailable - not_implemented message: type: string recoverable: type: boolean suggestion: type: string field_errors: type: object additionalProperties: type: array items: type: object properties: rule: type: string message: type: string required: - rule - message blockers: type: array items: type: object properties: type: type: string description: >- Machine-readable blocker type (active_flow, pending_tasks, …). severity: type: string enum: - hard - soft description: >- hard = external action required; soft = acknowledge is enough. description: type: string entity_sid: type: string nullable: true count: type: integer resolution: type: string description: 'Hard: tool name to call. Soft: code for acknowledge[].' resolution_hint: type: string required: - type - severity - description - entity_sid - resolution - resolution_hint context: type: object additionalProperties: {} required: - code - message - recoverable meta: type: object properties: trace_id: type: string description: UUID v7; same 128-bit value as the X-Trace-Id header. span_id: type: string pattern: ^[0-9a-f]{16}$ description: 16 hex chars, root span of this request. timestamp: type: string description: ISO 8601 UTC (Y-m-dTH:i:sZ), response time. duration_ms: type: integer minimum: 0 description: Server-side wall clock. team_sid: type: string nullable: true description: >- The team this call ran in (the token team, or the team_sid override). Null when unauthenticated; absent from pre-2026-08-20 backends. actor_type: type: string nullable: true description: >- user | agent | api_key | system. Null when unauthenticated; absent from pre-2026-08-20 backends. required: - trace_id - span_id - timestamp - duration_ms required: - success - error responses: McpClientError: description: >- MCP error envelope. `error.code` is one of validation_failed, nothing_to_update, not_found, relation_not_found, invalid_transition, limit_exceeded, payment_required, duplicate_rejected, conflict, delete_blocked, unauthorized, forbidden, rate_limited, not_implemented. content: application/json: schema: $ref: '#/components/schemas/McpError' McpServerError: description: >- MCP error envelope with `error.code` internal_error or service_unavailable. content: application/json: schema: $ref: '#/components/schemas/McpError' securitySchemes: BearerJwt: type: http scheme: bearer bearerFormat: JWT description: >- 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. TeamSid: type: apiKey in: header name: Team-SID description: >- Team scope for tokens that do not carry one. Ignored when the token already names a team. ```` This documentation is built and hosted on [Mintlify](https://mintlify.com), a developer documentation platform.