cauril/Docs

Resumen analítico

get/v1/analytics/summary

Métricas agregadas en un rango. Las métricas monetarias (volume, fees_estimated) se reportan en una sola currency: por defecto la más activa del período, conmutable con el parámetro currency. fees_estimated es una estimación (no la factura del PSP). Sin from/to, el rango por defecto son los últimos 30 días.

Request

BASH
curl https://api.cauril.com/v1/analytics/summary \
  -H "Authorization: Bearer sk_test_..."

Parámetros

fromquerystring · dateInicio del rango (ISO-8601). Default: hace 30 días.
toquerystring · dateFin del rango (ISO-8601). Default: ahora.
currencyquerystringMoneda de reporte (ISO-4217). Default: la más activa del período.

Respuestas

200El resumen analíticoAnalyticsSummary
401ErrorError

Ejemplo de respuesta · 200

JSON
{
  "object": "analytics_summary",
  "range": {
    "from": "2026-06-01T12:00:00Z",
    "to": "2026-06-01T12:00:00Z"
  },
  "totals": {
    "count": 0,
    "volume": 5000,
    "approval_rate": 0.91,
    "succeeded": 0,
    "failed": 0,
    "currency": "USD"
  },
  "fees_estimated": 5000,
  "available_currencies": [
    {
      "currency": "USD",
      "count": 0
    }
  ],
  "by_provider": [
    {
      "provider": "stripe",
      "count": 0,
      "volume": 5000,
      "approval_rate": 0.93,
      "fees_estimated": 5000
    }
  ]
}