For AI agents: a documentation index is available at the root level at /llms.txt and /llms-full.txt. Append /llms.txt to any URL for a page-level index, or .md for the markdown version of any page.
  • Get Started
    • Introduction
    • Quickstart
    • Authentication
  • API Reference
      • GETList Workflows
      • POSTCreate Workflow
      • GETGet Workflow
      • PUTUpdate Workflow
      • DELDelete Workflow
      • PATCHPatch Workflow
      • GETList Workflow Uploads
      • POSTPreview Run
      • GETRuns Summary
      • GETGet Run Steps
      • GETGet Run Overview
      • GETGet Run Data
      • GETDownload Run
      • GETDownload Run Node
      • POSTDuplicate Workflow
  • Python SDK
    • Install
    • Usage
    • Errors
  • CLI
    • Overview
LogoLogo
API Referenceworkflows

Get Run Overview

GET
/api/v1/workflows/:workflow_id/runs/:run_id/overview
GET
/api/v1/workflows/:workflow_id/runs/:run_id/overview
$curl https://api.onepin.ai/api/v1/workflows/workflow_id/runs/run_id/overview \
> -H "Authorization: Bearer <token>" \
> -H "Content-Type: application/json"
1{
2 "data": {
3 "workflow": {
4 "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
5 "name": "Customer Feedback Analysis"
6 },
7 "run": {
8 "id": "7c9e6679-7425-40de-944b-e07fc1f90ae7",
9 "status": "completed",
10 "created_at": "2024-01-15T09:30:00Z",
11 "started_at": "2024-01-15T09:35:00Z",
12 "completed_at": "2024-01-15T10:00:00Z",
13 "has_export": true,
14 "error": null
15 },
16 "workflow_snapshot": {
17 "definition": {
18 "version": "1.2.3",
19 "steps": [
20 "ingest",
21 "process",
22 "validate",
23 "export"
24 ]
25 },
26 "node_states": [
27 {
28 "node_id": "node-1234",
29 "node_type": "validator",
30 "status": "completed",
31 "iteration": 1,
32 "started_at": "2024-01-15T09:40:00Z",
33 "completed_at": "2024-01-15T09:50:00Z",
34 "duration_ms": 600000,
35 "error": null
36 }
37 ]
38 },
39 "metric_sections": [
40 {
41 "key": "summary_metrics",
42 "layout": "grid",
43 "title": "Summary Metrics",
44 "metrics": [
45 {
46 "key": "total_responses",
47 "label": "Total Responses",
48 "formatted_value": "1,250",
49 "status": "available",
50 "display": {
51 "variant": "primary",
52 "emphasis": "bold"
53 },
54 "value": 1250,
55 "unit": "responses",
56 "reason": null
57 }
58 ]
59 }
60 ],
61 "audio_by_language": [
62 {
63 "locale_code": "en-US",
64 "line_count": 500,
65 "total_duration_ms": 3600000,
66 "avg_duration_ms": 7200
67 }
68 ],
69 "validators": [
70 {
71 "node_id": "node-1234",
72 "kind": "quality_check",
73 "label": "Sentiment Accuracy Validator",
74 "status": "available",
75 "avg_score": 0.95,
76 "pass_rate": 0.98,
77 "pass_count": 490,
78 "fail_count": 10,
79 "retry_count": 2,
80 "reason": null
81 }
82 ],
83 "capabilities": {
84 "validator_drilldown": true,
85 "live_trace_timing": true,
86 "persisted_aggregates": true
87 },
88 "future_links": {
89 "validator_drilldown": "https://app.onepin.ai/workflows/3fa85f64-5717-4562-b3fc-2c963f66afa6/runs/7c9e6679-7425-40de-944b-e07fc1f90ae7/validators",
90 "live_trace": "https://app.onepin.ai/workflows/3fa85f64-5717-4562-b3fc-2c963f66afa6/runs/7c9e6679-7425-40de-944b-e07fc1f90ae7/live-trace"
91 }
92 },
93 "meta": {
94 "request_id": "a1b2c3d4-e5f6-7890-abcd-ef1234567890",
95 "timestamp": "2024-01-15T10:01:00Z"
96 }
97}

Fetch server-computed overview aggregates for a workflow run.

Was this page helpful?
Previous

Get Run Data

Next
Built with

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