API atual/Referência completa/Sessões ao vivo

Gamificação da sessão

Configura pontos por tempo assistido e voucher relâmpago, e consulta o relatório de engajamento.

Ler gamificação da sessão

Devolve como a sessão premia quem assiste. Se a sessão ainda não tem gamificação configurada, a resposta é null (HTTP 200).

GET/api/v1/admin/live-sessions/{id}/gamificationAdmin

Devolve a configuração de pontos e voucher relâmpago

Rota ligada ao módulo live-commerce: com o módulo desligado a resposta é 403. Exige token de administrador.

Parâmetros de caminho

iduuidobrigatório

Identificador da sessão.

Exemplo de requisição (Ler configuração)

bash

curl "$BASE_URL/api/v1/admin/live-sessions/7ec34d19-64f7-4d36-92eb-dbb217448af7/gamification" \
  -H "Authorization: Bearer $TOKEN"

Resposta (Ler configuração)

200Configuração

json

{
  "session_id": "7ec34d19-64f7-4d36-92eb-dbb217448af7",
  "points_per_minute": 2,
  "max_points_per_session": 100,
  "flash_unlock_after_seconds": 900,
  "flash_revealed": false
}

200Sem configuração

json

null

Campos da resposta

session_iduuid

Sessão.

points_per_minuteinteger

Pontos de fidelidade por minuto assistido.

max_points_per_sessioninteger

Teto de pontos que um espectador ganha por tempo assistido nesta sessão.

flash_voucher_idinteger

Id do voucher relâmpago, quando há. Ausente se não configurado.

flash_unlock_after_secondsinteger

Quantos segundos o espectador precisa ter assistido para resgatar o voucher.

flash_revealedboolean

true depois que o voucher foi revelado.

Erros (Ler configuração)

Status	Quando	Exemplo de corpo
401	Token ausente, inválido ou expirado.	`{"error":"invalid or expired token"}`
403	O token não é de um administrador.	`{"error":"insufficient permissions"}`
403	Módulo `live-commerce` desligado.	`{"error":"module_disabled","module":"live-commerce"}`
404	A gamificação não está disponível nesta loja.	`{"error":"gamification not available"}`

Configurar gamificação da sessão

Cria ou altera a configuração. Na primeira gravação, o que você não enviar assume o padrão (1 ponto por minuto, teto de 60 pontos, 900 segundos para liberar o voucher). Nas gravações seguintes, o que você não enviar permanece como está.

PUT/api/v1/admin/live-sessions/{id}/gamificationAdmin

Define pontos por minuto e o voucher relâmpago

Rota ligada ao módulo live-commerce: com o módulo desligado a resposta é 403. Exige token de administrador.

Parâmetros de caminho

iduuidobrigatório

Identificador da sessão.

Corpo da requisição

points_per_minuteintegerpadrão: 1

Pontos por minuto assistido. Com 0 não há pontos por tempo.

max_points_per_sessionintegerpadrão: 60

Teto de pontos por espectador na sessão. 0 = sem teto.

flash_voucher_idinteger

Id de um voucher já cadastrado, que será liberado como "relâmpago" aos espectadores que assistiram o suficiente.

flash_unlock_after_secondsintegerpadrão: 900

Segundos assistidos para poder resgatar o voucher.

Exemplo de requisição (Gravar configuração)

bash

curl -X PUT "$BASE_URL/api/v1/admin/live-sessions/7ec34d19-64f7-4d36-92eb-dbb217448af7/gamification" \
  -H "Authorization: Bearer $TOKEN" \
  -H "Content-Type: application/json" \
  -d '{
  "points_per_minute": 2,
  "max_points_per_session": 100
}'

Resposta (Gravar configuração)

200Configuração salva

json

{
  "session_id": "7ec34d19-64f7-4d36-92eb-dbb217448af7",
  "points_per_minute": 2,
  "max_points_per_session": 100,
  "flash_unlock_after_seconds": 900,
  "flash_revealed": false
}

Campos da resposta

session_iduuid

Sessão.

points_per_minuteinteger

Pontos de fidelidade por minuto assistido.

max_points_per_sessioninteger

Teto de pontos que um espectador ganha por tempo assistido nesta sessão.

flash_voucher_idinteger

Id do voucher relâmpago, quando há. Ausente se não configurado.

flash_unlock_after_secondsinteger

Quantos segundos o espectador precisa ter assistido para resgatar o voucher.

flash_revealedboolean

true depois que o voucher foi revelado.

Erros (Gravar configuração)

