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 message metrics

Fetch message metrics for a platform or channel

post

/workspaces/{workspaceId}/reporting/flowruns/{filterType}//{filterId}/metrics

Authorizations

useraccessKey

Path parameters

workspaceIdstring · uuidrequired

The ID of the workspace

filterTypestring · enumrequired

The type of flow run metrics filter

Options: flow, status

filterIdstringrequired

The ID of the filter, being platformId or channelId

Body

periodStartstring · date-timerequired

periodEndstring · date-timerequired

periodGroupstring · enumrequired

Options: minute, hour, day, month

groupBystring · enum[] | nullable

Responses

application/json

application/json

cURL

JavaScript

Python

HTTP

cURL

curl -L \
  --request POST \
  --url '/workspaces/{workspaceId}/reporting/flowruns/{filterType}/{filterId}/metrics' \
  --header 'Authorization: Bearer jwt' \
  --header 'Content-Type: application/json' \
  --data '{"periodStart":"2025-02-21T18:18:59.655Z","periodEnd":"2025-02-21T18:18:59.655Z","periodGroup":"minute","groupBy":["status"]}'

200

422

200

{
  "periodGroup": "minute",
  "dataColumns": [
    "status"
  ],
  "results": [
    {
      "periodTime": "2025-02-21T18:18:59.655Z",
      "count": 1,
      "data": [
        "text"
      ]
    }
  ]
}

List of results