Wat dit API-eindpunt doet

Met de Reports API kun je het rapport over gebruikersactiviteiten ophalen (met alle gebruikerssessies in het hele account), een lijst met cursistensessies voor een specifieke cursus of leertraject, een lijst met cursussessies binnen een leertraject of een lijst van alle cursuessessies voor een specifieke cursist.

• Eindpunten
• Sessieobject
• Object voor cursisten
• Cursusobject voor cursisten
• Cursusobject van het leerpad
• Leerpad Leerobject
• Cursusobject groeperen
• Activiteitenrapport ophalen
• Rapport voor cursisten ophalen
• Cursusrapport voor cursisten ophalen
• Ontvang een rapport over cursussen van het leertraject
• Rapport voor leerlingen van het leertraject opvragen
• Rapport voor groepscursussen ophalen

Eindpunten

• GET /reports/activity- rapport over gebruikersactiviteiten (lijst met gebruikerssessies)
• GET /reports/courses/{courseId}- rapport over cursisten (lijst met cursistensessies voor een cursus)
• GET /reports/learners/{userId}- cursusrapport voor cursisten (lijst met cursussessies voor een cursist)
• GET /reports/learning-paths/{learningPathId}/courses- rapport over leertrajectcursussen (lijst van cursussessies in een leertraject)
• GET /reports/learning-paths/{learningPathId}/learners- rapport over leertrajectcursisten (lijst van cursistensessies in een leertraject)
• GET /reports/groups/{groupId}/courses- Leren• Rapport groepscursussen (lijst met cursussessies in een groep)

Sessieobject (gebruikersactiviteit bij een cursus)

• courseId(string) - cursus-ID
• courseTitle(string) - titel van de cursus
• courseReportUrl(string) - URL om het cursusrapport op te halen uit de API
• courseUrl(string) - URL om cursusgegevens op te halen uit de API
• userId(string) - gebruikers-ID
• email(string) - e-mailadres van de gebruiker
• firstName(string) - de voornaam van de gebruiker
• lastName(string) - de achternaam van de gebruiker
• learnerReportUrl(string) - URL om het cursistenrapport van de gebruiker op te halen uit de API
• userUrl(string) - URL om gebruikersgegevens op te halen uit de API
• duration(string) - Duur van de gebruikerssessie in ISO 8601-indeling
• numberOfLessonsCompleted(integer) - aantal voltooide lessen
• quizScorePercent(geheel getal) - percentage van de quizscore (indien aanwezig)
• isQuizPassed(bool) - of de gebruiker geslaagd is voor de quiz of niet (indien de quiz aanwezig is)
• startedAt(string) - UTC-tijdstempel in ISO 8601-indeling van wanneer de sessie is gestart
• userDeleted(bool) - of de gebruiker al dan niet uit Reach 360 is verwijderd.
• courseDeleted(bool) - of de cursus is verwijderd.

Cursus Learner Object (gebruiker die is ingeschreven voor een cursus)

• userId(string) - gebruikers-ID
• email(string) - e-mailadres van de gebruiker
• firstName(string) - de voornaam van de gebruiker
• lastName(string) - de achternaam van de gebruiker
• learnerReportUrl(string) - URL om het cursistenrapport van de gebruiker op te halen uit de API
• userUrl(string) - URL om gebruikersgegevens op te halen uit de API
• duration(string) - duur van de gemiddelde gebruikerssessie in ISO 8601-indeling
• quizScorePercent(geheel getal) - percentage van de quizscore (indien aanwezig)
• dueAt(tekenreeks) - UTC-tijdstempel in ISO 8601-indeling voor de einddatum van de cursus voor de gebruiker (indien van toepassing)
• status(string) - status van de cursus voor de gebruiker (een vanNot Started,In Progress, ofComplete)
• completedAt(string) - Tijdstempel van wanneer de cursus is voltooid door de null cursist of.
• userDeleted(bool) - of de gebruiker al dan niet uit Reach 360 is verwijderd.
• progress(integer) - voortgangspercentage

Cursusobject voor cursisten (cursus waarvoor een cursist is ingeschreven)

