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

Authorization

useraccessKey

Path parameters

workspaceId*string (uuid)

The ID of the workspace

filterType*enum

The type of flow run metrics filter

flowstatus

filterId*string

The ID of the filter, being platformId or channelId

Body

application/json

periodStart*PeriodTime (string (date-time))

periodEnd*PeriodTime (string (date-time))

periodGroup*enum

minutehourdaymonth

groupBynullable array of enum

Response

200422

List of results

Body

application/json

periodGroupenum

minutehourdaymonth

dataColumns*array of enum

resultsarray of object

Request

JavaScriptCurl

const response = await fetch('/workspaces/{workspaceId}/reporting/flowruns/{filterType}/{filterId}/metrics', {
    method: 'POST',
    headers: {
      "Authorization": "Bearer jwt",
      "Content-Type": "application/json"
    },
    body: JSON.stringify({
      "periodStart": "2024-04-29T14:59:08.332Z",
      "periodEnd": "2024-04-29T14:59:08.332Z",
      "periodGroup": "minute"
    }),
});
const data = await response.json();

Response

{
  "periodGroup": "minute",
  "dataColumns": [
    "status"
  ],
  "results": [
    {
      "periodTime": "2024-04-29T14:59:08.332Z",
      "data": [
        "text"
      ]
    }
  ]
}