Was dieser API-Endpunkt macht

Mit der Berichts-API können Sie den Benutzeraktivitätsbericht (mit allen Benutzersitzungen kontoweit), eine Liste der Lernsitzungen für einen bestimmten Kurs oder Lernpfad, eine Liste der Kurssitzungen innerhalb eines Lernpfads oder eine Liste aller Kurssitzungen für einen bestimmten Lernenden abrufen.

• Endpunkte
• Sitzungsobjekt
• Objekt für Kursteilnehmer
• Kursobjekt für Lernende
• Kursobjekt „Lernpfad“
• Lernpfad, Objekt „Lernender“
• Objekt „Gruppenkurs“
• Aktivitätsbericht abrufen
• Holen Sie sich den Bericht für Kursteilnehmer
• Holen Sie sich den Kursbericht für Lernende
• Holen Sie sich den Bericht über Lernpfad-Kurse
• Holen Sie sich den Learning Path-Bericht für Lernende
• Holen Sie sich den Bericht über Gruppenkurse

Endpunkte

• GET /reports/activity- Bericht über Benutzeraktivitäten (Liste der Benutzersitzungen)
• GET /reports/courses/{courseId}- Bericht über Kursteilnehmer (Liste der Lernsitzungen für einen Kurs)
• GET /reports/learners/{userId}- Kursbericht für Teilnehmer (Liste der Kurseinheiten für einen Lernenden)
• GET /reports/learning-paths/{learningPathId}/courses- Bericht über Lernpfad-Kurse (Liste der Kurseinheiten in einem Lernpfad)
• GET /reports/learning-paths/{learningPathId}/learners- Bericht der Lernenden über den Lernpfad (Liste der Lernsitzungen in einem Lernpfad)
• GET /reports/groups/{groupId}/courses- Bericht „Learn• Gruppenkurse“ (Liste der Kurseinheiten in einer Gruppe)

Sitzungsobjekt (Benutzeraktivität in einem Kurs)

• courseId(string) — Kurs-ID
• courseTitle(string) - Titel des Kurses
• courseReportUrl(string) — URL zum Abrufen des Kursberichts von der API
• courseUrl(string) — URL zum Abrufen der Kursdetails von der API
• userId(string) — Benutzer-ID
• email(string) — E-Mail-Adresse des Benutzers
• firstName(string) — der Vorname des Benutzers
• lastName(string) - der Nachname des Benutzers
• learnerReportUrl(string) — URL zum Abrufen des Lernerberichts des Benutzers von der API
• userUrl(string) — URL zum Abrufen der Benutzerdetails von der API
• duration(string) — Dauer der Benutzersitzung im ISO 8601-Format
• numberOfLessonsCompleted(Ganzzahl) — Anzahl der abgeschlossenen Lektionen
• quizScorePercent(Ganzzahl) - Prozentsatz der Quizpunktzahl (falls das Quiz vorhanden ist)
• isQuizPassed(bool) - ob der Benutzer das Quiz bestanden hat oder nicht (falls das Quiz vorhanden ist)
• startedAt(string) — UTC-Zeitstempel im ISO 8601-Format für den Beginn der Sitzung
• userDeleted(bool) — ob der Benutzer aus Reach 360 entfernt wurde oder nicht.
• courseDeleted(bool) — ob der Kurs gelöscht wurde.

Course Learner Object (Benutzer, der in einen Kurs eingeschrieben ist)

• userId(Zeichenfolge) — Benutzer-ID
• email(string) — E-Mail-Adresse des Benutzers
• firstName(string) — der Vorname des Benutzers
• lastName(string) - der Nachname des Benutzers
• learnerReportUrl(string) — URL zum Abrufen des Lernerberichts des Benutzers von der API
• userUrl(string) — URL zum Abrufen der Benutzerdetails von der API
• duration(string) — Dauer einer durchschnittlichen Benutzersitzung im ISO 8601-Format
• quizScorePercent(Ganzzahl) - Prozentsatz der Quizpunktzahl (falls das Quiz vorhanden ist)
• dueAt(string) — UTC-Zeitstempel im ISO-8601-Format, der angibt, wann der Kurs für den Benutzer fällig ist (falls zutreffend)
• status(string) — Kursstatus für den Benutzer (einer von, oder) Not Started In Progress Complete
• completedAt(string) — Zeitstempel, wann der Kurs vom Lernenden abgeschlossen wurde oder. null
• userDeleted(bool) — ob der Benutzer aus Reach 360 entfernt wurde oder nicht.
• progress(Ganzzahl) — Prozentsatz des Fortschritts

Kursobjekt für Teilnehmer (Kurs, für den ein Teilnehmer angemeldet ist)

