Cosa fa questo endpoint API

Con l'API Reports puoi recuperare il rapporto sulle attività degli utenti (con tutte le sessioni utente a livello di account), ottenere un elenco delle sessioni degli studenti per un corso o un percorso di apprendimento specifico, un elenco delle sessioni del corso all'interno di un percorso di apprendimento o un elenco di tutte le sessioni del corso per uno studente specifico.

• Endpoint
• Oggetto di sessione
• Oggetto del corso per lo studente
• Oggetto del corso per studenti
• Oggetto del corso Learning Path
• Oggetto del percorso di apprendimento
• Oggetto del corso di gruppo
• Ottieni un rapporto sulle attività
• Richiedi il rapporto sullo studente del corso
• Richiedi il rapporto sul corso per studenti
• Ottieni il rapporto sui corsi del percorso di apprendimento
• Ottieni il rapporto sugli studenti di Learning Path
• Richiedi il rapporto sui corsi di gruppo

Endpoint

• GET /reports/activity- rapporto sull'attività dell'utente (elenco delle sessioni utente)
• GET /reports/courses/{courseId}- rapporto sullo studente del corso (elenco delle sessioni per allievo per un corso)
• GET /reports/learners/{userId}- rapporto sul corso per allievo (elenco delle sessioni del corso per uno studente)
• GET /reports/learning-paths/{learningPathId}/courses- rapporto sui corsi del percorso di apprendimento (elenco delle sessioni del corso in un percorso di apprendimento)
• GET /reports/learning-paths/{learningPathId}/learners- rapporto sugli allievi del percorso di apprendimento (elenco delle sessioni degli allievi in un percorso di apprendimento)
• GET /reports/groups/{groupId}/courses- Learn• Report sui corsi di gruppo (elenco delle sessioni del corso in un gruppo)

