Browse Articles

Browse Articles

Reach 360: API de informes

Artículo actualizado el

Este artículo se aplica a:

Reach 360

Qué hace este terminal de API

Con la API de informes, puedes recuperar el informe de actividad del usuario (con todas las sesiones de usuario en toda la cuenta), obtener una lista de las sesiones de los alumnos de un curso o ruta de aprendizaje específicos, una lista de las sesiones del curso dentro de una ruta de aprendizaje o una lista de todas las sesiones del curso para un alumno específico.

Puntos finales

  • GET /reports/activity- informe de actividad del usuario (lista de sesiones de usuario)
  • GET /reports/courses/{courseId}- informe del alumno del curso (lista de las sesiones de los alumnos de un curso)
  • GET /reports/learners/{userId}- informe del curso del alumno (lista de las sesiones del curso para un alumno)
  • GET /reports/learning-paths/{learningPathId}/courses- informe de los cursos de la ruta de aprendizaje (lista de las sesiones del curso en una ruta de aprendizaje)
  • GET /reports/learning-paths/{learningPathId}/learners- informe de los alumnos sobre la ruta de aprendizaje (lista de las sesiones de los alumnos en una ruta de aprendizaje)
  • GET /reports/groups/{groupId}/courses- Aprender• Informe de cursos grupales (lista de las sesiones del curso en grupo)

Objeto de sesión (actividad del usuario con un curso)

  • courseId(cadena): identificador del curso
  • courseTitle(cadena): título del curso
  • courseReportUrl(cadena): URL para obtener el informe del curso desde la API
  • courseUrl(cadena): URL para obtener los detalles del curso desde la API
  • userId(cadena) - identificador de usuario
  • email(cadena): dirección de correo electrónico del usuario
  • firstName(cadena): nombre del usuario
  • lastName(cadena): apellido del usuario
  • learnerReportUrl(cadena): URL para obtener el informe de aprendizaje del usuario desde la API
  • userUrl(cadena): URL para obtener los detalles del usuario de la API
  • duration(cadena): duración de la sesión de usuario con formato ISO 8601
  • numberOfLessonsCompleted(entero): número de apartados completadas
  • quizScorePercent(entero): porcentaje de puntuación del cuestionario (si el cuestionario está presente)
  • isQuizPassed(bool): si el usuario aprobó la cuestionario o no (si la cuestionario está presente)
  • startedAt(cadena): marca de tiempo UTC con formato ISO 8601 de cuando se inició la sesión
  • userDeleted(bool): si el usuario se ha eliminado de Reach 360 o no.
  • courseDeleted(bool): si el curso se ha eliminado.

Objeto de aprendizaje del curso (usuario inscrito en un curso)

  • userId(cadena) - identificador de usuario
  • email(cadena): dirección de correo electrónico del usuario
  • firstName(cadena): nombre del usuario
  • lastName(cadena): apellido del usuario
  • learnerReportUrl(cadena): URL para obtener el informe de aprendizaje del usuario desde la API
  • userUrl(cadena): URL para obtener los detalles del usuario de la API
  • duration(cadena): duración media de la sesión de usuario con formato ISO 8601
  • quizScorePercent(entero): porcentaje de puntuación del cuestionario (si el cuestionario está presente)
  • dueAt(cadena): marca horaria UTC con formato ISO 8601 que indica la fecha límite del curso para el usuario (si corresponde)
  • status(cadena): estado del curso del usuario (uno deNot StartedIn Progress, oComplete)
  • completedAt(cadena): marca de tiempo en la que el alumno completó el curso onull.
  • userDeleted(bool): si el usuario se ha eliminado de Reach 360 o no.
  • progress(entero): porcentaje de progreso