• courseId(string) - cursus-ID
• courseTitle(string) - titel van de cursus
• courseReportUrl(string) - URL om het cursusrapport op te halen uit de API
• courseUrl(string) - URL om cursusgegevens op te halen uit de API
• duration(string) - duur van de gemiddelde gebruikerssessie in ISO 8601-indeling
• quizScorePercent(geheel getal) - percentage van de quizscore (indien aanwezig)
• dueAt(tekenreeks) - UTC-tijdstempel in ISO 8601-indeling voor de einddatum van de cursus voor de gebruiker (indien van toepassing)
• status(string) - status van de cursus voor de gebruiker (een vanNot Started,In Progress, ofComplete)
• completedAt(string) - Tijdstempel van wanneer de cursus is voltooid door de null cursist of.
• courseDeleted(bool) - of de cursus is verwijderd.
• progress(integer) - voortgangspercentage

Learning Path Course Object (cursus in een leertraject)

• courseId(tekenreeks) ****- cursus-ID
• courseTitle(string) - titel van de cursus
• courseUrl(string) - URL om de cursusgegevens op te halen uit de API
• numberOfLessons(integer) - aantal lessen in de cursus
• averageDuration(string) - duur van de gemiddelde gebruikerssessie in ISO 8601-indeling
• courseReportUrl(string) - URL om het cursusrapport op te halen uit de API
• courseDeleted(bool) - of de cursus is verwijderd.

Learning Path Learner Object (cursist in een leertraject)

• userId(string) - gebruikers-ID
• email(string) - e-mailadres van de gebruiker
• firstName(string) - de voornaam van de gebruiker
• lastName(string) - de achternaam van de gebruiker
• learnerReportUrl(string) - URL om het cursistenrapport van de gebruiker op te halen uit de API
• userUrl(string) - URL om gebruikersgegevens op te halen uit de API
• duration(string) - duur van de gemiddelde gebruikerssessie in ISO 8601-indeling
• dueAt(tekenreeks) - UTC-tijdstempel in ISO 8601-formaat die aangeeft wanneer de leerweg moet worden afgelegd voor de gebruiker (indien van toepassing)
• status(string) - status van het leerpad voor de gebruiker (een vanNot Started,In Progress, ofComplete)
• userDeleted(bool) - of de gebruiker al dan niet uit het Reach 360-account is verwijderd.

Cursusobject groeperen (cursus in een groep)

• courseId(tekenreeks) ****- cursus-ID
• courseTitle(string) - titel van de cursus
• courseUrl(string) - URL om de cursusgegevens op te halen uit de API
• averageDuration(string) - duur van de gemiddelde gebruikerssessie in ISO 8601-indeling
• courseReportUrl(string) - URL om het cursusrapport op te halen uit de API
• courseDeleted(bool) - of de cursus is verwijderd
• enrollmentDeleted(bool) - of de groep is afgemeld voor de cursus

Activiteitenrapport ophalen

GET /reports/activity

Verzoekparameters (queryreeks)

• limit(geheel getal, optioneel) - het maximale aantal resultaten dat in één antwoord kan worden geretourneerd (zie Paginering); moet tussen 1 en 2.000 liggen (standaard 50)

Voorbeeldreactie

