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

useraccessKey

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

422

The request did not pass validation

application/json

post

HTTPcURLJavaScriptPython

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-11T17:46:16.306Z",
  "periodEnd": "2025-07-11T17:46:16.306Z",
  "periodGroup": "minute",
  "groupBy": [
    "status"
  ]
}

{
  "periodGroup": "minute",
  "dataColumns": [
    "status"
  ],
  "results": [
    {
      "periodTime": "2025-07-11T17:46:16.306Z",
      "count": 1,
      "data": [
        "text"
      ]
    }
  ]
}