Workflows

Get aggregated run success metrics for a workflow

Per-day successful/failed run counts and the overall success rate over the requested window, aggregated over all runs (not paginated). Days are bucketed by the run's finish date in UTC.

get/v4/workflows/{workflowId}/history/metrics

Request

  • Base URL: https://api.kadoa.com
  • URL: https://api.kadoa.com/v4/workflows/{workflowId}/history/metrics
  • Auth: API key in header x-api-key

Path parameters

workflowIdstring required

The unique identifier of the workflow

Query parameters

daysinteger

Number of calendar days (UTC) covered by the window, from midnight days-1 days ago through now

Response

Aggregated run metrics for the workflow

workflowIdstring

Unique identifier of the workflow

windowStartstring date-time

Inclusive start of the aggregation window

windowEndstring date-time

Exclusive end of the aggregation window

totalRunsinteger

Number of terminal (finished or failed) runs in the window

successfulRunsinteger

Number of finished runs in the window

failedRunsinteger

Number of failed runs in the window

successRatePercentagenumber nullable

successfulRuns / totalRuns as a percentage, null when the window has no terminal runs

Changes

No recorded changes to this operation across all 1 revision of this API.