API - Relatórios

Modificado em Qua, 26 Nov na (o) 11:16 AM

Antes de consumir esse end point é nescessario realizar os passos indicados nos artigos Abaixo

Passo 01: Obtendo os parâmetros necessários
Passo 02: Obter token Bearer

Para obtenção dos relatórios o usuário deve utilizar as APIs ReportLegacy:


customerId: ID da Instância

id: ID do relatório,

adminId: ID do usuário administrador


A API destacada abaixo retornará os dados já em formato json .


EndPoint: https://my.engage.bz/api/v1/customerId /reports/legacy/id /adminId /json?


Abaixo temos a lista de id dos relatórios padrão da plataforma

NomeRelatorioCodigoRelatorioCategoriaRelatorio
01 - Desempenho dos Usuários  nos AmbientesD138910F-C410-4D84-904F-4BDBA40A2C67Relatórios de Progresso e Desempenho
02 - Desempenho dos Usuários  nas Trilhas76D0ACBD-2D50-4A6C-A16E-6E1CBE16862CRelatórios de Progresso e Desempenho
03 - Desempenho dos Usuários  nos Módulos3EF43BAD-A6EC-4EE7-B3E9-764E07160C80Relatórios de Progresso e Desempenho
04 - Desempenho dos Usuários  nas AtividadesEB382BE7-0443-4C33-B1B0-0E227D88B065Relatórios de Progresso e Desempenho
05 - Matriz de Módulos e Usuários  por AmbienteDDF16B0D-F32C-4C1F-9676-C80D95D9A6AARelatórios de Progresso e Desempenho
06 - Respostas Atividade FormularioED4242C0-AB87-4150-BC8D-36E353CDF5F4Relatórios de Atividades e Respostas
07 - Respostas Atividade PerguntaA1A4A801-B56B-44E6-B4C4-770EED14E356Relatórios de Atividades e Respostas
08 - Respostas Atividade Minigame88548E61-2C4E-4B57-A664-F1000B44617ERelatórios de Atividades e Respostas
09 - Respostas Atividade Prática32670305-0873-4C64-B2B5-E8D50BEE73C9Relatórios de Atividades e Respostas
10 - Comentarios do Canal DiretoE922316B-C8B9-4CA1-AA2C-F3EA4B1C7D5CRelatórios de Interação e Comunicação
11 - Comentários do Blog43E2DE01-B924-4A2E-8B14-EE028D8AF336Relatórios de Interação e Comunicação
12 - Notificações EnviadasC67F0172-C388-44E2-82D5-6BBD52AC62B7Relatórios de Interação e Comunicação
13 - Conquistas por Usuário21DC3230-A8B5-4622-9E3B-E2F9FB94CF15Relatórios de Gamificação e Ranking
14 - Extrato de Moedas652F90DE-A96E-4C28-88B5-F5B526F863C2Relatórios de Gamificação e Ranking
15 - Produtos da LojaC51BAF3F-6A5B-45E3-8E44-725A382F86CCRelatórios de Gamificação e Ranking
16 - Ranking38C86E3A-7E33-406E-B95F-BA52616F31C9Relatórios de Gamificação e Ranking
17 - Grupos e Usuários BF5FBA70-DFDD-47D5-9AD5-28BCA2F4B9DDRelatórios de Usuários e Grupos
18 - Relação de Usuários 86B7FE41-C7CE-4CE0-ACD1-E49E5EEBBB75Relatórios de Usuários e Grupos
19 - Status de Acesso a Plataforma por Usuário7F109F8C-562E-4597-9264-A360D3FD1FF0Relatórios de Acesso, Auditoria e Conformidade
20 - Log de Acessos a PlataformaFE5902CD-7AA6-4C5C-B554-D14A312AF847Relatórios de Acesso, Auditoria e Conformidade
21 - Log de autorização TOTPE27B6F40-D045-4D72-A108-99E5A528FE15Relatórios de Acesso, Auditoria e Conformidade
22 - Logs de Auditoria4E1A0017-F4A1-442E-8CA3-516D48C63A8FRelatórios de Acesso, Auditoria e Conformidade
23 - Log de DownloadsDD7CA98A-63DB-44BA-A350-D202A9A61B4CRelatórios de Acesso, Auditoria e Conformidade
24 - Termo de Aceite1C881F62-8443-4252-8ED6-D87C8DA3B966Relatórios de Acesso, Auditoria e Conformidade
25 - Atividades Vinculadas aos Módulos13710EDA-118F-45EE-A3AC-86237AD96293Relatórios de Acesso, Auditoria e Conformidade
Relação de Público-Alvo347FD0D0-D243-4D75-9F1B-5B8AC0CD6179Relatórios de Acesso, Auditoria e Conformidade





No caso de relatórios personalizados pode ser obtido através da URL na tela de extração do relatório:


Após montar o endpoint é necessário configurar a autenticação da chamado utilizando o token Bearer obtido no passo 2

Este artigo foi útil?

Que bom!

Obrigado pelo seu feedback

Desculpe! Não conseguimos ajudar você

Obrigado pelo seu feedback

Deixe-nos saber como podemos melhorar este artigo!

Selecione pelo menos um dos motivos
A verificação do CAPTCHA é obrigatória.

Feedback enviado

Agradecemos seu esforço e tentaremos corrigir o artigo