Co robi ten punkt końcowy interfejsu API

Za pomocą interfejsu API Raporty możesz pobrać raport aktywności użytkownika (ze wszystkimi sesjami użytkownika na całym koncie), uzyskać listę sesji uczestnika dla określonego kursu lub ścieżki uczenia się, listę sesji kursu w ramach ścieżki edukacyjnej lub listę wszystkich sesji kursu dla określonego uczestnika.

• Punkty końcowe
• Obiekt sesji
• Obiekt ucznia kursu
• Obiekt kursu dla ucznia
• Ścieżka szkoleniowa Obiekt kursu
• Ścieżka uczenia się Obiekt ucznia
• Obiekt kursu grupowego
• Pobierz raport z aktywności
• Pobierz raport uczestnika kursu
• Pobierz raport kursu dla ucznia
• Pobierz raport z kursów ścieżki edukacyjnej
• Pobierz raport dla uczniów ścieżki edukacyjnej
• Pobierz raport kursów grupowych

Punkty końcowe

• GET /reports/activity- raport aktywności użytkownika (lista sesji użytkownika)
• GET /reports/courses/{courseId}- raport uczestnika kursu (lista sesji uczestnika kursu)
• GET /reports/learners/{userId}- raport z kursu uczestnika (lista sesji kursu dla uczestnika)
• GET /reports/learning-paths/{learningPathId}/courses- raport z kursów ścieżki kształcenia (lista sesji kursu w ścieżce uczenia się)
• GET /reports/learning-paths/{learningPathId}/learners- raport dla uczestników ścieżki uczenia się (lista sesji uczestnika w ścieżce uczenia się)
• GET /reports/groups/{groupId}/courses- Learn• Raport z kursów grupowych (lista sesji kursu w grupie)

Obiekt sesji (aktywność użytkownika z kursem)

• courseId(string) - identyfikator kursu
• courseTitle(string) - tytuł kursu
• courseReportUrl(string) - URL do pobrania raportu kursu z API
• courseUrl(string) - URL do pobierania szczegółów kursu z API
• userId(string) - identyfikator użytkownika
• email(string) - adres e-mail użytkownika
• firstName(string) - imię użytkownika
• lastName(string) - nazwisko użytkownika
• learnerReportUrl(string) - URL do pobrania raportu uczestnika użytkownika z API
• userUrl(string) - URL do pobierania danych użytkownika z API
• duration(string) - czas trwania sesji użytkownika w formacie ISO 8601
• numberOfLessonsCompleted(integer) - liczba ukończonych lekcji
• quizScorePercent(integer) - procent wyniku quizu (jeśli quiz jest obecny)
• isQuizPassed(bool) - czy użytkownik zdał quiz, czy nie (jeśli quiz jest obecny)
• startedAt(string) - znacznik czasu UTC w formacie ISO 8601, kiedy rozpoczęła się sesja
• userDeleted(bool) - czy użytkownik został usunięty z Reach 360, czy nie.
• courseDeleted(bool) - czy kurs został usunięty.

Course Learner Object (użytkownik zapisany na kurs)

• userId(string) - identyfikator użytkownika
• email(string) - adres e-mail użytkownika
• firstName(string) - imię użytkownika
• lastName(string) - nazwisko użytkownika
• learnerReportUrl(string) - URL do pobrania raportu uczestnika użytkownika z API
• userUrl(string) - URL do pobierania danych użytkownika z API
• duration(string) - Sformatowany w ISO 8601 czas trwania przeciętnej sesji użytkownika
• quizScorePercent(integer) - procent wyniku quizu (jeśli quiz jest obecny)
• dueAt(string) - znacznik czasu UTC w formacie ISO 8601 określający, kiedy kurs jest należny użytkownikowi (jeśli dotyczy)
• status(string) - status kursu dla użytkownika (jeden z Not StartedIn Progress, lubComplete)
• completedAt(string) - Znacznik czasu, kiedy kurs został ukończony przez uczestnika lub. null
• userDeleted(bool) - czy użytkownik został usunięty z Reach 360, czy nie.
• progress(liczba całkowita) - procent postępu

Learner Course Object (kurs, na który uczestnik jest zapisany)