{
„sessions”: [
{
„courseId”: „examplecourse-id-1", „courseDeleted”: false, 
 „courseTitle”: „Cursustitel 1", 
 „courseReportURL”: "https://api.reach360.com/reports/courses/example-course-id-1 „, 
 „courseURL”: "https://api.reach360.com/courses/example-course-id-1 „, „userID”: „exampleuser-id-1", 
 „firstName”: „Voorbeeld Voornaam 1", 
 „Achternaam”: „Voorbeeld Achternaam 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"} 

Rapport voor cursisten ophalen

GET /reports/courses/{courseId}

Verzoekparameters (queryreeks)

• limit(geheel getal, optioneel) - het maximale aantal resultaten dat in één antwoord kan worden geretourneerd (zie Paginering); moet tussen 1 en 2.000 liggen (standaard 50)

Voorbeeldreactie

{
„courseDeleted”: false, 
 „courseURL”: "https://api.reach360.com/courses/example-course-id „, „
cursisten”: [
{„userId”: „exampleuser-id-1", 
 „firstName”: „Voorbeeld Voornaam 1", „Achternaam”: 
 „Voorbeeld Achternaam 1", „LearnerReportURL”: "https://api.reach360.com/reports/learners/example-user-id-1 
 „, „userURL”: "https://api.reach360.com/users/example-user-id-1 „, 
 „duration”: „PT37.578S”, „vooruitgang”: 51, 
 „QuizScorePercent”: null, „dueAT”: 
 „2020-01-01T 12:30:00.000 Z”, 
 
 
 
 „status”: „Volledig”, 
 „userDeleted”: false, „completedAt”: 
 „2019-12-31T 12:30:00.000 Z”,},... 
 
], 
 „NextURL”: "https://url-for-next-page-of-results"} 

Endpoint-specifieke foutcodes

• course_not_found- kan het rapport niet ophalen omdat de cursus niet bestaat

Cursusrapport voor cursisten ophalen

GET /reports/learners/{userId}

Verzoekparameters (queryreeks)

• limit(geheel getal, optioneel) - het maximale aantal resultaten dat in één antwoord kan worden geretourneerd (zie Paginering); moet tussen 1 en 2.000 liggen (standaard 50)

Voorbeeldreactie

{
„userDeleted”: false, 
 „userUrl”: "https://api.reach360.com/users/example-user-id „, „courses”: [
{
„completedAt”: 
 „2019-12-31T 12:30:00.000 Z”, „courseDeleted”: false, „courseID”: 
 „examplecourse-id-1", „CourseTitle”: 
 „Cursustitel 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”, 
 „vooruitgang”: 51, „QuizScorePercent”: null, 
 „duEat”: 
 
 
 
 „2020-01-01T 12:30:00.000 Z”, 
 „status”: „Compleet”},... 
 
], 
 „NextURL”: "https://url-for-next-page-of-results"} 

Endpoint-specifieke foutcodes

• user_not_found- kan het rapport niet ophalen omdat de gebruiker niet bestaat

Ontvang een rapport over cursussen van het leertraject

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

Verzoekparameters (queryreeks)

• limit(geheel getal, optioneel) - het maximale aantal resultaten dat in één antwoord kan worden geretourneerd (zie Paginering); moet tussen 1 en 2.000 liggen (standaard 50)

Voorbeeldreactie

{
„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”: 
 „examplecourse-1", „courseTitle”: 
 „Voorbeeldcursus”, „CourseURL”: "https://api.reach360.com/courses/example-course-1 „, „numberOfLessons”: 6, 
 „AverageDuration”: „PT37.578S”,
” 
 
 
 CourseReportURL”: "https://api.reach360.com/reports/courses/example-course-1"},... 
 
], 
 „NextURL”: "https://url-for-next-page-of-results"} 

Endpoint-specifieke foutcodes

• learning_path_not_found- kan het rapport niet ophalen omdat de leerweg niet bestaat

Rapport voor leerlingen van het leertraject opvragen

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

Verzoekparameters (queryreeks)

• limit(geheel getal, optioneel) - het maximale aantal resultaten dat in één antwoord kan worden geretourneerd (zie Paginering); moet tussen 1 en 2.000 liggen (standaard 50)

Voorbeeldreactie

{
„learningPathUrl”: "https://api.reach360.com/learning-paths/example-learning-path-id „, 
 „coursesReportURL”: "https://api.reach360.com/reports/learning-paths/example-learning-path-id/courses „, „
cursisten”: [
{„duEat”: null, „duration”: 
 „PT37.578S”, 
 „firstName”: „Voorbeeld Voornaam 1", „Achternaam”: 
 „Voorbeeld Achternaam 1", „LearnerReportURL”: "https://api.reach360.com/reports/learners/example-user-id-1 
 „, „status”: „Compleet”, 
 „UserDeleted”: false, „UserId” 
 
 
 : „exampleuser-id-1", 
 „userUrl”: "https://api.reach360.com/users/example-user-id-1"},... 
 
], 
 „NextURL”: "https://url-for-next-page-of-results"} 

Endpoint-specifieke foutcodes

• learning_path_not_found- kan het rapport niet ophalen omdat de leerweg niet bestaat

Rapport voor groepscursussen ophalen

GET /reports/groups/{groupId}/courses

Verzoekparameters (queryreeks)

• limit(geheel getal, optioneel) - het maximale aantal resultaten dat in één antwoord kan worden geretourneerd (zie Paginering); moet tussen 1 en 2000 liggen (standaard 50)

Voorbeeldreactie

< https://api.reach360.com/groups/example-group-1 >{ 
 „courses”: [
{
„courseDeleted”: false, „courseID”: 
 „voorbeeld-cursus-1", „courseTitle”: „Voorbeeldcursus”, 
 „cursusURL”: „”, „< 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” URL”: 
 „”, „NextURL”: „< 
 
 
 https://url-for-next-page-of-results >”
}

Endpoint-specifieke foutcodes

• group_not_found- kan het rapport niet ophalen omdat de groep niet bestaat