Skip to main content

Report Definitions

This page provides complete field definitions for all available report objects.

TL;DR
  • 19 report objects available: Admin, Course, Curriculum, Group, Path, Pitch IQ, SCORM, Test Results, User, and their cross-referenced variants
  • Each field has a JSON field name, data type, and visibility default
  • Use the /describe endpoint to dynamically retrieve field definitions for any object :::

Quick reference

ObjectAPI NameDescription
Admin/ManagerAdminManager and admin user statistics
CourseCourseCourse-level statistics
Course & GroupCourseGroupCourse statistics by group
Course & UserCourseUserCourse statistics by user
CurriculumCurriculumCurriculum-level statistics
Curriculum & GroupCurriculumGroupCurriculum statistics by group
Curriculum & UserCurriculumUserCurriculum statistics by user
GroupGroupGroup-level statistics
PathChecklistPath (formerly Checklist) statistics
Path & GroupChecklistGroupPath statistics by group
Path & UserChecklistUserPath statistics by user
Path ItemTaskIndividual path item statistics
Path Item & GroupTaskGroupPath item statistics by group
Path Item & UserTaskUserPath item statistics by user
Pitch IQ ResultsPitchReviewsPitch review data (requires PitchIQ)
Pitch Reviewer ActivitiesPitchReviewerActivityReviewer activity (requires PitchIQ)
SCORM CoursesScormCourseDataSCORM course completion data
Test ResultsTestQuestionsTest question responses (requires Exam)
UserUserUser-level statistics

Admin/Manager

API Object name: Admin

Course

API Object name: Course

Course & Group

API Object name: CourseGroup

Course & User

API Object name: CourseUser

Curriculum

API Object name: Curriculum

Curriculum & Group

API Object name: CurriculumGroup

Curriculum & User

API Object name: CurriculumUser

Group

API Object name: Group

Path

API Object name: Checklist

Some JSON fields in the following tables are prefixed with checklist for legacy purposes; Checklists are now known as Paths and are labeled properly in the user interface.

Path & Group

API Object name: ChecklistGroup

Path & User

API Object name: ChecklistUser

Path Item

API Object name: Task

Path Item & Group

API Object name: TaskGroup

Path Item & User

API Object name: TaskUser

Pitch IQ Results

Feature activation required

PitchIQ activation is required for this object.

API Object name: PitchReviews

Pitch Reviewer Activities

Feature activation required

PitchIQ activation is required for this object.

API Object name: PitchReviewerActivity

SCORM Courses

API Object name: ScormCourseData

Test Results

Feature activation required

Exam activation is required for this object.

API Object name: TestQuestions

User

API Object name: User

Was this page helpful?