DokumentacjaEngagement Platform API
Sign inGet started
Guides
API

Flow Run Metrics

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 TypesFilter ID
flowThe Flow ID from the flow
POST
/workspaces/{workspaceId}/reporting/flowruns/{filterType}/{filterId}/metrics
Fetch flow metrics for a flow
Treść żądania
periodStart
string
wymagane
periodEnd
string
wymagane
periodGroup
string
wymagane
Possible values: minute, hour, day, month
groupBy
array of string
Treść odpowiedzi
periodGroup
string
Possible values: minute, hour, day, month
dataColumns
array of string
wymagane
results
array of object
Pokaż atrybuty podrzędne
results.periodTime
string
wymagane
results.count
integer
results.data
array of string
Przykład kodu
curl -X POST 'https://api.bird.com/workspaces/{workspaceId}/reporting/flowruns/{filterType}/{filterId}/metrics' \
  -H 'Authorization: AccessKey YOUR_ACCESS_KEY'