Skip to navigation

Runs Summary

Aggregate run statistics for a workflow over an optional date window.

Returns per-status counts (completed, failed, cancelled, pending, running, paused) plus three derived metrics:

  • pass_rate: completed / (completed + failed). Cancelled runs are user-aborted, not quality failures, so they are excluded. null when there are no non-cancelled terminal runs in the window.
  • delivered_audio_ms: total delivered-take audio in milliseconds, summed over completed runs.
  • average_duration_seconds: mean active duration — completed_at - started_at minus paused time — over successfully completed runs only. null when no runs have completed.

Date range: from / to filter by created_at. Both must be ISO 8601 with a UTC offset; a naive datetime returns 422. An inverted range (from > to) also returns 422. Omit both to aggregate over all runs.

Use GET /runs with ?status= filters for individual run details; this endpoint is best for dashboard-style health metrics.

Authentication

AuthorizationBearer
Clerk JWT token
OR
AuthorizationBearer

Onepin live API key (op_live_...). Test and public keys are reserved in Phase 1.

Path parameters

workflow_idstringRequiredformat: "uuid"

Headers

X-Workspace-Idstring or nullOptional

Query parameters

fromdatetime or nullOptional

Filter runs by created_at >= this ISO datetime (ISO 8601 with UTC offset required).

todatetime or nullOptional

Filter runs by created_at <= this ISO datetime (ISO 8601 with UTC offset required).

Response

Successful Response
dataobject
metaobject

Errors

422
Unprocessable Entity Error