Developer Docs

Español

English

Español

English

Apariencia

Estadísticas de flujos​

GET
/flow/v1/flows/statistics

Devuelve métricas agregadas de flujos (volumen, estados y distribución). Orientado a informes financieros y análisis de negocio.

Agrupadas por estado del flujo. Admite los mismos filtros que el listado de flujos (UUID, externalId, estado, etiqueta de producto, rangos de fechas) pero sin paginación ni ordenación.

Autorizaciones​

OAuth2

Esquema de seguridad OAuth2

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

Parámetros​

Header Parameters

x-tenant-id*

Identificador del tenant que contiene el UUID del negocio

Tipo
string
Requerido

Query Parameters

q_fromStatusUpdatedAt

Busca flujos cuyo 'statusUpdatedAt' sea posterior o igual a la fecha-hora indicada

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

Busca flujos cuyo 'statusUpdatedAt' sea anterior o igual a la fecha-hora indicada

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

Busca flujos cuyo 'createdAt' sea posterior o igual a la fecha-hora indicada

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

Busca flujos cuyo 'createdAt' sea anterior o igual a la fecha-hora indicada

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

Filtra flujos por UUID

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

Filtra flujos por ID externo

Tipo
string
Ejemplo"my-external-id"
q_productLabelValue

Recupera flujos que tengan una etiqueta con nombre "product" y el valor indicado. Admite varios separados por comas

Tipo
string
Ejemplo"whatever product label value"
q_status

Filtra flujos por estado. Admite varios separados por comas

Tipo
array
Ejemplo"CREATED""COMPLETED"

Respuestas​

Lista de operaciones

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

Playground​

Autorización
Headers
Variables
Key
Value

Ejemplos​