O que esse endpoint de API faz

Com a API de relatórios, você pode recuperar o relatório de atividades do usuário (com todas as sessões do usuário em toda a conta), obter uma lista das sessões do aluno de um curso ou plano de aprendizado específico, uma lista das sessões do curso dentro de um plano de aprendizado ou uma lista de todas as sessões do curso para um aluno específico.

• Endpoints
• Objeto da sessão
• Objeto do aluno do curso
• Objeto do curso do aluno
• Caminho de aprendizagem Objeto do curso
• Caminho de aprendizagem Objeto do aluno
• Objeto do curso em grupo
• Obter relatório de atividades
• Obtenha o relatório do aluno do curso
• Obtenha o relatório do curso para alunos
• Obtenha o relatório de cursos do Learning Path
• Obtenha o relatório de alunos do Learning Path
• Obtenha o relatório de cursos em grupo

Endpoints

• GET /reports/activity- relatório de atividades do usuário (lista de sessões do usuário)
• GET /reports/courses/{courseId}- relatório do aluno do curso (lista de sessões do aluno para um curso)
• GET /reports/learners/{userId}- relatório do curso do aluno (lista de sessões do curso para um aluno)
• GET /reports/learning-paths/{learningPathId}/courses- relatório de cursos do plano de aprendizagem (lista das sessões do curso em um plano de aprendizagem)
• GET /reports/learning-paths/{learningPathId}/learners- relatório de alunos do plano de aprendizagem (lista de sessões de alunos em um plano de aprendizagem)
• GET /reports/groups/{groupId}/courses- Learn• Relatório de cursos em grupo (retorna os cursos nos quais os membros do grupo estão matriculados)

Objeto da sessão (atividade do usuário com um curso)

• courseId(string) - identificador do curso
• courseTitle(string) - título do curso
• courseReportUrl(string) - URL para buscar o relatório do curso na API
• courseUrl(string) - URL para buscar detalhes do curso na API
• userId(string) - identificador do usuário
• email(string) - endereço de e-mail do usuário
• firstName(string) - o primeiro nome do usuário
• lastName(string) - o sobrenome do usuário
• learnerReportUrl(string) - URL para buscar o relatório do aluno do usuário na API
• userUrl(string) - URL para buscar os detalhes do usuário na API
• duration(string) - Duração da sessão do usuário formatada em ISO 8601
• numberOfLessonsCompleted(inteiro) - número de lições concluídas
• quizScorePercent(inteiro) - porcentagem da pontuação do questionário (se o questionário estiver presente)
• isQuizPassed(bool) - se o usuário passou no questionário ou não (se o questionário estiver presente)
• startedAt(string) - Carimbo de data/hora UTC formatado em ISO 8601 de quando a sessão foi iniciada
• userDeleted(bool) - se o usuário foi removido do Reach 360 ou não.
• courseDeleted(bool) - se o curso foi excluído.

Objeto do aluno do curso (usuário matriculado em um curso)

• userId(string) - identificador do usuário
• email(string) - endereço de e-mail do usuário
• firstName(string) - o primeiro nome do usuário
• lastName(string) - o sobrenome do usuário
• learnerReportUrl(string) - URL para buscar o relatório do aluno do usuário na API
• userUrl(string) - URL para buscar os detalhes do usuário na API
• duration(string) - Duração da sessão média do usuário em formato ISO 8601
• quizScorePercent(inteiro) - porcentagem da pontuação do questionário (se o questionário estiver presente)
• dueAt(string) - Carimbo de data/hora UTC formatado em ISO 8601 de quando o curso está previsto para o usuário (se aplicável)
• status(string) - status do curso para o usuário (um dos Not StartedIn Progress, ouComplete)
• completedAt(string) - Data e hora de quando o curso foi concluído pelo aluno ou. null
• userDeleted(bool) - se o usuário foi removido do Reach 360 ou não.
• progress(inteiro) - porcentagem de progresso

Objeto do curso do aluno (curso em que o aluno está matriculado)

• courseId(string) - identificador do curso
• courseTitle(string) - título do curso
• courseReportUrl(string) - URL para buscar o relatório do curso na API
• courseUrl(string) - URL para buscar detalhes do curso na API
• duration(string) - Duração da sessão média do usuário em formato ISO 8601
• quizScorePercent(inteiro) - porcentagem da pontuação do questionário (se o questionário estiver presente)
• dueAt(string) - Carimbo de data/hora UTC formatado em ISO 8601 de quando o curso está previsto para o usuário (se aplicável)
• status(string) - status do curso para o usuário (um dos Not StartedIn Progress, ouComplete)
• completedAt(string) - Data e hora de quando o curso foi concluído pelo aluno ou. null
• courseDeleted(bool) - se o curso foi excluído.
• progress(inteiro) - porcentagem de progresso