• courseId(string) - identyfikator kursu
• courseTitle(string) - tytuł kursu
• courseReportUrl(string) - URL do pobrania raportu kursu z API
• courseUrl(string) - URL do pobierania szczegółów kursu z API
• duration(string) - Sformatowany w ISO 8601 czas trwania przeciętnej sesji użytkownika
• quizScorePercent(integer) - procent wyniku quizu (jeśli quiz jest obecny)
• dueAt(string) - znacznik czasu UTC w formacie ISO 8601 określający, kiedy kurs jest należny użytkownikowi (jeśli dotyczy)
• status(string) - status kursu dla użytkownika (jeden z Not StartedIn Progress, lubComplete)
• completedAt(string) - Znacznik czasu, kiedy kurs został ukończony przez uczestnika lub. null
• courseDeleted(bool) - czy kurs został usunięty.
• progress(liczba całkowita) - procent postępu

Ścieżka uczenia się Obiekt kursu (kurs w ścieżce uczenia się)

• courseId(string) ****- identyfikator kursu
• courseTitle(string) - tytuł kursu
• courseUrl(string) - URL do pobrania szczegółów kursu z API
• numberOfLessons(integer) - liczba lekcji w kursie
• averageDuration(string) - Sformatowany w ISO 8601 czas trwania przeciętnej sesji użytkownika
• courseReportUrl(string) - URL, aby pobrać raport z kursu z API
• courseDeleted(bool) - czy kurs został usunięty.

Learning Path Learner Object (uczestnik w ścieżce uczenia się)

• userId(string) - identyfikator użytkownika
• email(string) - adres e-mail użytkownika
• firstName(string) - imię użytkownika
• lastName(string) - nazwisko użytkownika
• learnerReportUrl(string) - URL do pobrania raportu uczestnika użytkownika z API
• userUrl(string) - URL do pobierania danych użytkownika z API
• duration(string) - Sformatowany w ISO 8601 czas trwania przeciętnej sesji użytkownika
• dueAt(string) - znacznik czasu UTC w formacie ISO 8601 określający, kiedy ścieżka uczenia się jest wymagana dla użytkownika (jeśli dotyczy)
• status(string) - status ścieżki uczenia się dla użytkownika (jeden Not Started zIn Progress, Complete lub)
• userDeleted(bool) - czy użytkownik został usunięty z konta Reach 360, czy nie.

Obiekt kursu grupowego (kurs w grupie)

• courseId(string) ****- identyfikator kursu
• courseTitle(string) - tytuł kursu
• courseUrl(string) - URL do pobrania szczegółów kursu z API
• averageDuration(string) - Sformatowany w ISO 8601 czas trwania przeciętnej sesji użytkownika
• courseReportUrl(string) - URL, aby pobrać raport z kursu z API
• courseDeleted(bool) - czy kurs został usunięty
• enrollmentDeleted(bool) - czy grupa została wycofana z kursu

Pobierz raport z aktywności

GET /reports/activity

Parametry żądania (ciąg zapytania)

• limit(liczba całkowita, opcjonalna) - maksymalna liczba wyników do zwrócenia w pojedynczej odpowiedzi (patrz Paginacja); musi wynosić od 1 do 2000 (domyślnie 50)

Przykładowa odpowiedź

{
„sessions”: [
{
„courseId”: „example-course-id-1", „courseDeleted”: false, 
 „CourseTitle”: „Tytuł kursu 1", 
 „coursePortURL”: "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”: 
 „Przykład imienia 1", „lasta” Name”: 
 „Przykładowe nazwisko 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, „isQuizPasted”: null, 
 „starteDat”: 
 „2020-01-01T 12:30:00.000 Z”},... 
 
 
], 
 „NextURL”: "https://url-for-next-page-of-results"} 

Pobierz raport uczestnika kursu

GET /reports/courses/{courseId}

Parametry żądania (ciąg zapytania)

• limit(liczba całkowita, opcjonalna) - maksymalna liczba wyników do zwrócenia w pojedynczej odpowiedzi (patrz Paginacja); musi wynosić od 1 do 2000 (domyślnie 50)

Przykładowa odpowiedź

