InicioGuíasReferencia de la API
API de AnalyticsEndpoints

Listar todos los reproductores

Devuelve los reproductores de la empresa de la API key, con la duración de su vídeo y su tiempo de pitch. Los reproductores eliminados no se listan.

GET
/players/list

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

Query Parameters

start_date?string

Lista solo los reproductores creados a partir de este momento, YYYY-MM-DD HH:MM:SS, leído en la zona horaria de timezone.

end_date?string

Lista solo los reproductores creados hasta este momento, YYYY-MM-DD HH:MM:SS, leído en la zona horaria de timezone.

timezone?string

Zona horaria IANA en la que se leen las fechas, como America/Sao_Paulo. Por defecto, UTC.

name?string

Filtra los reproductores por nombre. La búsqueda no distingue mayúsculas de minúsculas (incluidos caracteres no ASCII como É/é). Los caracteres especiales %, _, \ y los corchetes se comparan de forma literal — por ejemplo, name=[campaign_1] devuelve solo los reproductores cuyo nombre contiene exactamente esa etiqueta. Los espacios en blanco al inicio y al final se eliminan antes de comparar; el valor resultante debe tener entre 3 y 128 caracteres.

Length3 <= length <= 128
name_match?string

Cómo se compara name. contains (por defecto) busca coincidencias en cualquier parte del nombre; starts_with y ends_with se anclan al inicio o al final; exact exige una coincidencia completa sin distinguir mayúsculas de minúsculas. Enviar name_match sin name devuelve 400.

Default"contains"

Value in

  • "contains"
  • "starts_with"
  • "ends_with"
  • "exact"

Response Body

application/json

application/json

application/json

application/json

application/json

curl -X GET "https://example.com/players/list?start_date=2026-01-01+00%3A00%3A00&end_date=2026-09-30+23%3A59%3A59&timezone=America%2FSao_Paulo&name=%5Bcampaign_1%5D&name_match=starts_with"
[  {    "id": "64a5c8072e6fd10009828db2",    "name": "Sales video",    "pitch_time": 300,    "duration": 1200,    "created_at": "2026-01-23 21:54:39"  }]

Estadísticas usadas por el panel de Turbo POST

Devuelve un elemento por velocidad de Turbo 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"]}`.

Listar todas las métricas personalizadas de un reproductor POST

Devuelve las métricas personalizadas de retención de un reproductor y, para cada una, cuántas sesiones llegaron al segundo que marca.