Skip to navigation

Get Run Overview

Fetch server-computed overview aggregates for a workflow run.

Returns structured metric sections (e.g. audio duration totals, validation pass rates) grouped by display section, along with per-language audio breakdowns and per-validator scoring summaries. Also includes a workflow_snapshot with the graph definition and per-node completion states.

This endpoint is best suited for a summary/results view after a run completes. It differs from the other run sub-resources as follows:

  • GET /runs/{run_id} — full run record including the raw definition snapshot.
  • GET /runs/{run_id}/status — volatile status fields only; for polling.
  • GET /runs/{run_id}/steps — lightweight per-node step log by default; include_result=true includes results and audio playback URLs.
  • GET /runs/{run_id}/outputs — one logical result per snapshot sink node.
  • GET /runs/{run_id}/data — paginated script+audio rows for a data table.
  • GET /runs/{run_id}/overview (this endpoint) — pre-aggregated metrics and node state map for a dashboard/overview panel.

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"
run_idstringRequiredformat: "uuid"

Headers

X-Workspace-Idstring or nullOptional

Response

Successful Response
dataobject
metaobject

Errors

422
Unprocessable Entity Error