{
„courseDeleted”: false, 
 „courseURL”: "https://api.reach360.com/courses/example-course-id „, „
uczestnicy”: [
{„UserID”: „przykład-user-id-1", 
 „FirstName”: „Przykładowe imię 1", „LastName”: „Przykładowe nazwisko 1", 
 „learnerReturl”: "https://api.reach360.com/reports/learners/example-user-id-1 „, 
 „userURL”: "https://api.reach360.com/users/example-user-id-1 „, „czas trwania”: „PT33" 7.578S”, 
 „progress”: 51, „QuizScorePercent”: null, 
 „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"} 

Kody błędów specyficzne dla punktu końcowego

• course_not_found- nie można pobrać raportu, ponieważ kurs nie istnieje

Pobierz raport kursu dla ucznia

GET /reports/learners/{userId}

Parametry żądania (ciąg zapytania)

• limit(liczba całkowita, opcjonalna) - maksymalna liczba wyników do zwrócenia w pojedynczej odpowiedzi (patrz Paginacja); musi wynosić od 1 do 2000 (domyślnie 50)

Przykładowa odpowiedź

{
„userDeleted”: false, „userURL”: "https://api.reach360.com/users/example-user-id 
 „, „courses”: [
{„completeDAT”: „2019-12-31T 12:30:00.000 Z”, 
 „courseDeleted”: false, „CourseId”: 
 „exampleteDAT”: „courseTitle”: „CourseTitle”: „CourseTitle”: „CourseTitle”: „CourseTitle”: 
 „CourseReturl”: "https://api.reach360.com/reports/courses/example-course-id-1 „, „CourseTitle”: 
 „CourseTitle”: „CourseTitle”: „CourseReturl”: "„, „courseTitle”: „CourseTitle”: 
 „CourseTitle”: „CourseReturl”: "„Url”: "https://api.reach360.com/courses/example-course-id-1 „, 
 „duration”: „PT37.578S”, „postęp”: 51, „quizScorePercent”: null, 
 „DuEat”: 
 
 
 
 „2020-01-01T 12:30:00.000 Z”, „status”: 
 „Zakończone”},... 
 
], 
 „NextURL”: "https://url-for-next-page-of-results"} 

Kody błędów specyficzne dla punktu końcowego

• user_not_found- nie można pobrać raportu, ponieważ użytkownik nie istnieje

Pobierz raport z kursów ścieżki edukacyjnej

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

Parametry żądania (ciąg zapytania)

• limit(liczba całkowita, opcjonalna) - maksymalna liczba wyników do zwrócenia w pojedynczej odpowiedzi (patrz Paginacja); musi wynosić od 1 do 2000 (domyślnie 50)

Przykładowa odpowiedź

{
„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 „, 
 „kursy”: [
{„courseDeleted”: false, „CourseId”: 
 „example-course-1", 
 „courseTitle”: „Przykładowy kurs”, 
 „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"} 

Kody błędów specyficzne dla punktu końcowego

• learning_path_not_found- nie można pobrać raportu, ponieważ ścieżka uczenia się nie istnieje

Pobierz raport dla uczniów ścieżki edukacyjnej

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

Parametry żądania (ciąg zapytania)

• limit(liczba całkowita, opcjonalna) - maksymalna liczba wyników do zwrócenia w pojedynczej odpowiedzi (patrz Paginacja); musi wynosić od 1 do 2000 (domyślnie 50)

Przykładowa odpowiedź

{
„learningPathURL”: "https://api.reach360.com/learning-paths/example-learning-path-id „, 
 „coursesReportUrl”: "https://api.reach360.com/reports/learning-paths/example-learning-path-id/courses „, „
uczestnicy”: [
{„DuEat”: null, „duration”: 
 „PT37.578S”, 
 „FirstName”: „Przykładowe imię 1”, „Nazwisko przykładowe 1", 
 „learnerReportURL”: "https://api.reach360.com/reports/learners/example-user-id-1 
 „, „status”: „Complete”, „userDeleted”: false, 
 „UserID” 
 
 
 : „przykład-user-id-1", 
 „userURL”: "https://api.reach360.com/users/example-user-id-1"},... 
 
], 
 „NextURL”: "https://url-for-next-page-of-results"} 

Kody błędów specyficzne dla punktu końcowego

• learning_path_not_found- nie można pobrać raportu, ponieważ ścieżka uczenia się nie istnieje

Pobierz raport kursów grupowych

GET /reports/groups/{groupId}/courses

Parametry żądania (ciąg zapytania)

• limit(liczba całkowita, opcjonalna) - maksymalna liczba wyników do zwrócenia w pojedynczej odpowiedzi (patrz Paginacja); musi wynosić od 1 do 2000 (domyślnie 50)

Przykładowa odpowiedź

< https://api.reach360.com/groups/example-group-1 >{ 
 „courses”: [
{
„courseDeleted”: false, „courseId”: 
 „example-course-1", „courseTitle”: „Przykładowy kurs”, 
 „courseURL”: „”, „< https://api.reach360.com/courses/example-course-1 > AverageDuration”: 
 „PT0S”, „courseTitle”: 
 „”, „< https://api.reach360.com/reports/courses/example-course-1 > enrollmentDeleted”: false},...], 
 „groupDeleted”:, „groupUrl”: „”, 
 „nextURL”: „< 
 
 
 https://url-for-next-page-of-results >”
}

Kody błędów specyficzne dla punktu końcowego

• group_not_found- nie można pobrać raportu, ponieważ grupa nie istnieje