• courseId(string) — Kurs-ID
• courseTitle(string) - Titel des Kurses
• courseReportUrl(string) — URL zum Abrufen des Kursberichts von der API
• courseUrl(string) — URL zum Abrufen der Kursdetails von der API
• duration(string) — Dauer einer durchschnittlichen Benutzersitzung im ISO 8601-Format
• quizScorePercent(Ganzzahl) - Prozentsatz der Quizpunktzahl (falls das Quiz vorhanden ist)
• dueAt(string) — UTC-Zeitstempel im ISO-8601-Format, der angibt, wann der Kurs für den Benutzer fällig ist (falls zutreffend)
• status(string) — Kursstatus für den Benutzer (einer von, oder) Not Started In Progress Complete
• completedAt(string) — Zeitstempel, wann der Kurs vom Lernenden abgeschlossen wurde oder. null
• courseDeleted(bool) — ob der Kurs gelöscht wurde.
• progress(Ganzzahl) — Prozentsatz des Fortschritts

Lernpfad Kursobjekt (Kurs in einem Lernpfad)

• courseId(Zeichenfolge) ****- Kurs-ID
• courseTitle(string) — Titel des Kurses
• courseUrl(string) — URL zum Abrufen der Kursdetails von der API
• numberOfLessons(Ganzzahl) — Anzahl der Lektionen im Kurs
• averageDuration(string) — Dauer einer durchschnittlichen Benutzersitzung im ISO 8601-Format
• courseReportUrl(string) — URL zum Abrufen des Kursberichts von der API
• courseDeleted(bool) — ob der Kurs gelöscht wurde.

Lernpfad Lernerobjekt (Lernender in einem Lernpfad)

• userId(Zeichenfolge) — Benutzer-ID
• email(string) — E-Mail-Adresse des Benutzers
• firstName(string) — der Vorname des Benutzers
• lastName(string) - der Nachname des Benutzers
• learnerReportUrl(string) — URL zum Abrufen des Lernerberichts des Benutzers von der API
• userUrl(string) — URL zum Abrufen der Benutzerdetails von der API
• duration(string) — Dauer einer durchschnittlichen Benutzersitzung im ISO 8601-Format
• dueAt(string) — UTC-Zeitstempel im ISO 8601-Format, der angibt, wann der Lernpfad für den Benutzer fällig ist (falls zutreffend)
• status(string) — Status des Lernpfads für den Benutzer (einer von Not StartedIn Progress, oderComplete)
• userDeleted(bool) — ob der Benutzer aus dem Reach 360-Konto entfernt wurde oder nicht.

Gruppenkursobjekt (Kurs in einer Gruppe)

• courseId(Zeichenfolge) ****- Kurs-ID
• courseTitle(string) — Titel des Kurses
• courseUrl(string) — URL zum Abrufen der Kursdetails von der API
• averageDuration(string) — Dauer einer durchschnittlichen Benutzersitzung im ISO 8601-Format
• courseReportUrl(string) — URL zum Abrufen des Kursberichts von der API
• courseDeleted(bool) — ob der Kurs gelöscht wurde
• enrollmentDeleted(bool) — ob die Gruppe vom Kurs abgemeldet wurde

Aktivitätsbericht abrufen

GET /reports/activity

Anforderungsparameter (Abfragezeichenfolge)

• limit(Ganzzahl, optional) — die maximale Anzahl von Ergebnissen, die in einer einzigen Antwort zurückgegeben werden können (siehe Paginierung); muss zwischen 1 und 2.000 liegen (standardmäßig 50)

Beispiel für eine Antwort

{
„sessions“: [
{
„courseID“: „example-course-id-1", „courseDeleted“: false, 
 „courseTitle“: 
 „Kurstitel 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“: 
 „Beispiel Vorname 1", „lastName“: „Beispiel Nachname 1", 
 „learnerReportUrl“: "https://api.reach360.com/reports/learners/example-user-id-1 „, 
 „userDeleted“: falsch, 
 
 
„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“
},... 
]
, „nächste URL
“: "https://url-for-next-page-of-results"}

Holen Sie sich den Bericht für Kursteilnehmer

GET /reports/courses/{courseId}

Anforderungsparameter (Abfragezeichenfolge)

• limit(Ganzzahl, optional) — die maximale Anzahl von Ergebnissen, die in einer einzigen Antwort zurückgegeben werden können (siehe Paginierung); muss zwischen 1 und 2.000 liegen (standardmäßig 50)

Beispiel für eine Antwort

{
„courseDeleted“: false, 
 „courseUrl“: "https://api.reach360.com/courses/example-course-id „, „learners“: [
{
„userId“: 
 „example-user-id-1", „firstName“: „Beispiel Vorname 1", 
 „lastName“: „Beispiel Nachname 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“, „Fortschritt“: 51, 
 „QuizScorePercent“: null, 
 „dueAt“: „2020-01-01T 12:30:00.000 Z“, 
 
 
 
 „status“: „Vollständig“, 
 „userDeleted“: falsch, 
 „completedAt“: „2019-12-31T 12:30:00.000 Z“,
},... 
], „nächste URL“: "https://url-for-next-page-of-results"} 
 

