Analítica de mensajes salientes

Obtén el recuento y las tasas de entrega, lectura y fallo de los mensajes salientes para un rango de fechas.

GET /api/v1/analytics

Outbound message analytics

cURL

curl --request GET \
  --url https://app.flowella.io/api/v1/analytics \
  --header 'Authorization: Bearer <token>'

200

{
  "period": {
    "start": "2023-11-07T05:31:56Z",
    "end": "2023-11-07T05:31:56Z"
  },
  "outboundMessages": {
    "total": 123,
    "counts": {},
    "deliveryRate": 123,
    "readRate": 123,
    "failureRate": 123
  }
}

Agrega los recuentos y las tasas de los mensajes salientes por estado dentro del rango de fechas indicado. Usa esto para impulsar paneles, exportar resumidos periódicos o alertar sobre cambios en la entregabilidad.

​

Autenticación

Todas las solicitudes requieren la cabecera Authorization: Bearer <api_key> con una clave que empieza por el prefijo flo_.

​

Parámetros de consulta

startDate · string · requerido

Fecha de inicio del rango. Acepta tanto solo fecha (2025-01-01) como ISO 8601 completa.

endDate · string · requerido

Fecha de fin del rango. Acepta tanto solo fecha como ISO 8601 completa.

​

Respuesta

period · object · requerido

Objeto con las marcas de tiempo start y end (ISO 8601) del periodo analizado.

outboundMessages · object · requerido

Contiene:

• total (integer): número total de mensajes salientes.
• counts (object): mapa de estado a recuento entero (por ejemplo, sent, delivered, read, failed).
• deliveryRate (number): proporción de mensajes entregados sobre el total.
• readRate (number): proporción de mensajes leídos sobre el total.
• failureRate (number): proporción de mensajes fallidos sobre el total.

​

Errores

Código	Significado
400	Parámetros de consulta no válidos.
401	Falta la clave de API o no es válida.
429	Limitado por tasa.

​

Ejemplo

curl "https://app.flowella.io/api/v1/analytics?startDate=2025-04-01&endDate=2025-04-30" \
  -H "Authorization: Bearer flo_xxxxxxxxxxxxxxxxxxxxxxxx"

Autorizaciones

Authorization · string · header · requerido

Organization API key (flo_…). Send as Authorization: Bearer <key>.

Parámetros de consulta

startDate · string<date-time> · requerido

endDate · string<date-time> · requerido

Respuesta

200

application/json

Analytics for period

period · object · requerido

Show child attributes

outboundMessages · object · requerido

Show child attributes