Objeto del curso para alumnos (curso en el que está inscrito un alumno)

  • courseId(cadena): identificador del curso
  • courseTitle(cadena): título del curso
  • courseReportUrl(cadena): URL para obtener el informe del curso desde la API
  • courseUrl(cadena): URL para obtener los detalles del curso desde la API
  • duration(cadena): duración media de la sesión de usuario con formato ISO 8601
  • quizScorePercent(entero): porcentaje de puntuación del cuestionario (si el cuestionario está presente)
  • dueAt(cadena): marca horaria UTC con formato ISO 8601 que indica la fecha límite del curso para el usuario (si corresponde)
  • status(cadena): estado del curso del usuario (uno deNot StartedIn Progress, oComplete)
  • completedAt(cadena): marca de tiempo en la que el alumno completó el curso onull.
  • courseDeleted(bool): si el curso se ha eliminado.
  • progress(entero): porcentaje de progreso

Objeto del curso Learning Path (curso dentro de una ruta de aprendizaje)

  • courseId(string) ****- identificador del curso
  • courseTitle(cadena): título del curso
  • courseUrl(cadena): URL para obtener los detalles del curso desde la API
  • numberOfLessons(entero): número de apartados del curso
  • averageDuration(cadena): duración media de la sesión de usuario con formato ISO 8601
  • courseReportUrl(cadena): URL para obtener el informe del curso desde la API
  • courseDeleted(bool): si el curso se ha eliminado.

Ruta de aprendizaje Objeto de aprendizaje (alumno en una ruta de aprendizaje)

  • userId(cadena) - identificador de usuario
  • email(cadena): dirección de correo electrónico del usuario
  • firstName(cadena): nombre del usuario
  • lastName(cadena): apellido del usuario
  • learnerReportUrl(cadena): URL para obtener el informe de aprendizaje del usuario desde la API
  • userUrl(cadena): URL para obtener los detalles del usuario de la API
  • duration(cadena): duración media de la sesión de usuario con formato ISO 8601
  • dueAt(cadena): marca de tiempo UTC con formato ISO 8601 que indica cuándo vence la ruta de aprendizaje para el usuario (si corresponde)
  • status(cadena): estado de la ruta de aprendizaje del usuario (una deNot StartedIn Progress, oComplete)
  • userDeleted(bool): si el usuario se ha eliminado de la cuenta Reach 360 o no.

Objeto de curso grupal (curso en grupo)

  • courseId(string) ****- identificador del curso
  • courseTitle(cadena): título del curso
  • courseUrl(cadena): URL para obtener los detalles del curso desde la API
  • averageDuration(cadena): duración media de la sesión de usuario con formato ISO 8601
  • courseReportUrl(cadena): URL para obtener el informe del curso desde la API
  • courseDeleted(bool): si el curso se ha eliminado
  • enrollmentDeleted(bool): si el grupo se ha dado de baja del curso

Obtenga un informe de actividad

GET /reports/activity

Parámetros de solicitud (cadena de consulta)

  • limit(entero, opcional): el número máximo de resultados que se pueden devolver en una sola respuesta (consulte Paginación); debe estar entre 1 y 2000 (el valor predeterminado es 50)

Ejemplo de respuesta

{
«sessions»: [
{
«courseId»: «example-course-id-1",
 «courseDeleted»: false,
 «courseTitle»: «Título del curso 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»: «Ejemplo de nombre 1",
 «apellido»: Ejemplo de apellido 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 .000Z»
},... 
],
 «URL de texto»: "https://url-for-next-page-of-results"
}

Obtenga el informe del alumno del curso

GET /reports/courses/{courseId}

Parámetros de solicitud (cadena de consulta)

  • limit(entero, opcional): el número máximo de resultados que se pueden devolver en una sola respuesta (consulte Paginación); debe estar entre 1 y 2000 (el valor predeterminado es 50)

Ejemplo de respuesta

{
«courseDeleted»: false,
 «courseURL»: "https://api.reach360.com/courses/example-course-id
 «, «learning»: [
{
«userId»: «example-user-id-1",
 «firstName»: «Ejemplo de nombre 1",
 «apellido del ejemplo 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»: nulo,
 «duEat»: «2020-01-01T 12:30:00 .000Z»,
 «status»: «Completado»,
 «UserDeleted»: false,
 «completedAt»: «2019-12-31T 12:30:00 .000Z»,
},... 
],
 «URL de texto»: "https://url-for-next-page-of-results"
}

