API de AnalyticsEndpoints

Devuelve hasta dónde llegaron las sesiones, separado por un parámetro de consulta de la página

Devuelve la misma distribución que `POST /times/user_engagement`, separada por el valor de un parámetro de consulta de la URL de la página, como `utm_source`. Solo cuentan las sesiones cuyo parámetro tiene uno de los `values`.

POST
/times/user_engagement_by_traffic_origin

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/times/user_engagement_by_traffic_origin" \  -H "Content-Type: application/json" \  -d '{    "player_id": "64a5c8072e6fd10009828db2",    "query_key": "utm_source",    "values": [      "facebook",      "google"    ],    "start_date": "2026-09-01 00:00:00",    "end_date": "2026-09-30 23:59:59",    "timezone": "America/Sao_Paulo"  }'
[  {    "group_key": "facebook",    "group_values": [      {        "timed": 30,        "totalUsers": 58      }    ]  }]