Browse Articles

Browse Articles

Reach 360 : API de rapports

Dernière mise à jour de l’article le

Cet article s'applique à :

Reach 360

Ce que fait ce point de terminaison d'API

Avec l'API Reports, vous pouvez récupérer le rapport d'activité des utilisateurs (avec toutes les sessions utilisateur à l'échelle du compte), obtenir la liste des sessions des apprenants pour un module ou un chemin de formation spécifique, la liste des sessions de module au sein d'un chemin de formation ou la liste de toutes les sessions de module pour un apprenant spécifique.

Points de terminaison

  • GET /reports/activity- rapport d'activité utilisateur (liste des sessions utilisateur)
  • GET /reports/courses/{courseId}- rapport sur les apprenant (liste des sessions d'apprenant pour un module)
  • GET /reports/learners/{userId}- rapport de module pour un apprenant (liste des sessions de module pour un apprenant)
  • GET /reports/learning-paths/{learningPathId}/courses- rapport sur les module du chemin d'apprentissage (liste des sessions de cours d'un chemin de formation)
  • GET /reports/learning-paths/{learningPathId}/learners- rapport des apprenants sur chemin d'apprenant (liste des sessions d'apprentissage d'un chemin d'apprentissage)
  • GET /reports/groups/{groupId}/courses- Apprendre• Rapport des module en groupe (liste des sessions de cours en groupe)

Objet de session (activité de l'utilisateur avec un module)

  • courseId(chaîne) - identifiant du module
  • courseTitle(chaîne) - titre du module
  • courseReportUrl(string) : URL permettant de récupérer le rapport de module depuis l'API
  • courseUrl(string) - URL pour récupérer les détails du cours depuis l'API
  • userId(chaîne) - identifiant de l'utilisateur
  • email(chaîne) - adresse e-mail de l'utilisateur
  • firstName(chaîne) : prénom de l'utilisateur
  • lastName(chaîne) : nom de famille de l'utilisateur
  • learnerReportUrl(string) : URL permettant de récupérer le rapport d'apprentissage de l'utilisateur depuis l'API
  • userUrl(string) - URL pour récupérer les détails de l'utilisateur depuis l'API
  • duration(string) - Durée de la session utilisateur au format ISO 8601
  • numberOfLessonsCompleted(entier) - nombre de leçons terminées
  • quizScorePercent(entier) - pourcentage de score du quiz (si le quiz est présent)
  • isQuizPassed(bool) - si l'utilisateur a réussi le quiz ou non (si le quiz est présent)
  • startedAt(string) - Horodatage UTC au format ISO 8601 indiquant le début de la session
  • userDeleted(bool) - si l'utilisateur a été supprimé de Reach 360 ou non.
  • courseDeleted(bool) - indique si le module a été supprimé.

Objet destiné à l'apprenant du module (utilisateur inscrit à un cours)

  • userId(chaîne) - identifiant de l'utilisateur
  • email(chaîne) - adresse e-mail de l'utilisateur
  • firstName(chaîne) : prénom de l'utilisateur
  • lastName(chaîne) : nom de famille de l'utilisateur
  • learnerReportUrl(string) : URL permettant de récupérer le rapport d'apprentissage de l'utilisateur depuis l'API
  • userUrl(string) - URL pour récupérer les détails de l'utilisateur depuis l'API
  • duration(string) - Durée moyenne d'une session utilisateur au format ISO 8601
  • quizScorePercent(entier) - pourcentage de score du quiz (si le quiz est présent)
  • dueAt(string) - Horodatage UTC au format ISO 8601 indiquant la date à laquelle le module doit être donné à l'utilisateur (le cas échéant)
  • status(chaîne) - statut du module pour l'utilisateur (l'un desNot StartedIn Progress, ouComplete)
  • completedAt(chaîne) : horodatage indiquant à quel moment le module a été terminé par l'apprenant ounull.
  • userDeleted(bool) - si l'utilisateur a été supprimé de Reach 360 ou non.
  • progress(entier) - pourcentage de progression

Objet du module pour apprenants (cours auquel un apprenant est inscrit)

  • courseId(chaîne) - identifiant du module
  • courseTitle(chaîne) - titre du module
  • courseReportUrl(string) : URL permettant de récupérer le rapport de module depuis l'API
  • courseUrl(string) - URL pour récupérer les détails du cours depuis l'API
  • duration(string) - Durée moyenne d'une session utilisateur au format ISO 8601
  • quizScorePercent(entier) - pourcentage de score du quiz (si le quiz est présent)
  • dueAt(string) - Horodatage UTC au format ISO 8601 indiquant la date à laquelle le module doit être donné à l'utilisateur (le cas échéant)
  • status(chaîne) - statut du module pour l'utilisateur (l'un desNot StartedIn Progress, ouComplete)
  • completedAt(chaîne) : horodatage indiquant à quel moment le module a été terminé par l'apprenant ounull.
  • courseDeleted(bool) - indique si le module a été supprimé.
  • progress(entier) - pourcentage de progression