Códigos de error específicos de endpoints

  • course_not_found- no se puede recuperar el informe porque el curso no existe

Informe del curso Get Learner

GET /reports/learners/{userId}

Parámetros de solicitud (cadena de consulta)

  • limit(entero, opcional): el número máximo de resultados que se pueden devolver en una sola respuesta (consulte Paginación); debe estar entre 1 y 2000 (el valor predeterminado es 50)

Ejemplo de respuesta

{
«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»: «Título del curso 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»,
 «progress»: 51,
 «quizScorePercent»: nulo,
 «duEat»: «2020-01-01T 12:30:00 .000Z»,
 «status»: «Completado»
},... 
],
 «URL de texto»: "https://url-for-next-page-of-results"
}

Códigos de error específicos de endpoints

  • user_not_found- no se puede recuperar el informe porque el usuario no existe

Informe de cursos de Get Learning Path

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

Parámetros de solicitud (cadena de consulta)

  • limit(entero, opcional): el número máximo de resultados que se pueden devolver en una sola respuesta (consulte Paginación); debe estar entre 1 y 2000 (el valor predeterminado es 50)

Ejemplo de respuesta

{
«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»: «Ejemplo de curso»,
 «courseURL»: «https://api.reach360.com/courses/example-course-1 «,
 «numberOfLessons»: 6,
 «AverageDuration»: «PT37.578S»,
» URL del informe del curso»: "https://api.reach360.com/reports/courses/example-course-1"
},... 
],
 «URL de texto»: "https://url-for-next-page-of-results"
}

Códigos de error específicos de endpoints

  • learning_path_not_found- no se puede recuperar el informe porque la ruta de aprendizaje no existe

Informe para estudiantes de Get Learning Path

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

Parámetros de solicitud (cadena de consulta)

  • limit(entero, opcional): el número máximo de resultados que se pueden devolver en una sola respuesta (consulte Paginación); debe estar entre 1 y 2000 (el valor predeterminado es 50)

Ejemplo de respuesta

{
«learningPathURL»: "https://api.reach360.com/learning-paths/example-learning-path-id «,
 «coursesReportURL»: "https://api.reach360.com/reports/learning-paths/example-learning-path-id/courses «,
 «learning»: [
{
«dueAT»: null,
 «duration»: «PT37.578S»,
 «FirstName»: «Ejemplo de nombre 1",
 «LastName»: «Ejemplo de apellido 1",
 «learnerReportURL»: "https://api.reach360.com/reports/learners/example-user-id-1 «,
 «status»: «Complete»,
 «userDeleted»»: falso,
 «ID de usuario» : «identificador de usuario de ejemplo»,
 «URL de usuario»: "https://api.reach360.com/users/example-user-id-1"
},... 
],
 «URL de texto»: "https://url-for-next-page-of-results"
}

Códigos de error específicos de endpoints

  • learning_path_not_found- no se puede recuperar el informe porque la ruta de aprendizaje no existe

Obtenga el informe de cursos grupales

GET /reports/groups/{groupId}/courses

Parámetros de solicitud (cadena de consulta)

  • limit(entero, opcional): el número máximo de resultados que se pueden devolver en una sola respuesta (consulte Paginación); debe estar entre 1 y 2000 (el valor predeterminado es 50)

Ejemplo de respuesta

{
«courses»: [
{
«courseDeleted»: false,
 «courseID»: «example-course-1",
 «courseTitle»: «Curso de ejemplo»,
 «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 >»,
 «URL siguiente»: «< https://url-for-next-page-of-results >»
}

Códigos de error específicos de endpoints

  • group_not_found- no se puede recuperar el informe porque el grupo no existe