Caminho de aprendizagem Objeto do curso (curso em um plano de aprendizagem)

• courseId(string) ****- identificador do curso
• courseTitle(string) - título do curso
• courseUrl(string) - URL para buscar os detalhes do curso na API
• numberOfLessons(inteiro) - número de lições no curso
• averageDuration(string) - Duração da sessão média do usuário em formato ISO 8601
• courseReportUrl(string) - URL para buscar o relatório do curso na API
• courseDeleted(bool) - se o curso foi excluído.

Caminho de aprendizagem Objeto do aluno (aluno em um plano de aprendizagem)

• userId(string) - identificador do usuário
• email(string) - endereço de e-mail do usuário
• firstName(string) - o primeiro nome do usuário
• lastName(string) - o sobrenome do usuário
• learnerReportUrl(string) - URL para buscar o relatório do aluno do usuário na API
• userUrl(string) - URL para buscar os detalhes do usuário na API
• duration(string) - Duração da sessão média do usuário em formato ISO 8601
• dueAt(string) - Carimbo de data/hora UTC formatado em ISO 8601 de quando o plano de aprendizado está previsto para o usuário (se aplicável)
• status(string) - status do caminho de aprendizado para o usuário (um dos Not StartedIn Progress, ouComplete)
• userDeleted(bool) - se o usuário foi removido da conta do Reach 360 ou não.

Objeto do curso em grupo (curso em grupo)

• courseId(string) ****- identificador do curso
• courseTitle(string) - título do curso
• courseUrl(string) - URL para buscar os detalhes do curso na API
• averageDuration(string) - Duração da sessão média do usuário em formato ISO 8601
• courseReportUrl(string) - URL para buscar o relatório do curso na API
• courseDeleted(bool) - se o curso foi excluído
• enrollmentDeleted(bool) - se o grupo não estava matriculado no curso

Obter relatório de atividades

GET /reports/activity

Parâmetros de solicitação (sequência de caracteres de consulta)

• limit(inteiro, opcional) - o número máximo de resultados a serem retornados em uma única resposta (consulte Paginação); deve estar entre 1 e 2.000 (o padrão é 50)

Exemplo de resposta

{
“sessions”: [
{
“courseID”: “example-course-id-1", “courseDeleted”: false, 
 “courseTitle”: “Título do curso 1", 
 “courseReportUrl”: "https://api.reach360.com/reports/courses/example-course-id-1 “, “courseUrl”: "https://api.reach360.com/courses/example-course-id-1 
 “, “userId”: “example-user-id-1", 
 “firstName”: “Exemplo de primeiro nome 1", 
 “lastName”: “Exemplo de sobrenome 1", “learnerReportUrl”: "https://api.reach360.com/reports/learners/example-user-id-1 
 “, “userDeleted”: false,” 
 
 
 
 userUrl”: "https://api.reach360.com/users/example-user-id-1 “, 
 “duration”: “PT37.578S”, “numberOfLessonsCompleted”: 1, 
 “QuizScorePercent”: null, “isQuizPassed”: null, 
 “startedAt”: “2020-01-01T 12:30:00.000 Z”
},... 
 
 
], 
 “NextURL”: "https://url-for-next-page-of-results"} 

Obtenha o relatório do aluno do curso

GET /reports/courses/{courseId}

Parâmetros de solicitação (sequência de caracteres de consulta)

• limit(inteiro, opcional) - o número máximo de resultados a serem retornados em uma única resposta (consulte Paginação); deve estar entre 1 e 2.000 (o padrão é 50)

Exemplo de resposta

{
“courseDeleted”: false, 
 “courseUrl”: "https://api.reach360.com/courses/example-course-id “, “
alunos”: [
{“userId”: “example-user-id-1", 
 “firstName”: “Exemplo de primeiro nome 1", “sobrenome”: “Exemplo de sobrenome 1", 
 “learnerReportUrl”: "https://api.reach360.com/reports/learners/example-user-id-1 
 “, “userURL”: "https://api.reach360.com/users/example-user-id-1 “, “duration”: “PT7.3" 578S”, 
 “progresso”: 51, “quizScorePercent”: nulo, 
 “dueAt”: “2020-01-01T 12:30:00.000 Z”,
” 
 
 
 
 status”: “Concluído”, 
 “Usuário excluído”: false, 
 “completedAt”: “2019-12-31T 12:30:00.000 Z”,},... 
 
], 
 “NextURL”: "https://url-for-next-page-of-results"} 

Códigos de erro específicos do endpoint

• course_not_found- não é possível recuperar o relatório porque o curso não existe

Obtenha o relatório do curso para alunos

GET /reports/learners/{userId}

Parâmetros de solicitação (sequência de caracteres de consulta)

