Devuelve las métricas de analítica completas de hasta 2 reproductores de una prueba A/B
Devuelve, en una sola respuesta, el conjunto completo de métricas de analítica de hasta 2 reproductores de una prueba A/B: views, plays, finishes, clicks, conversiones con ingresos en USD/BRL/EUR, engagement, pitch audience y pitch retention, además del play rate, el conversion rate y los ingresos por visitante (RPV) derivados. El `start_date` de cada elemento es opcional — si se omite, se usa el `started_at` del propio reproductor (de la lista `players` del comparison group) y, si ese no está definido, el `started_at` del comparison group. Si se omite `end_date`, los resultados llegan hasta el momento actual.
Authorization
apiToken apiVersion userAgent 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
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
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
application/json
application/json
curl -X POST "https://example.com/comparison_groups/stats" \ -H "Content-Type: application/json" \ -d '{ "comparison_group_id": "699f9683dfeab82d6246e13b", "items": [ { "player_id": "699f92f01dd8bb9e2b6aab3a", "start_date": "2026-02-26 00:41:00" }, { "player_id": "699f9363c4b02ade5c5f1881", "start_date": "2026-02-26 00:41:00" } ], "events": [ "started", "viewed", "finished" ] }'{ "comparison_group": { "id": "string", "name": "string", "player_ids": [ "string" ], "started_at": "string", "finished_at": "string" }, "stats": [ { "player_id": "string", "pitch_time": 0, "video_duration": 0, "views": { "total": 0, "total_uniq_sessions": 0, "total_uniq_device": 0 }, "plays": { "total": 0, "total_uniq_sessions": 0, "total_uniq_device": 0 }, "finishes": { "total": 0, "total_uniq_sessions": 0, "total_uniq_device": 0 }, "clicks": { "total": 0, "total_uniq_sessions": 0, "total_uniq_device": 0 }, "conversions": { "total": 0, "total_uniq_sessions": 0, "total_uniq_device": 0, "total_amount_usd": 0, "total_amount_brl": 0, "total_amount_eur": 0 }, "engagement": { "average_watched_time": 0, "engagement_rate": 0, "grouped_timed": [ { "timed": 0, "total_users": 0 } ] }, "pitch_audience": 0, "pitch_retention_rate": 0, "play_rate": 0, "conversion_rate": 0, "rpv_usd": 0, "rpv_brl": 0, "rpv_eur": 0 } ]}Listar las pruebas A/B (comparison groups) registradas para la empresa autenticada POST
Devuelve todas las pruebas A/B registradas para la empresa, con los reproductores inscritos en cada prueba (incluidos sus porcentajes de tráfico) y las marcas de tiempo de inicio/fin de la prueba. Los resultados se ordenan por fecha de creación (los más recientes primero). Usa los filtros opcionales `start_date`/`end_date` para acotar los resultados por el `created_at` del comparison group.
Devuelve el uso en tiempo real de la cuota de la API de la empresa autenticada GET
Devuelve el uso y los límites actuales de la cuota de la empresa — una entrada por ventana de cuota, como por minuto o por día. Todas las API keys de la empresa comparten esta cuota. Usa este endpoint para autolimitar tu ritmo antes de hacer solicitudes de analítica costosas. Notas: - Cuando una métrica no tiene tope, la respuesta devuelve `limit: null` y `remaining: null` para que no dividas por cero. - Cuando la empresa no tiene cuota, `quotas` es una lista vacía. - Una sola solicitud a la API puede contar como más de una consulta contra `max_queries_per_minute`, así que el contador `queries` puede subir más rápido que tu ritmo de solicitudes. La respuesta incluye `queries.note` para señalarlo cuando se aplica un límite estricto. `read_bytes` refleja los datos realmente escaneados y es la señal más fiable para dimensionar el uso. - Este endpoint cuenta en sí mismo como 1 consulta contra `max_queries_per_minute`.