Developer Docs

Operation statistics​

GET
/flow/v1/operations/statistics

Returns aggregated operation statistics by status and amounts. Used for dashboards, conversion control and financial analysis.

Includes counts grouped by status (IN_PROGRESS, COMPLETED) and the accumulated amount of payment operations (ACCUMULATED_AMOUNT). Accepts the same filters as the operation listing but without pagination or sorting. The full set of metric groups is always returned, even when their value is 0.

Autorizaciones​

OAuth2

OAuth2 security scheme

clientCredentials Flow
URL del token"/idp/oauth2/token"
Ámbitos:
  • "api"Access to the API

Parámetros​

Header Parameters

x-tenant-id*

Tenant identifier that contains the organisation UUID

Tipo
string
Requerido
Ejemplo"1f56c928-7621-44fe-8cda-c211fda0a828"
Formato
"uuid"

Query Parameters

q_fromStatusUpdatedAt

Filters operations with 'statusUpdatedAt' after or equal to the specified date-time (statusUpdatedFrom)

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

Filters operations with 'statusUpdatedAt' before or equal to the specified date-time (statusUpdatedTo)

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

Filters operations with 'createdAt' after or equal to the specified date-time (createdFrom)

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

Filters operations with 'createdAt' before or equal to the specified date-time (createdTo)

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

Filters operations by operation UUID (exact match)

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

Filters operations by external ID (exact match)

Tipo
string
Ejemplo"my-external-id"
q_flowUuid

Filters operations by flow UUID (exact match)

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

Filters operations by status (case insensitive). Supports 0, 1 or N values separated by comma.

Tipo
array
Ejemplo"OPENED""CREATED"
q_type

Filters operations by type (case insensitive). Supports 0, 1 or N values separated by comma.

Tipo
array
Ejemplo"PAYMENT""SIGNATURE"
q_amountFrom

Filters payment operations with amount greater than or equal to this value (amountFrom)

Tipo
number
Ejemplo1050
q_amountTo

Filters payment operations with amount lower than or equal to this value (amountTo)

Tipo
number
Ejemplo99999
q_invoiceExternalId

Filters payment operations by invoice external ID (exact match)

Tipo
string
Ejemplo"INV-2025-000123"

Respuestas​

Operation statistics

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

Playground​

Servidor
Autorización
Headers
Variables
Key
Value

Ejemplos​