Objet du module (cours faisant partie d'un parcours de formation)

  • courseId(chaîne) ****- identifiant du module
  • courseTitle(chaîne) - titre du module
  • courseUrl(string) - URL pour récupérer les détails du cours depuis l'API
  • numberOfLessons(entier) - nombre de leçons du module
  • averageDuration(string) - Durée moyenne d'une session utilisateur au format ISO 8601
  • courseReportUrl(string) : URL permettant de récupérer le rapport de module depuis l'API
  • courseDeleted(bool) - indique si le module a été supprimé.

Parcours d'apprentissage Objet de l'apprenant (apprenant dans un chemin d'apprentissage)

  • userId(chaîne) - identifiant de l'utilisateur
  • email(chaîne) - adresse e-mail de l'utilisateur
  • firstName(chaîne) : prénom de l'utilisateur
  • lastName(chaîne) : nom de famille de l'utilisateur
  • learnerReportUrl(string) : URL permettant de récupérer le rapport d'apprentissage de l'utilisateur depuis l'API
  • userUrl(string) - URL pour récupérer les détails de l'utilisateur depuis l'API
  • duration(string) - Durée moyenne d'une session utilisateur au format ISO 8601
  • dueAt(string) - Horodatage UTC au format ISO 8601 indiquant la date à laquelle le chemin d'apprentissage est dû à l'utilisateur (le cas échéant)
  • status(chaîne) : état du chemin d'apprentissage de l'utilisateur (l'un desNot StartedIn Progress, ouComplete)
  • userDeleted(bool) - si l'utilisateur a été supprimé du compte Reach 360 ou non.

Objet du module de groupe (cours en groupe)

  • courseId(chaîne) ****- identifiant du module
  • courseTitle(chaîne) - titre du module
  • courseUrl(string) - URL pour récupérer les détails du cours depuis l'API
  • averageDuration(string) - Durée moyenne d'une session utilisateur au format ISO 8601
  • courseReportUrl(string) : URL permettant de récupérer le rapport de module depuis l'API
  • courseDeleted(bool) - indique si le module a été supprimé
  • enrollmentDeleted(bool) - indique si le groupe a été désinscrit du module

Obtenir le rapport d'activité

GET /reports/activity

Paramètres de demande (chaîne de requête)

  • limit(entier, facultatif) : nombre maximum de résultats à renvoyer dans une seule réponse (voir Pagination) ; doit être compris entre 1 et 2 000 (50 par défaut)

Exemple de réponse

{
« sessions » : [
{
« CourseId » : « example-course-id-1",

 « CourseDeleted » : faux,
 « CourseTitle » : « Titre du module 1 »,
 « CourseReportUrl » : « Exemple de prénom 1 »,
 « Nom de famille » : Exemple de nom de famille 1",
 « LearnerReportUrl » : "https://api.reach360.com/reports/learners/example-user-id-1
 «,
 « UserDeleted » : false,
 https://api.reach360.com/reports/courses/example-course-id-1 https://api.reach360.com/courses/example-course-id-1 
« URL utilisateur » : « https://api.reach360.com/users/example-user-id-1 »,
 « durée » : « PT37.578S »,
 « Nombre de leçons terminées » : 1,
 « QuizScorePercent » : null,
 « IsQuizPassed » : null,
 « StartedAt » : « 2020-01-01T 12:30:00 .000Z »
},... 
],
 « URL suivante » : "https://url-for-next-page-of-results"
}

Obtenir le rapport sur les apprenants

GET /reports/courses/{courseId}

Paramètres de demande (chaîne de requête)

  • limit(entier, facultatif) : nombre maximum de résultats à renvoyer dans une seule réponse (voir Pagination) ; doit être compris entre 1 et 2 000 (50 par défaut)

Exemple de réponse

{
« CourseDeleted » : false,
 « CourseUrl » : « https://api.reach360.com/courses/example-course-id »,
 « apprenants » : [
{
« UserId » : « example-user-id-1",
 « FirstName » : « Exemple de prénom 1 »,
 « LastName » : « Exemple de nom de famille 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 »,
 « progression » » : 51,
 « QuizScorePercent » : nul,
 « DueAT » : « 2020-01-01T 12:30:00 .000Z »,
 « status » : « Terminé »,
 « UserDeleted » : faux,
 « CompletedAt » : « 2019-12-31T 12:30:00 .000Z »,
},... 
],
 « URL suivante » : "https://url-for-next-page-of-results"
}

Codes d'erreur spécifiques aux terminaux

  • course_not_found- impossible de récupérer le rapport car le module n'existe pas

Obtenir le rapport de cours pour les apprenants

GET /reports/learners/{userId}

Paramètres de demande (chaîne de requête)

  • limit(entier, facultatif) : nombre maximum de résultats à renvoyer dans une seule réponse (voir Pagination) ; doit être compris entre 1 et 2 000 (50 par défaut)

Exemple de réponse

{
« UserDeleted » : false,
 « UserUrl » : « https://api.reach360.com/users/example-user-id »,
 « module » : [
{
« CompletedAt » : « 31/12/2019 12:30:00 .000Z », « CourseDeleted » :
 « CourseReportUrl » :
 « example-course-id-1", « CourseTitle » : « Titre du module 1 »,
 « CourseReportUrl » : « CourseReportUrl » :
 « CourseReportUrl » : « CourseReportUrl » :
 « CourseReportUrl » : « CourseReportUrl » : « https://api.reach360.com/courses/example-course-id-1 », « durée » :
 « PT37.578S »,
 « progression » : 51, « QuizScorePercent » : nul,
 « DuEat » :
 https://api.reach360.com/reports/courses/example-course-id-1 « 2020-01-01T 12:30:00 .000Z »,
 « status » : « Complet »
},... 
],
 « URL suivante » : "https://url-for-next-page-of-results"
}

Codes d'erreur spécifiques aux terminaux

  • user_not_found- impossible de récupérer le rapport car l'utilisateur n'existe pas

Obtenir le rapport sur les parcours de formation

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

Paramètres de demande (chaîne de requête)

  • limit(entier, facultatif) : nombre maximum de résultats à renvoyer dans une seule réponse (voir Pagination) ; doit être compris entre 1 et 2 000 (50 par défaut)

Exemple de réponse

{
« 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 », « module » : [
{
« courseDeleted » :
 « courseID » : « example-course-1 »,
 « CourseTitle » : « Exemple de module »,
 « CourseUrl » : « https://api.reach360.com/courses/example-course-1 »,
 « NumberOfLessons » : 6,
 « AverageUrl » Durée » : « PT37.578S »,
 » URL du rapport de cours » : "https://api.reach360.com/reports/courses/example-course-1"
},... 
],
 « URL suivante » : "https://url-for-next-page-of-results"
}

Codes d'erreur spécifiques aux terminaux

  • learning_path_not_found- impossible de récupérer le rapport car chemin de formation n'existe pas

Obtenir le rapport sur le parcours de formation des apprenants

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

Paramètres de demande (chaîne de requête)

  • limit(entier, facultatif) : nombre maximum de résultats à renvoyer dans une seule réponse (voir Pagination) ; doit être compris entre 1 et 2 000 (50 par défaut)

Exemple de réponse

{
« LearningPathUrl » : "https://api.reach360.com/learning-paths/example-learning-path-id
 «, « CoursesReportUrl » : "https://api.reach360.com/reports/learning-paths/example-learning-path-id/courses
 «, « apprenants » : [
{
« DueAT » : null,
 « duration » : « PT37.578S »,
 « FirstName » : « Exemple de prénom 1 »,
 « Nom de famille 1 »,
 « LearnerReportUrl » : "https://api.reach360.com/reports/learners/example-user-id-1 «, « status » :
 « Complet »,
 « UserDeleted » false :,
 « ID utilisateur » : « example-user-id-1",
 « URL de l'utilisateur » : "https://api.reach360.com/users/example-user-id-1"
},... 
],
 « URL suivante » : "https://url-for-next-page-of-results"
}

Codes d'erreur spécifiques aux terminaux

  • learning_path_not_found- impossible de récupérer le rapport car chemin de formation n'existe pas

Obtenir le rapport sur les cours en groupe

GET /reports/groups/{groupId}/courses

Paramètres de demande (chaîne de requête)

  • limit(entier, facultatif) : nombre maximum de résultats à renvoyer dans une seule réponse (voir Pagination) ; doit être compris entre 1 et 2 000 (50 par défaut)

Exemple de réponse

{
« module » : [
{
« courseDeleted » : false,
 « courseId » : « example-course-1 »,
 « courseTitle » : « Exemple de module », « CourseUrl » :
 « » < https://api.reach360.com/courses/example-course-1 >, « AverageDuration » :
 « PT0S », « < https://api.reach360.com/reports/courses/example-course-1 > CourseReportUrl » :
 « »,
 « EnrollmentDeleted » : false},...],
 « GroupDeleted » : false, « groupDeleted » : false,
 « groupDeleted < https://api.reach360.com/groups/example-group-1 > » :
 « », « URL suivante » : « < https://url-for-next-page-of-results > »
}

Codes d'erreur spécifiques au terminal

  • group_not_found- Impossible de récupérer le rapport car le groupe n'existe pas