Developer Docs

English

Español

English

Español

Appearance

Flow statistics​

GET
/flow/v1/flows/statistics

Returns aggregated flow metrics (volume, statuses and distribution). Aimed at financial reporting and business analysis.

Grouped by flow status. Accepts the same filters as the flow listing (UUID, externalId, status, product label, date ranges) but without pagination or sorting.

Autorizaciones​

OAuth2

OAuth2 security scheme

clientCredentials Flow
Token URL"/api/v2/auth/token"
Scopes:
  • "zertiban-api"Access to the API

Parámetros​

Header Parameters

x-tenant-id*

Tenant identifier that contains the business UUID

Tipo
string
Requerido

Query Parameters

q_fromStatusUpdatedAt

Finds flows with 'statusUpdatedAt' after or equal the specified date time

Tipo
string
Ejemplo"2025-03-10T14:23:45Z"
Formato
"ISO 8601"
q_toStatusUpdatedAt

Find flows 'statusUpdatedAt' before or equal the specified date time

Tipo
string
Ejemplo"2025-03-10T14:23:45Z"
Formato
"ISO 8601"
q_fromCreatedAt

Find flows with 'createdAt' after or equal the specified date time

Tipo
string
Ejemplo"2025-03-10T14:23:45Z"
Formato
"ISO 8601"
q_toCreatedAt

Find flows with 'createdAt' before or equal the specified date time

Tipo
string
Ejemplo"2025-03-10T14:23:45Z"
Formato
"ISO 8601"
q_uuid

Filters flows by a UUID

Tipo
string
Ejemplo"12087dd4-336d-4c21-90e1-3dbd58f14f87"
Formato
"UUID v4"
q_externalId

Filters flows by external ID

Tipo
string
Ejemplo"my-external-id"
q_productLabelValue

Retrieves flows that have a label with name "product" and the specified value. Accepts multiple comma separated

Tipo
string
Ejemplo"whatever product label value"
q_status

Filters flows by Status. Accepts multiple comma separated

Tipo
array
Ejemplo"CREATED""COMPLETED"

Respuestas​

Operation list

application/json
JSON
{
  
"summary": {
  
  
"totalFlows": 100
  
},
  
"groups": [
  
  
{
  
  
  
"key": "IN_PROGRESS",
  
  
  
"metrics": {
  
  
  
  
"count": 33
  
  
  
}
  
  
}
  
]
}

Playground​

Autorización
Headers
Variables
Key
Value

Ejemplos​