Saltar al contenido
Funciones Integraciones Precios Documentación
Iniciar sesión Empieza gratis

API de eventos

Envía eventos desde tu backend: compras confirmadas por la pasarela de pago, altas, procesos en segundo plano. Disponible en el plan Business.

Crea un token

Ve a Ajustes del workspace → Tokens de API, crea un token y cópialo (solo se muestra una vez). Los tokens pertenecen al workspace y se pueden revocar en cualquier momento.

Envía un evento

curl -X POST https://byanalytics.co/api/v1/events \
  -H "Authorization: Bearer TU_TOKEN" \
  -H "Content-Type: application/json" \
  -d '{
    "site": "TU_CLAVE_DE_WEB",
    "name": "purchase",
    "url": "https://example.com/checkout/gracias",
    "props": { "plan": "pro", "value": 49.9 }
  }'

Campos

Campo Obligatorio Descripción
site sí Clave de una web del workspace del token.
name sí Nombre del evento (se admite pageview). Máx. 64 caracteres.
url no Página a la que pertenece el evento. Por defecto, la portada de la web.
referrer no URL de referencia, para atribuir la fuente.
props no Objeto plano de propiedades; value suma a ingresos.
visitor_ip, user_agent no Reenvía los del visitante para atribuir país y dispositivo. Se usan para el hash y se descartan; nunca se guardan.

Respuestas

  • 202 Accepted: { "status": "accepted" } (o "ignored" en rutas excluidas y "over_quota" si se ha agotado el límite mensual)
  • 401 token no válido · 403 plan sin API o web de otro workspace · 422 error de validación · 429 límite superado (120 peticiones/minuto por token).

Laravel

El paquete byanalytics/laravel envuelve la API:

ByAnalytics::event('purchase', ['value' => 49.9], url: route('checkout.thanks'));