API de AnalyticsEndpoints

Retorna até onde as sessões chegaram, separado por um parâmetro de consulta da página

Retorna a mesma distribuição de `POST /times/user_engagement`, separada pelo valor de um parâmetro de consulta da URL da página, como `utm_source`. Só contam as sessões cujo parâmetro tem um dos `values`.

POST
/times/user_engagement_by_traffic_origin

Authorization

apiToken apiVersion userAgent
X-Api-Token<token>

Acesse a aplicação e copie seu token de API, em seguida, defina o cabeçalho X-Api-Token com ele.

In: header

X-Api-Version<token>

A versão da API a ser usada. As versões suportadas atualmente são:

  • v1: A versão estável atual

Uma requisição sem este cabeçalho, ou com qualquer outro valor, é respondida pela borda com 404 e {"error_msg":"404 Route Not Found"}.

In: header

User-Agent<token>

É obrigatório enviar um User-Agent não vazio identificando sua integração. Requisições sem ele são rejeitadas na borda antes de chegar à 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      }    ]  }]