• limit(inteiro, opcional) - o número máximo de resultados a serem retornados em uma única resposta (consulte Paginação); deve estar entre 1 e 2.000 (o padrão é 50)

Exemplo de resposta

{
“userDeleted”: false, 
 “userUrl”: "https://api.reach360.com/users/example-user-id “, “courses”: [
{
“completedAt”: 
 “2019-12-31T 12:30:00.000 Z”, “courseDeleted”: false, 
 “courseID”: “example-course-id-1", 
 “courseTitle”: “CourseReportUrl”: "https://api.reach360.com/reports/courses/example-course-id-1 “, “courseUrl”: "https://api.reach360.com/courses/example-course-id-1 
 “, “duração”: “PT37.578S”, 
 “progresso”: 51, “quizScorePercent”: null, 
 “duEat”: “2020 
 
 
 
 -01-01T 12:30:00.000 Z”, 
 “status”: “Completo”},... 
 
], 
 “NextURL”: "https://url-for-next-page-of-results"} 

Códigos de erro específicos do endpoint

• user_not_found- não é possível recuperar o relatório porque o usuário não existe

Obtenha o relatório de cursos do Learning Path

GET /reports/learning-paths/{learningPathId}/courses

Parâmetros de solicitação (sequência de caracteres de consulta)

• limit(inteiro, opcional) - o número máximo de resultados a serem retornados em uma única resposta (consulte Paginação); deve estar entre 1 e 2.000 (o padrão é 50)

Exemplo de resposta

{
“learningPathDeleted”: false, 
 “learningPathUrl”: "https://api.reach360.com/learning-paths/example-learning-path-id “, “learnersReportUrl”: "https://api.reach360.com/reports/learning-paths/example-learning-path-id/learners 
 “, “courses”: [
{“courseDeleted”: false, “courseID”: 
 “example-course-1", 
 “courseTitle”: “Exemplo de curso”, 
 “courseURL”: "https://api.reach360.com/courses/example-course-1 “, “numberOfLessons”: 6, 
 “averagag“ Duration”: “PT37.578S”, 
 “URL do relatório do curso” 
 
 
 : "https://api.reach360.com/reports/courses/example-course-1"
},... 
], 
 “NextURL”: "https://url-for-next-page-of-results"} 

Códigos de erro específicos do endpoint

• learning_path_not_found- não é possível recuperar o relatório porque o caminho de aprendizado não existe

Obtenha o relatório de alunos do Learning Path

GET /reports/learning-paths/{learningPathId}/learners

Parâmetros de solicitação (sequência de caracteres de consulta)

• limit(inteiro, opcional) - o número máximo de resultados a serem retornados em uma única resposta (consulte Paginação); deve estar entre 1 e 2.000 (o padrão é 50)

Exemplo de resposta

{
“learningPathURL”: "https://api.reach360.com/learning-paths/example-learning-path-id “, 
 “coursesReportUrl”: "https://api.reach360.com/reports/learning-paths/example-learning-path-id/courses “, “
alunos”: [
{“duEat”: null, “duration”: 
 “PT37.578S”, 
 “FirstName”: “Exemplo de nome 1", 
 “lastName”: “Exemplo de sobrenome 1", “learnerReportUrl”: "https://api.reach360.com/reports/learners/example-user-id-1 
 “, “status”: “Completo”, 
 “userDeleted”: false, “ID do usuário”:” 
 
 
 exemplo-id-usuário-1", 
 “URL do usuário”: "https://api.reach360.com/users/example-user-id-1"},... 
 
], 
 “NextURL”: "https://url-for-next-page-of-results"} 

Códigos de erro específicos do endpoint

• learning_path_not_found- não é possível recuperar o relatório porque o caminho de aprendizado não existe

Obtenha o relatório de cursos em grupo

GET /reports/groups/{groupId}/courses

Parâmetros de solicitação (sequência de caracteres de consulta)

• limit(inteiro, opcional) - o número máximo de resultados a serem retornados em uma única resposta (consulte Paginação); deve estar entre 1 e 2000 (o padrão é 50)

Exemplo de resposta

< https://api.reach360.com/groups/example-group-1 >{ 
 “courses”: [
{“courseDeleted”: false, 
 “courseID”: 
 “example-course-1", “courseTitle”: “Exemplo de curso”, 
 “courseURL”: “”, “< https://api.reach360.com/courses/example-course-1 > averageDuration”: “PT0S”, 
 “courseReportUrl”: “”, 
 “< https://api.reach360.com/reports/courses/example-course-1 > enrollmentDeleted”: false},...], “groupDeleted”: false},...], 
 “groupDeleted”: false “groupUrl”: “”, 
 “NextURL”: “< 
 
 
 https://url-for-next-page-of-results >”
}

Códigos de erro específicos do endpoint

• group_not_found- não é possível recuperar o relatório porque o grupo não existe