API Reference
API Reference

Insight Workflow Executions Summary

Return how many of a workflow's executions are in each status, optionally within a created_at range (for example, since the workflow's updated_at passed as start_datetime).

GET/api/v1/insights/workflows/{workflow_id}/executions/summary

Authentication

Syllable-API-Keyrequired

Send Syllable-API-Key in the header.

Need a credential? Create or manage an API token in the Syllable Console.

Parameters

Path parameters

workflow_id integer path required

Query parameters

start_datetime string | null query optional

ISO 8601 start datetime (inclusive) for created_at filtering

Example 2026-08-27T13:57:00.123456+00:00
end_datetime string | null query optional

ISO 8601 end datetime (exclusive) for created_at filtering

Example 2026-08-28T00:00:00Z

Responses

200Successful Response

application/json

response InsightWorkflowExecutionSummary required
5 fields
pendingintegeroptional

Rows in PENDING status

Default 0
processingintegeroptional

Rows in PROCESSING status

Default 0
completedintegeroptional

Rows in COMPLETED status

Default 0
failedintegeroptional

Rows in FAILED status

Default 0
totalintegeroptional

Total rows across all statuses

Default 0
Response example
{
  "pending": 0,
  "processing": 0,
  "completed": 0,
  "failed": 0,
  "total": 0
}
422Validation Error

application/json

response HTTPValidationError required
1 field
detailValidationError[]optional
Item schema
itemsValidationErrorrequired
3 fields
locstring | integer[]required
Item schema
itemsstring | integerrequired
2 options
Option 1stringrequired
Option 2integerrequired
msgstringrequired
typestringrequired
Response example
{
  "detail": [
    {
      "loc": [
        "string"
      ],
      "msg": "string",
      "type": "string"
    }
  ]
}