API - Parametros Relatorio Desempenho dos Usuários nos Ambientes

Modificado em Sex, 22 Ago na (o) 10:26 AM

Este artigo descreve os parâmetros necessários para realizar uma chamada de API ao relatório Desempenho dos Usuários nos Ambientes.

⚠️ Importante: Antes de executar a chamada, é necessário seguir os passos de preparação conforme as orientações já descritas nos artigos anteriores. Isso inclui a autenticação correta, obtenção do token Bearer e demais pré-requisitos para acesso à API.

Comece por aqui: Obtendo os parâmetros necessários para se integrar ao Engage
API Passo 2 - Obtendo o Bearer Token

Endpoint da API

Get https://my.engage.bz/api/v1/Id da instancia/reports/legacy/Id Do relaotrio/Id do usuario/json

?️ Parâmetros da Requisição

Abaixo estão os parâmetros que devem ser enviados na chamada:

Parâmetro	Tipo	Exemplo	Descrição
`competitionId`	String	`"23775"`	ID da competição/atividade.
`userStatus`	String	`"1,0"`	Status do usuário (ativos e inativos).
`profileUserTrackIds`	String	`"1,2"`	IDs de trilhas/perfis relacionados ao usuário.
`competitionCompletionStatus`	String	`"finished,expired,in_progress,not_started,not_released,exempted"`	Situação da competição.
`user`	String	`""`	Filtro de usuário (em branco retorna todos).
`group`	String	`""`	Filtro de grupo (em branco retorna todos).
`competitionCompletionDateStartDate`	DateTime	`"2025-08-16T12:44:41.731Z"`	Data inicial de conclusão.
`competitionCompletionDateEndDate`	DateTime	`"2025-08-22T12:44:41.731Z"`	Data final de conclusão.
`competitionCompletionDateShowEmptyDates`	Boolean (0/1)	`"1"`	Exibir registros sem datas de conclusão.
`competitionStartDateStartDate`	DateTime	`"2025-08-15T18:28:05.640Z"`	Data inicial de início.
`competitionStartDateEndDate`	DateTime	`"2025-08-21T18:28:05.640Z"`	Data final de início.
`competitionStartDateShowEmptyDates`	Boolean (0/1)	`"0"`	Exibir registros sem datas de início.
`lastCompetitionAccessDateStartDate`	DateTime	`"2025-08-16T12:44:37.620Z"`	Último acesso - data inicial.
`lastCompetitionAccessDateEndDate`	DateTime	`"2025-08-22T12:44:37.621Z"`	Último acesso - data final.
`lastCompetitionAccessDateShowEmptyDates`	Boolean (0/1)	`"1"`	Exibir registros sem acesso.
`competitionLinkDateStartDate`	DateTime	`"2025-08-16T12:44:47.220Z"`	Data inicial de link da competição.
`competitionLinkDateEndDate`	DateTime	`"2025-08-22T12:44:47.220Z"`	Data final de link da competição.
`environmentId`	String	`"admin"`	Ambiente de execução.

✅ Conclusão

Seguindo os parâmetros acima e respeitando as etapas de autenticação e preparação, será possível realizar a chamada da API para gerar o relatório Desempenho dos Usuários nos Ambientes, lembrando que nãp é nescessario ustilizar todos os paramentros na chamada.