Developer Docs

Español

English

Español

English

Apariencia

Estadísticas de operaciones​

GET
/flow/v1/operations/statistics

Devuelve estadísticas agregadas de operaciones por estado e importes. Se usa para cuadros de mando, control de conversión y análisis financiero.

Incluye recuentos agrupados por estado (IN_PROGRESS, COMPLETED) y el importe acumulado de las operaciones de pago (ACCUMULATED_AMOUNT). Admite los mismos filtros que el listado de operaciones pero sin paginación ni ordenación. El conjunto completo de grupos de métricas se devuelve siempre, incluso cuando su valor es 0.

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

Filtra operaciones cuyo 'statusUpdatedAt' sea posterior o igual a la fecha-hora indicada (statusUpdatedFrom)

Tipo
string
Ejemplo"2025-03-10T14:23:45Z"
Formato
"date-time"
q_toStatusUpdatedAt

Filtra operaciones cuyo 'statusUpdatedAt' sea anterior o igual a la fecha-hora indicada (statusUpdatedTo)

Tipo
string
Ejemplo"2025-03-10T14:23:45Z"
Formato
"date-time"
q_fromCreatedAt

Filtra operaciones cuyo 'createdAt' sea posterior o igual a la fecha-hora indicada (createdFrom)

Tipo
string
Ejemplo"2025-03-10T14:23:45Z"
Formato
"date-time"
q_toCreatedAt

Filtra operaciones cuyo 'createdAt' sea anterior o igual a la fecha-hora indicada (createdTo)

Tipo
string
Ejemplo"2025-03-10T14:23:45Z"
Formato
"date-time"
q_operationUuid

Filtra operaciones por UUID de operación (coincidencia exacta)

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

Filtra operaciones por ID externo (coincidencia exacta)

Tipo
string
Ejemplo"my-external-id"
q_flowUuid

Filtra operaciones por UUID del flujo (coincidencia exacta)

Tipo
string
Ejemplo"7a5b71b5-2c4a-4bdf-8e1a-33d3be6cfdf1"
Formato
"uuid"
q_status

Filtra operaciones por estado (no distingue mayúsculas/minúsculas). Admite 0, 1 o N valores separados por comas.

Tipo
array
Ejemplo"OPENED""CREATED"
q_type

Filtra operaciones por tipo (no distingue mayúsculas/minúsculas). Admite 0, 1 o N valores separados por comas.

Tipo
array
Ejemplo"PAYMENT""SIGNATURE"
q_amountFrom

Filtra operaciones de pago cuyo importe sea mayor o igual que este valor (amountFrom)

Tipo
number
Ejemplo1050
q_amountTo

Filtra operaciones de pago cuyo importe sea menor o igual que este valor (amountTo)

Tipo
number
Ejemplo99999
q_invoiceExternalId

Filtra operaciones de pago por ID externo de la factura (coincidencia exacta)

Tipo
string
Ejemplo"INV-2025-000123"

Respuestas​

Estadísticas de operaciones

application/json
JSON
{
  
"summary": {
  
  
"total": 12
  
},
  
"groups": [
  
  
{
  
  
  
"key": "IN_PROGRESS",
  
  
  
"metrics": {
  
  
  
  
"count": 0,
  
  
  
  
"amount": 0
  
  
  
}
  
  
}
  
]
}

Playground​

Autorización
Headers
Variables
Key
Value

Ejemplos​