Flow Run Metrics

Query Metrics Related to Your Flow Runs

Query for time series metrics that will provide you details around the total number of flow run invocations, failures, errors and similar metrics.

In order to query flow run metrics you must have the Flow ID and perform a HTTP request to the following endpoint with a valid access key.

Filter Types
Filter ID

flow

The Flow ID from the flow

Fetch flow metrics

post

Fetch flow metrics for a flow

Authorizations
Path parameters
workspaceIdstring · uuidRequired

The ID of the workspace

filterTypestring · enumRequired

The type of flow run metrics filter

Possible values:
filterIdstringRequired

The flow ID or the status (cancelled, completed_error, completed_success, exited_success, failed, failed_charging, new, rejected, runnable, running, suspended)

Body
periodStartstring · date-timeRequired
periodEndstring · date-timeRequired
periodGroupstring · enumRequiredPossible values:
Responses
200
List of results
application/json
post
POST /workspaces/{workspaceId}/reporting/flowruns/{filterType}/{filterId}/metrics HTTP/1.1
Host: 
Authorization: Bearer jwt
Content-Type: application/json
Accept: */*
Content-Length: 125

{
  "periodStart": "2025-07-15T03:08:37.427Z",
  "periodEnd": "2025-07-15T03:08:37.427Z",
  "periodGroup": "minute",
  "groupBy": [
    "status"
  ]
}
{
  "periodGroup": "minute",
  "dataColumns": [
    "status"
  ],
  "results": [
    {
      "periodTime": "2025-07-15T03:08:37.427Z",
      "count": 1,
      "data": [
        "text"
      ]
    }
  ]
}

Last updated

Was this helpful?