Status	Quando	Exemplo de corpo
401	Token ausente, inválido ou expirado.	`{"error":"invalid or expired token"}`
403	O token não é de um administrador.	`{"error":"insufficient permissions"}`
403	Módulo `live-commerce` desligado.	`{"error":"module_disabled","module":"live-commerce"}`
400	Corpo inválido.	`{"error":"invalid request body","detail":"..."}`
404	Sessão inexistente ou gamificação indisponível.	`{"error":"session not found"}`

Relatório da gamificação

Resume o engajamento: quantas pessoas assistiram, por quanto tempo, quantos pontos foram distribuídos e quanto do público respondeu aos quizzes. Pode ser consultado durante a sessão ou depois.

GET/api/v1/admin/live-sessions/{id}/gamification/reportAdmin

Devolve as métricas de engajamento da sessão

Rota ligada ao módulo live-commerce: com o módulo desligado a resposta é 403. Exige token de administrador.

Parâmetros de caminho

iduuidobrigatório

Identificador da sessão.

Exemplo de requisição (Relatório)

bash

curl "$BASE_URL/api/v1/admin/live-sessions/7ec34d19-64f7-4d36-92eb-dbb217448af7/gamification/report" \
  -H "Authorization: Bearer $TOKEN"

Resposta (Relatório)

200Relatório

json

{
  "unique_viewers": 184,
  "total_minutes": 3920,
  "avg_minutes": 21,
  "quiz_participation_bps": 4130,
  "points_distributed": 5210,
  "flash_claims": 0
}

Campos da resposta

unique_viewersinteger

Espectadores distintos que mandaram sinal de presença.

total_minutesinteger

Soma dos minutos assistidos por todos.

avg_minutesinteger

Média de minutos por espectador.

quiz_participation_bpsinteger

Parcela do público que respondeu algum quiz, em pontos-base (10000 = 100%; 4130 = 41,30%).

points_distributedinteger

Pontos de tempo assistido concedidos.

flash_claimsinteger

Resgates do voucher relâmpago. Sempre 0 hoje: o contador não é alimentado.

Erros (Relatório)

Status	Quando	Exemplo de corpo
401	Token ausente, inválido ou expirado.	`{"error":"invalid or expired token"}`
403	O token não é de um administrador.	`{"error":"insufficient permissions"}`
403	Módulo `live-commerce` desligado.	`{"error":"module_disabled","module":"live-commerce"}`
404	Gamificação indisponível.	`{"error":"gamification not available"}`

Veja também

API atual/Referência completa/Sessões ao vivo

Gamificação da sessão

Configura pontos por tempo assistido e voucher relâmpago, e consulta o relatório de engajamento.

Ler gamificação da sessão

Devolve como a sessão premia quem assiste. Se a sessão ainda não tem gamificação configurada, a resposta é null (HTTP 200).

GET/api/v1/admin/live-sessions/{id}/gamificationAdmin

Devolve a configuração de pontos e voucher relâmpago

Rota ligada ao módulo live-commerce: com o módulo desligado a resposta é 403. Exige token de administrador.

Parâmetros de caminho

iduuidobrigatório

Identificador da sessão.

Exemplo de requisição (Ler configuração)

bash

curl "$BASE_URL/api/v1/admin/live-sessions/7ec34d19-64f7-4d36-92eb-dbb217448af7/gamification" \
  -H "Authorization: Bearer $TOKEN"

Resposta (Ler configuração)

200Configuração

json

{
  "session_id": "7ec34d19-64f7-4d36-92eb-dbb217448af7",
  "points_per_minute": 2,
  "max_points_per_session": 100,
  "flash_unlock_after_seconds": 900,
  "flash_revealed": false
}

200Sem configuração

json

null

Campos da resposta

session_iduuid

Sessão.

points_per_minuteinteger

Pontos de fidelidade por minuto assistido.

max_points_per_sessioninteger

Teto de pontos que um espectador ganha por tempo assistido nesta sessão.

flash_voucher_idinteger

Id do voucher relâmpago, quando há. Ausente se não configurado.

flash_unlock_after_secondsinteger

Quantos segundos o espectador precisa ter assistido para resgatar o voucher.

flash_revealedboolean

true depois que o voucher foi revelado.

Erros (Ler configuração)

Status	Quando	Exemplo de corpo
401	Token ausente, inválido ou expirado.	`{"error":"invalid or expired token"}`
403	O token não é de um administrador.	`{"error":"insufficient permissions"}`
403	Módulo `live-commerce` desligado.	`{"error":"module_disabled","module":"live-commerce"}`
404	A gamificação não está disponível nesta loja.	`{"error":"gamification not available"}`

