InicioGuíasReferencia de la API
API de AnalyticsEndpoints

Estadísticas usadas por el panel de titulares

Devuelve un elemento por titular de la prueba de titulares del reproductor, con views, plays, engagement, retención en el pitch, clics y conversiones. Las fechas se leen en UTC. Si el reproductor no existe en la empresa, la respuesta es `400` con `{"error": ["Player could not be found for the current request"]}`.

POST
/headlines/stats_by_player

Authorization

apiToken apiVersion userAgent
X-Api-Token<token>

Accede a la aplicación y copia tu token de API; luego, solo tienes que definir el encabezado X-Api-Token con él.

In: header

X-Api-Version<token>

La versión de la API que se usará. Las versiones compatibles actualmente son:

  • v1: La versión estable actual

Una solicitud sin este encabezado, o con cualquier otro valor, la responde el edge con 404 y {"error_msg":"404 Route Not Found"}.

In: header

User-Agent<token>

Se requiere un User-Agent no vacío que identifique tu integración. Las solicitudes sin él se rechazan en el edge antes de llegar a la API.

In: header

Request Body

application/json

TypeScript Definitions

Use the request body type in TypeScript.

Response Body

application/json

application/json

application/json

application/json

application/json

curl -X POST "https://example.com/headlines/stats_by_player" \  -H "Content-Type: application/json" \  -d '{    "start_date": "2026-09-01 00:00:00",    "end_date": "2026-09-30 23:59:59",    "player_id": "64a5c8072e6fd10009828db2",    "video_duration": 1200,    "pitch_time": 300  }'
[  {    "number": 1,    "views": 140,    "plays": 52,    "engagement": 0.42,    "play_rate": 0.35,    "play_over_engagement": 0.147,    "pitch": 0.18,    "clicks": 12,    "conversions": 3,    "amount_brl": 59100,    "amount_usd": 0,    "amount_eur": 0,    "conversion_rate": 5.77  },  {    "number": 2,    "views": 150,    "plays": 61,    "engagement": 0.37,    "play_rate": 0.39,    "play_over_engagement": 0.1443,    "pitch": 0.15,    "clicks": 9,    "conversions": 2,    "amount_brl": 39400,    "amount_usd": 0,    "amount_eur": 0,    "conversion_rate": 3.28  }]

Devuelve los clics de un reproductor de cada día POST

Devuelve los clics de un reproductor de cada día del periodo, en la zona horaria de `timezone`, con los totales de todo el periodo. Los días sin clics vienen con ceros.

Devuelve estadísticas de todas las sesiones de un reproductor POST

Devuelve los totales de las sesiones de un reproductor en el periodo: views, plays, finalizaciones, clics, engagement, retención en el pitch y conversiones.