Este artigo descreve os parâmetros necessários para realizar uma chamada de API ao relatório Desempenho dos Usuários nas Atividades
⚠️ 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
?️ Parâmetros da Requisição
Abaixo estão os parâmetros que devem ser enviados na chamada:
| Campo | Descrição | Exemplo |
|---|---|---|
competitionId | IDs das competições que serão consideradas na consulta. Pode ser uma lista separada por vírgula. | "23775,24000,24014,24135" |
trackId | IDs das trilhas (cursos ou percursos) que fazem parte da competição. | "89952,91196,91222,91468" |
roundId | IDs das rodadas/etapas específicas dentro das trilhas/competição. | "392630,392631,392632" |
activity | Filtro por atividade específica (se vazio, considera todas). | "" |
userStatus | Status do usuário no sistema (ex.: 1 = ativo, 0 = inativo). | "1" |
profileUserTrackIds | IDs do perfil de usuário vinculados às trilhas. | "1,2" |
activityType | Tipo de atividade (ex.: curso, prova, vídeo). | "" |
activityCompletionStatus | Status de conclusão da atividade (finished, in_progress etc.). | "finished,exempted,expired,awaiting_approval" |
user | Filtro de usuário específico (ex.: ID ou login). | "" |
group | Filtro de grupo de usuários. | "" |
activityCompletionDateStartDate | Data inicial para filtrar a conclusão da atividade (formato ISO 8601). | "2025-08-19T18:15:22.107Z" |
activityCompletionDateEndDate | Data final para filtrar a conclusão da atividade. | "2025-08-25T18:15:22.107Z" |
activityCompletionDateShowEmptyDates | Define se exibe registros sem data de conclusão (1 = sim, 0 = não). | "1" |
firstAccessToActivityDateStartDate | Data inicial para o primeiro acesso à atividade. | "2025-08-19T18:02:01.060Z" |
firstAccessToActivityDateEndDate | Data final para o primeiro acesso à atividade. | "2025-08-25T18:02:01.060Z" |
firstAccessToActivityDateShowEmptyDates | Exibir usuários sem primeiro acesso? (1 = sim, 0 = não). | "0" |
lastActivityAccessDateStartDate | Data inicial do último acesso à atividade. | "2025-08-19T18:15:34.317Z" |
lastActivityAccessDateEndDate | Data final do último acesso à atividade. | "2025-08-25T18:15:34.317Z" |
lastActivityAccessDateShowEmptyDates | Exibir usuários sem último acesso? (1 = sim, 0 = não). | "1" |
environmentId | Identificação do ambiente onde a consulta está sendo feita (ex.: admin, aluno). | "admin" |
"params": {
"competitionId": "23775,24000",
"trackId": "89952,91196",
"roundId": "392630,392631",
"activity": "Curso de Introdução",
"userStatus": "1",
"profileUserTrackIds": "1,2",
"activityType": "course",
"activityCompletionStatus": "finished,in_progress",
"user": "12345",
"group": "Equipe A",
"activityCompletionDateStartDate": "2025-08-19T00:00:00.000Z",
"activityCompletionDateEndDate": "2025-08-25T23:59:59.000Z",
"activityCompletionDateShowEmptyDates": "1",
"firstAccessToActivityDateStartDate": "2025-08-19T00:00:00.000Z",
"firstAccessToActivityDateEndDate": "2025-08-25T23:59:59.000Z",
"firstAccessToActivityDateShowEmptyDates": "0",
"lastActivityAccessDateStartDate": "2025-08-19T00:00:00.000Z",
"lastActivityAccessDateEndDate": "2025-08-25T23:59:59.000Z",
"lastActivityAccessDateShowEmptyDates": "1",
"environmentId": "admin"
}
Este artigo foi útil?
Que bom!
Obrigado pelo seu feedback
Desculpe! Não conseguimos ajudar você
Obrigado pelo seu feedback
Feedback enviado
Agradecemos seu esforço e tentaremos corrigir o artigo