API atual/Referência completa/Lives de vendas

Ranking da live

Mostra os 10 primeiros colocados da live e, para o cliente logado, a posição dele.

O ranking soma, para cada espectador, 1 ponto por minuto assistido e 10 pontos por quiz acertado. Em empate, ganha quem chegou àquela pontuação primeiro. É a tela de placar da live; ele não é o saldo de pontos do programa de recompensas.

GET/api/v1/storefront/live-sessions/{id}/leaderboardPública

Consultar o ranking da live

Parâmetros de caminho

iduuidobrigatório

Id da live.

Cabeçalhos

Authorizationstring

Bearer <access_token> do cliente. Opcional; só serve para preencher me.

Exemplo de requisição

bash

curl "$BASE_URL/api/v1/storefront/live-sessions/$SESSION_ID/leaderboard" \
  -H "Authorization: Bearer $TOKEN"

Resposta

200Ranking

json

{
  "entries": [
    { "display_name": "Maria S.", "score": 34, "rank": 1 },
    { "display_name": "João P.", "score": 21, "rank": 2 }
  ],
  "me": { "display_name": "João P.", "score": 21, "rank": 2 }
}

Campos da resposta

entriesarray

Até 10 colocados, do primeiro ao décimo. [] quando ninguém pontuou.

entries[].display_namestring

Nome mascarado (primeiro nome e inicial do sobrenome).

entries[].scoreinteger

Pontuação do ranking: minutos assistidos mais 10 por acerto de quiz.

entries[].rankinteger

Posição, começando em 1.

meobject

Linha do cliente logado, com os mesmos três campos, mesmo fora do top 10. null sem token ou quando o cliente ainda não pontuou.

Erros

Status	Quando	Corpo
403	Módulo `live-commerce` desligado.	`{"error":"module_disabled","module":"live-commerce"}`
404	A gamificação não está disponível.	`{"error":"gamification not available"}`
500	`id` que não é UUID, ou falha ao consultar.	`{"error":"gamification error","detail":"..."}`

Veja também