Encuentra el ID de un reproductor
Lista tus reproductores y obtén el ID, la duración del vídeo y el tiempo de pitch que piden los demás endpoints
Casi todas las consultas reciben un player_id: el ID de un reproductor de tu cuenta de VTurb, de 24 caracteres hexadecimales. GET /players/list lo devuelve, junto con la duración del vídeo del reproductor y su tiempo de pitch, que usan las consultas de retención y de pitch.
Lista tus reproductores
La solicitud solo necesita los encabezados de autenticación:
curl 'https://analytics.vturb.com/players/list' \
-H "X-Api-Token: $VTURB_API_TOKEN" \
-H 'X-Api-Version: v1' \
-H 'User-Agent: mi-integracion/1.0'[
{
"id": "64a5c8072e6fd10009828db2",
"name": "Black Friday VSL",
"pitch_time": 1260,
"duration": 2340,
"created_at": "2025-07-18 10:00:00"
}
]| Campo | Qué es |
|---|---|
id | El player_id que piden los demás endpoints |
name | El nombre del reproductor en el panel |
pitch_time | El segundo en que empieza el pitch de ventas, según la configuración del reproductor; 0 si no hay ninguno configurado |
duration | La duración del vídeo del reproductor, en segundos |
created_at | Cuándo se creó el reproductor, en UTC; timezone no lo cambia |
Los reproductores eliminados no aparecen en la lista, ni tampoco los reproductores cuyo vídeo se eliminó.
Busca por nombre
Si tienes muchos reproductores, filtra por nombre en lugar de recorrerlos todos:
curl 'https://analytics.vturb.com/players/list?name=black%20friday&name_match=starts_with' \
-H "X-Api-Token: $VTURB_API_TOKEN" \
-H 'X-Api-Version: v1' \
-H 'User-Agent: mi-integracion/1.0'- A
namese le quitan los espacios de los extremos y, después, necesita de 3 a 128 caracteres. No distingue mayúsculas de minúsculas, incluidas las letras acentuadas (Écoincide coné, no cone).%,_y\se comparan de forma literal. name_matchdefine cómo:contains(el predeterminado),starts_with,ends_withoexact. Requierename.
Filtra por fecha de creación
start_date y end_date dejan solo los reproductores creados en ese rango, con las fechas leídas en timezone (en UTC si lo omites):
curl -G 'https://analytics.vturb.com/players/list' \
--data-urlencode 'start_date=2026-09-01 00:00:00' \
--data-urlencode 'end_date=2026-09-30 23:59:59' \
--data-urlencode 'timezone=America/Sao_Paulo' \
-H "X-Api-Token: $VTURB_API_TOKEN" \
-H 'X-Api-Version: v1' \
-H 'User-Agent: mi-integracion/1.0'Las dos fechas son opcionales, y cada una se escribe con el formato YYYY-MM-DD HH:MM:SS.
Guarda los IDs
El ID de un reproductor no cambia, así que búscalo una vez y guárdalo junto con tu informe o tu integración. duration y pitch_time siguen la configuración actual del reproductor: vuelve a leerlos cuando cambien el vídeo o el pitch.
A continuación: crea un informe diario o mide la retención y el pitch del reproductor que encontraste.