getFlowMetrics

GET

/api/v1/flows/{namespace}/{flowId}/metrics

curl --request GET \
  --url 'https://example.com/api/v1/flows/example/example/metrics?agg=sum'

Parameters

Path Parameters

namespace

required

string

<= 128 characters /^[a-z0-9]([a-z0-9-]*[a-z0-9])?(\.[a-z0-9]([a-z0-9-]*[a-z0-9])?)*$/

flowId

required

string

<= 63 characters /^[a-z0-9][a-z0-9-]*$/

Query Parameters

name

Metric name. Empty returns only the names.

string

<= 100 characters

Metric name. Empty returns only the names.

agg

string

default: sum

Allowed values: sum avg max

group_by

Tag key. One series per tag value.

string

<= 100 characters

Tag key. One series per tag value.

Responses

200

OK

Media typeapplication/json

object

names

required

Array<string>

series

required

Array<object>

object

group

required

Value of the group-by tag. Empty when the tag is missing or no group-by is set.

string

points

required

Array<object>

object

created_at

required

string format: date-time

execution_id

required

string

value

required

number format: double

key

additional properties

any

key

additional properties

any

key

additional properties

any

Example^generated

{
  "names": [
    "example"
  ],
  "series": [
    {
      "group": "example",
      "points": [
        {
          "created_at": "2026-04-15T12:00:00Z",
          "execution_id": "example",
          "value": 1
        }
      ]
    }
  ]
}

default

Error

Media typeapplication/json

object

error

required

object

code

required

string

details

message

required

string

key

additional properties

any

key

additional properties

any

Example^generated

{
  "error": {
    "code": "example",
    "details": "example",
    "message": "example"
  }
}