Oggetto della sessione (attività dell'utente con un corso)

• courseId(stringa) - identificatore del corso
• courseTitle(stringa) - titolo del corso
• courseReportUrl(string) - URL per recuperare il rapporto sul corso dall'API
• courseUrl(string) - URL per recuperare i dettagli del corso dall'API
• userId(stringa) - identificatore utente
• email(stringa) - indirizzo email dell'utente
• firstName(string) - il nome dell'utente
• lastName(string) - il cognome dell'utente
• learnerReportUrl(string) - URL per recuperare il rapporto sullo studente dell'utente dall'API
• userUrl(stringa) - URL per recuperare i dettagli dell'utente dall'API
• duration(stringa) - Durata della sessione utente in formato ISO 8601
• numberOfLessonsCompleted(intero) - numero di lezioni completate
• quizScorePercent(numero intero) - percentuale del punteggio del quiz (se il quiz è presente)
• isQuizPassed(bool) - se l'utente ha superato o meno il quiz (se il quiz è presente)
• startedAt(stringa) - Timestamp UTC in formato ISO 8601 relativo all'inizio della sessione
• userDeleted(bool) - se l'utente è stato rimosso da Reach 360 o meno.
• courseDeleted(bool) - se il corso è stato eliminato.

Course Learner Object (utente iscritto a un corso)

• userId(stringa) - identificatore utente
• email(stringa) - indirizzo email dell'utente
• firstName(string) - il nome dell'utente
• lastName(string) - il cognome dell'utente
• learnerReportUrl(string) - URL per recuperare il rapporto sullo studente dell'utente dall'API
• userUrl(stringa) - URL per recuperare i dettagli dell'utente dall'API
• duration(stringa) - Durata della sessione utente media in formato ISO 8601
• quizScorePercent(numero intero) - percentuale del punteggio del quiz (se il quiz è presente)
• dueAt(stringa) - Timestamp UTC in formato ISO 8601 di quando il corso è dovuto per l'utente (se applicabile)
• status(stringa) - stato del corso per l'utente (uno di Not StartedIn Progress, oComplete)
• completedAt(stringa) - Timestamp di quando il corso è stato completato dall'allievo o. null
• userDeleted(bool) - se l'utente è stato rimosso da Reach 360 o meno.
• progress(intero) - percentuale di avanzamento

Oggetto del corso per studenti (corso a cui è iscritto un allievo)

• courseId(stringa) - identificatore del corso
• courseTitle(stringa) - titolo del corso
• courseReportUrl(string) - URL per recuperare il rapporto sul corso dall'API
• courseUrl(string) - URL per recuperare i dettagli del corso dall'API
• duration(stringa) - Durata della sessione utente media in formato ISO 8601
• quizScorePercent(numero intero) - percentuale del punteggio del quiz (se il quiz è presente)
• dueAt(stringa) - Timestamp UTC in formato ISO 8601 di quando il corso è dovuto per l'utente (se applicabile)
• status(stringa) - stato del corso per l'utente (uno di Not StartedIn Progress, oComplete)
• completedAt(stringa) - Timestamp di quando il corso è stato completato dall'allievo o. null
• courseDeleted(bool) - se il corso è stato eliminato.
• progress(intero) - percentuale di avanzamento

Learning Path Oggetto del corso (corso in un percorso di apprendimento)

• courseId(stringa) ****- identificatore del corso
• courseTitle(stringa) - titolo del corso
• courseUrl(string) - URL per recuperare i dettagli del corso dall'API
• numberOfLessons(intero) - numero di lezioni del corso
• averageDuration(stringa) - Durata della sessione utente media in formato ISO 8601
• courseReportUrl(string) - URL per recuperare il rapporto sul corso dall'API
• courseDeleted(bool) - se il corso è stato eliminato.

Learning Path Learner Object (allievo in un percorso di apprendimento)

• userId(stringa) - identificatore utente
• email(stringa) - indirizzo email dell'utente
• firstName(string) - il nome dell'utente
• lastName(string) - il cognome dell'utente
• learnerReportUrl(string) - URL per recuperare il rapporto sullo studente dell'utente dall'API
• userUrl(stringa) - URL per recuperare i dettagli dell'utente dall'API
• duration(stringa) - Durata della sessione utente media in formato ISO 8601
• dueAt(stringa) - Timestamp UTC in formato ISO 8601 che indica quando il percorso di apprendimento è previsto per l'utente (se applicabile)
• status(stringa) - stato del percorso di apprendimento per l'utente (uno di Not StartedIn Progress, oComplete)
• userDeleted(bool) - se l'utente è stato rimosso dall'account Reach 360 o meno.

Oggetto del corso di gruppo (corso in gruppo)

• courseId(stringa) ****- identificatore del corso
• courseTitle(stringa) - titolo del corso
• courseUrl(string) - URL per recuperare i dettagli del corso dall'API
• averageDuration(stringa) - Durata della sessione utente media in formato ISO 8601
• courseReportUrl(string) - URL per recuperare il rapporto sul corso dall'API
• courseDeleted(bool) - se il corso è stato eliminato
• enrollmentDeleted(bool) - se il gruppo è stato cancellato dal corso

Ottieni un rapporto sulle attività

GET /reports/activity

Parametri della richiesta (stringa di query)

• limit(intero, opzionale): il numero massimo di risultati da restituire in una singola risposta (vedi Pagination); deve essere compreso tra 1 e 2.000 (il valore predefinito è 50)

Esempio di risposta

{
«sessions»: [
{
«courseID»: «example-course-id-1", «courseDeleted»: false, 
 «courseTitle»: «Titolo del corso 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»: 
 «Esempio nome 1", «lastName» Name»: 
 «Esempio di cognome 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"}

Scarica il rapporto sullo studente del corso

GET /reports/courses/{courseId}

Parametri della richiesta (stringa di query)

• limit(intero, opzionale): il numero massimo di risultati da restituire in una singola risposta (vedi Pagination); deve essere compreso tra 1 e 2.000 (il valore predefinito è 50)

Esempio di risposta

{
«courseDeleted»: false, 
 «courseUrl»: "https://api.reach360.com/courses/example-course-id «, «
learners»: [
{«userId»: «example-user-id-1", 
 «firstName»: «Nome di esempio 1", «lastName»: 
 «Cognome di esempio 1", «learnerReportURL»: "https://api.reach360.com/reports/learners/example-user-id-1 
 «, «userUrl»: "https://api.reach360.com/users/example-user-id-1 «, «duration»: «PT37.5785 S», 
 «progresso»: 51, «quizScorePercent»: nullo, 
 «dueAt»: «2020-01-01T 12:30:00.000 Z», 
 
 
 
 
 «status»: «Complete», 
 «userDeleted»: false, 
 «completedAt»: «2019-12-31T 12:30:00.000 Z»,
},... 
], «nextUrl»: "https://url-for-next-page-of-results"} 
 

Codici di errore specifici dell'endpoint

• course_not_found- impossibile recuperare il rapporto perché il corso non esiste

Ottieni il rapporto sul corso per studenti

GET /reports/learners/{userId}

Parametri della richiesta (stringa di query)

• limit(intero, opzionale): il numero massimo di risultati da restituire in una singola risposta (vedi Pagination); deve essere compreso tra 1 e 2.000 (il valore predefinito è 50)

Esempio di risposta

{
«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»: 
 «Titolo del corso 1", «courseReportUrl»: "https://api.reach360.com/reports/courses/example-course-id-1 
 «, «courseUrl»: "https://api.reach360.com/courses/example-course-id-1 «, «duration»: «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"} 
 

Codici di errore specifici dell'endpoint

• user_not_found- impossibile recuperare il rapporto perché l'utente non esiste

Ottieni il rapporto sui corsi del percorso di apprendimento

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

Parametri della richiesta (stringa di query)

• limit(intero, opzionale): il numero massimo di risultati da restituire in una singola risposta (vedi Pagination); deve essere compreso tra 1 e 2.000 (il valore predefinito è 50)

Esempio di risposta

{
«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»: "https://api.reach360.com/courses/example-course-1 
 «, «courseID»: 
 «example-course-1", 
 «courseTitle»: «Corso di esempio», «courseUrl»: "
«, «numberOfLezioni»: 6, Durata media»: «PT37.578S»,
» 
 
 
 CourseReportUrl»: "https://api.reach360.com/reports/courses/example-course-1"},... 
 
], 
 «nextUrl»: "https://url-for-next-page-of-results"} 

Codici di errore specifici dell'endpoint

• learning_path_not_found- impossibile recuperare il rapporto perché il percorso di apprendimento non esiste

Scarica il rapporto sugli studenti del percorso di apprendimento

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

Parametri della richiesta (stringa di query)

• limit(intero, opzionale): il numero massimo di risultati da restituire in una singola risposta (vedi Pagination); deve essere compreso tra 1 e 2.000 (il valore predefinito è 50)

Esempio di risposta

{
«learningPathUrl»: "https://api.reach360.com/learning-paths/example-learning-path-id «, 
 «coursesReportUrl»: "https://api.reach360.com/reports/learning-paths/example-learning-path-id/courses «, «
learners»: [
{«duEat»: null, 
 «duration»: «PT37.578S», 
 «firstName»: «Nome di esempio 1", 
 «lastName»: «Esempio di cognome 1", «learnerReportURL»: "https://api.reach360.com/reports/learners/example-user-id-1 
 «, «status»: «Complete», userDeleted»: falso, 
 «userId» 
 
 
 : «example-user-id-1", 
 «userUrl»: "https://api.reach360.com/users/example-user-id-1"
},... 
], 
 «nextUrl»: "https://url-for-next-page-of-results"} 

Codici di errore specifici dell'endpoint

• learning_path_not_found- impossibile recuperare il rapporto perché il percorso di apprendimento non esiste

Richiedi il rapporto sui corsi di gruppo

GET /reports/groups/{groupId}/courses

Parametri della richiesta (stringa di query)

• limit(intero, opzionale): il numero massimo di risultati da restituire in una singola risposta (vedi Pagination); deve essere compreso tra 1 e 2000 (il valore predefinito è 50)

Esempio di risposta

< https://api.reach360.com/groups/example-group-1 >{ 
 «courses»: [
{«courseDeleted»: false, 
 «courseID»: «example-course-1", 
 «courseTitle»: «Corso di esempio», «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},...], 
 «groupDeleted»: false},...], «groupUrl»: «», 
 «nextUrl»: «< 
 
 
 {«courses
»: [{«courseDeleted»: false, «courseID»: «example-course-1", «courseTitle»: «Corso di esempio», «courseURL»: «», «averageDuration»: «PT0S», «courseReportUrl»: «», «enrollmentDeleted»: false},...], «groupDeleted»: false},...], «groupDeleted»: false},...], «groupDeleted»: false},...], «groupUrl»: «», «nextUrl»: «»}

Codici di errore specifici dell'endpoint

• group_not_found- impossibile recuperare il rapporto perché il gruppo non esiste