Configurar gamificação da sessão

PUT/api/v1/admin/live-sessions/{id}/gamificationAdmin

Define pontos por minuto e o voucher relâmpago

Rota ligada ao módulo live-commerce: com o módulo desligado a resposta é 403. Exige token de administrador.

Parâmetros de caminho

iduuidobrigatório

Identificador da sessão.

Corpo da requisição

points_per_minuteintegerpadrão: 1

Pontos por minuto assistido. Com 0 não há pontos por tempo.

max_points_per_sessionintegerpadrão: 60

Teto de pontos por espectador na sessão. 0 = sem teto.

flash_voucher_idinteger

Id de um voucher já cadastrado, que será liberado como "relâmpago" aos espectadores que assistiram o suficiente.

flash_unlock_after_secondsintegerpadrão: 900

Segundos assistidos para poder resgatar o voucher.

Exemplo de requisição (Gravar configuração)

bash

curl -X PUT "$BASE_URL/api/v1/admin/live-sessions/7ec34d19-64f7-4d36-92eb-dbb217448af7/gamification" \
  -H "Authorization: Bearer $TOKEN" \
  -H "Content-Type: application/json" \
  -d '{
  "points_per_minute": 2,
  "max_points_per_session": 100
}'

Resposta (Gravar configuração)

200Configuração salva

json

{
  "session_id": "7ec34d19-64f7-4d36-92eb-dbb217448af7",
  "points_per_minute": 2,
  "max_points_per_session": 100,
  "flash_unlock_after_seconds": 900,
  "flash_revealed": false
}

Campos da resposta

session_iduuid

Sessão.

points_per_minuteinteger

Pontos de fidelidade por minuto assistido.

max_points_per_sessioninteger

Teto de pontos que um espectador ganha por tempo assistido nesta sessão.

flash_voucher_idinteger

Id do voucher relâmpago, quando há. Ausente se não configurado.

flash_unlock_after_secondsinteger

Quantos segundos o espectador precisa ter assistido para resgatar o voucher.

flash_revealedboolean

true depois que o voucher foi revelado.

Erros (Gravar configuração)

Status	Quando	Exemplo de corpo
401	Token ausente, inválido ou expirado.	`{"error":"invalid or expired token"}`
403	O token não é de um administrador.	`{"error":"insufficient permissions"}`
403	Módulo `live-commerce` desligado.	`{"error":"module_disabled","module":"live-commerce"}`
400	Corpo inválido.	`{"error":"invalid request body","detail":"..."}`
404	Sessão inexistente ou gamificação indisponível.	`{"error":"session not found"}`

Relatório da gamificação

Resume o engajamento: quantas pessoas assistiram, por quanto tempo, quantos pontos foram distribuídos e quanto do público respondeu aos quizzes. Pode ser consultado durante a sessão ou depois.

GET/api/v1/admin/live-sessions/{id}/gamification/reportAdmin

Devolve as métricas de engajamento da sessão

Rota ligada ao módulo live-commerce: com o módulo desligado a resposta é 403. Exige token de administrador.

Parâmetros de caminho

iduuidobrigatório

Identificador da sessão.

Exemplo de requisição (Relatório)

bash

curl "$BASE_URL/api/v1/admin/live-sessions/7ec34d19-64f7-4d36-92eb-dbb217448af7/gamification/report" \
  -H "Authorization: Bearer $TOKEN"

Resposta (Relatório)

200Relatório

json

{
  "unique_viewers": 184,
  "total_minutes": 3920,
  "avg_minutes": 21,
  "quiz_participation_bps": 4130,
  "points_distributed": 5210,
  "flash_claims": 0
}

Campos da resposta

unique_viewersinteger

Espectadores distintos que mandaram sinal de presença.

total_minutesinteger

Soma dos minutos assistidos por todos.

avg_minutesinteger

Média de minutos por espectador.

quiz_participation_bpsinteger

Parcela do público que respondeu algum quiz, em pontos-base (10000 = 100%; 4130 = 41,30%).

points_distributedinteger

Pontos de tempo assistido concedidos.

flash_claimsinteger

Resgates do voucher relâmpago. Sempre 0 hoje: o contador não é alimentado.

Erros (Relatório)

Status	Quando	Exemplo de corpo
401	Token ausente, inválido ou expirado.	`{"error":"invalid or expired token"}`
403	O token não é de um administrador.	`{"error":"insufficient permissions"}`
403	Módulo `live-commerce` desligado.	`{"error":"module_disabled","module":"live-commerce"}`
404	Gamificação indisponível.	`{"error":"gamification not available"}`