Browse Articles

Browse Articles

Reach 360: API für Berichte

Letzte Aktualisierung des Artikels:

Dieser Artikel gilt für:

Reach 360

Was dieser API-Endpunkt macht

Mit der Berichts-API können Sie den Benutzeraktivitätsbericht (mit allen Benutzersitzungen kontoweit) abrufen, 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 Teilnehmer abrufen.

Endpunkte

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

Sitzungsobjekt (Benutzeraktivität mit 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) - Benutzerkennung
  • email(string) - Benutzer-E-Mail-Adresse
  • firstName(string) - der Vorname des Benutzers
  • lastName(string) - der Nachname des Benutzers
  • learnerReportUrl(string) — URL zum Abrufen des Lernberichts des Benutzers von der API
  • userUrl(string) — URL zum Abrufen von Benutzerdetails aus der API
  • duration(string) - Dauer der Benutzersitzung im ISO 8601-Format
  • numberOfLessonsCompleted(Ganzzahl) — Anzahl der abgeschlossenen Lektionen
  • quizScorePercent(Integer) — 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 Sitzungsstart
  • 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(string) - Benutzerkennung
  • email(string) - Benutzer-E-Mail-Adresse
  • firstName(string) - der Vorname des Benutzers
  • lastName(string) - der Nachname des Benutzers
  • learnerReportUrl(string) — URL zum Abrufen des Lernberichts des Benutzers von der API
  • userUrl(string) — URL zum Abrufen von Benutzerdetails aus der API
  • duration(string) - Dauer einer durchschnittlichen Benutzersitzung im ISO 8601-Format
  • quizScorePercent(Integer) — 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) - Status natürlich für den Benutzer (einer vonNot StartedIn Progress, oderComplete)
  • completedAt(string) — Zeitstempel, der angibt, wann der Kurs vom Lernenden abgeschlossen wurde odernull.
  • userDeleted(bool) — ob der Benutzer aus Reach 360 entfernt wurde oder nicht.
  • progress(Ganzzahl) - prozentualer Fortschritt

Kursobjekt für Lernende (Kurs, für den ein Teilnehmer eingeschrieben 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(Integer) — 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) - Status natürlich für den Benutzer (einer vonNot StartedIn Progress, oderComplete)
  • completedAt(string) — Zeitstempel, der angibt, wann der Kurs vom Lernenden abgeschlossen wurde odernull.
  • courseDeleted(bool) - ob der Kurs gelöscht wurde.
  • progress(Ganzzahl) - prozentualer Fortschritt

Lernpfad Kursobjekt (Kurs in einem Lernpfad)

  • courseId(string) ****- Kurs-ID
  • courseTitle(string) - Kurstitel
  • courseUrl(string) — URL zum Abrufen der Kursdetails von der API
  • numberOfLessons(Ganzzahl) - Anzahl der Unterrichtsstunden 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(string) - Benutzerkennung
  • email(string) - Benutzer-E-Mail-Adresse
  • firstName(string) - der Vorname des Benutzers
  • lastName(string) - der Nachname des Benutzers
  • learnerReportUrl(string) — URL zum Abrufen des Lernberichts des Benutzers von der API
  • userUrl(string) — URL zum Abrufen von Benutzerdetails aus 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 vonNot StartedIn Progress, oderComplete)
  • userDeleted(bool) — ob der Benutzer aus dem Reach 360-Konto entfernt wurde oder nicht.

Gruppenkursobjekt (Kurs in einer Gruppe)

  • courseId(string) ****- Kurs-ID
  • courseTitle(string) - Kurstitel
  • 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(Integer, optional) — die maximale Anzahl von Ergebnissen, die in einer einzelnen Antwort zurückgegeben werden sollen (siehe Paginierung); muss zwischen 1 und 2.000 liegen (der Standardwert ist 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 .000Z“
},... 
],
 „nächste URL“: "https://url-for-next-page-of-results"
}

Bericht für Kursteilnehmer abrufen

GET /reports/courses/{courseId}

Anforderungsparameter (Abfragezeichenfolge)

  • limit(Integer, optional) — die maximale Anzahl von Ergebnissen, die in einer einzelnen Antwort zurückgegeben werden sollen (siehe Paginierung); muss zwischen 1 und 2.000 liegen (der Standardwert ist 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“,
 „progress“: 51,
 „QuizScorePercent“: null,
 „duEat“: „2020-01-01T 12:30:00 .000Z“,
 „status“: „Abgeschlossen“,
 „userDeleted“: false,
 „completedAt“: „2019-12-31T 12:30:00 .000Z“,
},... 
],
 „nächste URL“: "https://url-for-next-page-of-results"
}

Endpunktspezifische Fehlercodes

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

Kursbericht für Lernende abrufen

GET /reports/learners/{userId}

Anforderungsparameter (Abfragezeichenfolge)

  • limit(Integer, optional) — die maximale Anzahl von Ergebnissen, die in einer einzelnen Antwort zurückgegeben werden sollen (siehe Paginierung); muss zwischen 1 und 2.000 liegen (der Standardwert ist 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 .000Z“,
 „CourseDeleted“: false,
 „courseID“: „example-course-id-1",
 „courseTitle“: „Kurstitel 1",
 „CourseportUrl“: "https://api.reach360.com/reports/courses/example-course-id-1 „,
 „courseUrl“: "https://api.reach360.com/courses/example-course-id-1 „,
 „Dauer“: „PT37.578S“,
 „Fortschritt“: 51,
 „QuizScorePercent“: null,
 „DueAt“: „2020-01-01T 12:30:00 .000Z“,
 „status“: „Vollständig“
},... 
],
 „nächste URL“: "https://url-for-next-page-of-results"
}

Endpunktspezifische Fehlercodes

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

Bericht über die Learning Path-Kurse abrufen

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

Anforderungsparameter (Abfragezeichenfolge)

  • limit(Integer, optional) — die maximale Anzahl von Ergebnissen, die in einer einzelnen Antwort zurückgegeben werden sollen (siehe Paginierung); muss zwischen 1 und 2.000 liegen (der Standardwert ist 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,
 „averageDuration“: „PT37,578S“,
“ URL des Kursberichts“: "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 der Lernpfad nicht existiert

Holen Sie sich den Learning Path Learners Report

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

Anforderungsparameter (Abfragezeichenfolge)

  • limit(Integer, optional) — die maximale Anzahl von Ergebnissen, die in einer einzelnen Antwort zurückgegeben werden sollen (siehe Paginierung); muss zwischen 1 und 2.000 liegen (der Standardwert ist 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,
 „Benutzer-ID“ : „example-user-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 der Lernpfad nicht existiert

Bericht über Gruppenkurse abrufen

GET /reports/groups/{groupId}/courses

Anforderungsparameter (Abfragezeichenfolge)

  • limit(Integer, optional) — die maximale Anzahl von Ergebnissen, die in einer einzelnen Antwort zurückgegeben werden sollen (siehe Paginierung); muss zwischen 1 und 2000 liegen (der Standardwert ist 50)

Beispiel für eine Antwort

{
„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 < https://api.reach360.com/groups/example-group-1 >“: „“,
 „nächste URL“: „< https://url-for-next-page-of-results >“
}

Endpunktspezifische Fehlercodes

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