Skip to main content

SuccessResponse_WorkflowMetrics

successboolean
Constant value: true
data object
periodstring
timeRange object
startstring<date-time>
endstring<date-time>
workflowIdinteger
dataPoints object[]
  • Array [
  • timePeriodstring<date-time>

    Start of the time bucket this row aggregates (truncated to the requested period granularity, e.g. hour/day).

    statusJobStatus (string)

    Job status this bucket is grouped by — rows are grouped by (timePeriod, status), so one period yields one row per distinct status.

    Possible values: [pending, running, retrying, completed, failed]

    requestCountinteger

    Number of runs (jobs) in this (timePeriod, status) bucket — a count.

    totalExecutionTimenumber

    AVG execution time, in milliseconds, of the runs in this (timePeriod, status) bucket — despite the total… name this is an average (the backend computes it with SQL AVG(execution_time)), NOT a sum. To get an overall mean across buckets, re-average run-weighted by requestCount.

    totalExecutionCostnumber

    Summed execution cost across the runs in this (timePeriod, status) bucket — a sum (SQL SUM(execution_cost)).

  • ]
  • SuccessResponse_WorkflowMetrics
    {
    "success": true,
    "data": {
    "period": "string",
    "timeRange": {
    "start": "2024-07-29T15:51:28.071Z",
    "end": "2024-07-29T15:51:28.071Z"
    },
    "workflowId": 0,
    "dataPoints": [
    {
    "timePeriod": "2024-07-29T15:51:28.071Z",
    "status": "pending",
    "requestCount": 0,
    "totalExecutionTime": 0,
    "totalExecutionCost": 0
    }
    ]
    }
    }