Endpunktspezifische Fehlercodes

• course_not_found- Der Bericht kann nicht abgerufen werden, da der Kurs nicht existiert

Holen Sie sich den Kursbericht für Lernende

GET /reports/learners/{userId}

Anforderungsparameter (Abfragezeichenfolge)

• limit(Ganzzahl, optional) — die maximale Anzahl von Ergebnissen, die in einer einzigen Antwort zurückgegeben werden können (siehe Paginierung); muss zwischen 1 und 2.000 liegen (standardmäßig 50)

Beispiel für eine Antwort

{
„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“: „Kurstitel 1", 
 „courseReportUrl“: "https://api.reach360.com/reports/courses/example-course-id-1 „, „courseUrl“: "
„, „courseUrl“: "https://api.reach360.com/courses/example-course-id-1 „, 
 „Dauer“: „PT37.578S“, „Fortschritt“: 51, 
 „QuizScorePercent“: null, „dueAt“: 
 
 
 
 „2020-01-01T 12:30:00.000 Z“, 
 „status“: „Abgeschlossen“
},... 
], 
 „nächste URL“: "https://url-for-next-page-of-results"} 

Endpunktspezifische Fehlercodes

• user_not_found- Der Bericht kann nicht abgerufen werden, da der Benutzer nicht existiert

Holen Sie sich den Bericht über die Learning Path-Kurse

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

Anforderungsparameter (Abfragezeichenfolge)

• limit(Ganzzahl, optional) — die maximale Anzahl von Ergebnissen, die in einer einzigen Antwort zurückgegeben werden können (siehe Paginierung); muss zwischen 1 und 2.000 liegen (standardmäßig 50)

Beispiel für eine Antwort

{
„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“: „Beispielkurs“, 
 „courseUrl“: "https://api.reach360.com/courses/example-course-1 
 „, „numberOfLessons“: 6, „averageUrl“: "„, 
 „numberOfLessons“: 6, „averageUrl“ Duration“: „PT37.578S“,
“ 
 
 
 CourseReportUrl“: "https://api.reach360.com/reports/courses/example-course-1"
},... 
], 
 „nächste URL“: "https://url-for-next-page-of-results"} 

Endpunktspezifische Fehlercodes

• learning_path_not_found- Bericht kann nicht abgerufen werden, da kein Lernpfad existiert

Holen Sie sich den Learning Path-Bericht für Lernende

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

Anforderungsparameter (Abfragezeichenfolge)

• limit(Ganzzahl, optional) — die maximale Anzahl von Ergebnissen, die in einer einzigen Antwort zurückgegeben werden können (siehe Paginierung); muss zwischen 1 und 2.000 liegen (standardmäßig 50)

Beispiel für eine Antwort

{
„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“: „Beispiel Vorname 1", 
 „lastName“: „Beispiel Nachname 1", „learnerReportUrl“: "https://api.reach360.com/reports/learners/example-user-id-1 
 „, „status“: „Vollständig“, 
 „UserDeleted““: falsch, „BenutzerID“ 
 
 
 : „Beispiel-Benutzer-ID-1", 
 „userUrl“: "https://api.reach360.com/users/example-user-id-1"
},... 
], 
 „nächste URL“: "https://url-for-next-page-of-results"} 

Endpunktspezifische Fehlercodes

• learning_path_not_found- Bericht kann nicht abgerufen werden, da kein Lernpfad existiert

Bericht über Gruppenkurse abrufen

GET /reports/groups/{groupId}/courses

Anforderungsparameter (Abfragezeichenfolge)

• limit(Ganzzahl, optional) — die maximale Anzahl von Ergebnissen, die in einer einzigen Antwort zurückgegeben werden können (siehe Paginierung); muss zwischen 1 und 2000 liegen (standardmäßig 50)

Beispiel für eine Antwort

< https://api.reach360.com/groups/example-group-1 >{ 
 „courses“: [
{
„courseDeleted“: false, 
 „courseID“: „example-course-1", „courseTitle“: 
 „Beispielkurs“, „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, 
 „groupUrl“: „“, „nächste URL“: „< 
 
 
 {„courses
“: [{„courseDeleted“: false, „courseID“: „example-course-1", „courseTitle“: „Beispielkurs“, „courseUrl“: „“, „averageDuration“: „PT0S“, „courseReportUrl“: „“, „enrollmentDeleted“: false},...], „groupDeleted“: false, „groupUrl“: „“, „NächsteURL“: „“}

Endpunktspezifische Fehlercodes

• group_not_found- Der Bericht kann nicht abgerufen werden, da die Gruppe nicht existiert