Este artigo descreve os parâmetros necessários para realizar uma chamada de API ao relatório Desempenho dos Usuários nos Módulos.
⚠️ 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
API - Relatórios
Endpoint da API
Parâmetros da Requisição
Abaixo estão os parâmetros que devem ser enviados na chamada:
| Campo | Descrição | Tipo | Exemplo |
|---|---|---|---|
competitionId | Lista de IDs das competições. | String (IDs separados por vírgula) | "23775,24000,24014" |
trackId | Lista de IDs das trilhas (cursos/percursos). | String (IDs separados por vírgula) | "89952,91196" |
roundId | Lista de IDs das rodadas/etapas. | String (IDs separados por vírgula) | "392630,392631,392632" |
userStatus | Status do usuário. | String ou Número | "1" |
profileUserTrackIds | IDs de perfis do usuário nas trilhas. | String (IDs separados por vírgula) | "1,2" |
roundCompletionStatus | Status da conclusão da rodada. | String (valores separados por vírgula) | "approved,reproved,in_progress" |
user | Lista de IDs de usuários. | String (IDs separados por vírgula) | "861682,862440,865325" |
group | ID do grupo (turma/equipe). | String ou Número | "73255" |
showAllAttempts | Exibir todas as tentativas (0 = não, 1 = sim). | String ou Número | "0" |
roundCompletionDateStartDate | Data/hora inicial para conclusão. | String (ISO 8601) | "2025-08-19T18:04:19.694Z" |
roundCompletionDateEndDate | Data/hora final para conclusão. | String (ISO 8601) | "2025-08-25T18:04:19.694Z" |
roundCompletionDateShowEmptyDates | Mostrar registros sem data de conclusão. | String ou Número (0/1) | "1" |
roundStartDateStartDate | Data/hora inicial de início da rodada. | String (ISO 8601) | "2025-08-19T18:02:01.060Z" |
roundStartDateEndDate | Data/hora final de início da rodada. | String (ISO 8601) | "2025-08-25T18:02:01.060Z" |
roundStartDateShowEmptyDates | Mostrar rodadas sem data de início. | String ou Número (0/1) | "0" |
roundLinkDateStartDate | Data/hora inicial de liberação da rodada. | String (ISO 8601) | "2025-08-19T18:04:24.596Z" |
roundLinkDateEndDate | Data/hora final de liberação da rodada. | String (ISO 8601) | "2025-08-25T18:04:24.596Z" |
environmentId | Ambiente da requisição. | String | "admin" |
Exemplo:
{
"params": {
"competitionId": "",
"trackId": "",
"roundId": "",
"userStatus": "",
"profileUserTrackIds": "",
"roundCompletionStatus": "",
"user": "",
"group": "",
"showAllAttempts": "",
"roundCompletionDateStartDate": "",
"roundCompletionDateEndDate": "",
"roundCompletionDateShowEmptyDates": "",
"roundStartDateStartDate": "",
"roundStartDateEndDate": "",
"roundStartDateShowEmptyDates": "",
"roundLinkDateStartDate": "",
"roundLinkDateEndDate": "",
"environmentId": ""
}
}
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