Report Definitions
Below are definitions for each of the available report objects in the Coach Reporting API service, along with descriptions of each available field. All fields are available to be toggled visible/invisible in the UI and exported as a CSV. When querying via API directly, you'll need to include the list of fields you would like returned if you don't want the defaults.
Admin/Manager
Object name for API: Admin
Field | JSON field | Data Type | Description | Visible by default |
---|---|---|---|---|
User ID | userId | String | ID of the user | No |
First Name | firstName | String | First name of the user | Yes |
Last Name | lastName | String | Last name of the user | Yes |
Full Name | name | String | Full name of the user | No |
email | String | Email address of the user | No | |
Groups Managed | groupsManaged | String | Number of groups this user manages | Yes |
Review Average | pitchAverage | String | Average score given to learners by the user during pitch reviews | Yes |
Reviews Assigned | reviewsAssigned | String | Number of pitch review tasks assigned to the user | Yes |
Reviews Completed | reviewsCompleted | String | Number of pitch review tasks completed by the user | Yes |
Reviews With Feedback | reviewsWithFeedback | String | Number of pitch reviews the user has provided written feedback on | Yes |
Role | permission | String | Role of the user | Yes |
Users Managed | usersManaged | Integer | Number of learners managed by this user | Yes |
Courses Administered | coursesAdministered | Integer | Number of courses where this user is listed as the owner | Yes |
Feedback Length Average | feedbackAverage | Integer | Average number of characters given in pitch feedback | Yes |
Course
Object name for API: Course
Field | JSON field | Data Type | Description | Visible by default |
---|---|---|---|---|
Course ID | courseId | String | ID of the course | No |
Course Title | courseTitle | String | Title of the course | Yes |
Division ID | divisionId | String | ID of the division this course belongs to | No |
Division Name | divisionName | String | Name of the division this course belongs to | No |
Curriculum ID | curriculumId | String | ID of the curriculum this course belongs to | No |
Curriculum Title | curriculumTitle | String | Title of the curriculum this course belongs to | No |
Description | description | String | Description of the course | No |
Course Owner | admin | String | Owner of the course | No |
Course Status | courseStatus | String | Status of the course:
| No |
Course Created | courseCreated | String | Date the course was created | No |
User Count | userCount | Integer | Count of users assigned to the course | Yes |
Start Count | startCount | Integer | Count of users who have started the course | Yes |
Start Percentage | startPercentage | Integer | Percentage of assigned users who have started the course | Yes |
Completion Count | completedCount | Integer | Count of users who have completed the course | Yes |
Completion Percentage | completedPercentage | Integer | Percentage of assigned users who have completed the course | Yes |
Overdue Count | overdueCount | Integer | Count of users who are overdue on the course | Yes |
Overdue Percentage | overduePercentage | Integer | Percentage of assigned users who are overdue on the course | Yes |
Test Average | testAverage | Integer | Average score received by all users who have submitted the test on this course (- if no test exists) | Yes |
Pitch Average | pitchAverage | Integer | Average score received by all users who have submitted a Pitch IQ on this course (- if no Pitch IQ exists) | Yes |
Is SCORM | isScorm | String | Whether or not this is a SCORM-enabled course (Yes , No ) | No |
Has Test | hasTest | String | Whether or not there is a test attached to this course (Yes , No ) | No |
Has Pitch IQ | hasPitchIQ | String | Whether or not there is a Pitch IQ attached to this course (Yes , No ) | No |
Course & Group
Object name for API: CourseGroup
Field | JSON field | Data Type | Description | Visible by default |
---|---|---|---|---|
Course ID | courseId | String | ID of the course | No |
Course Title | courseTitle | String | Title of the course | Yes |
Division ID | divisionId | String | ID of the division this course belongs to | No |
Division Name | divisionName | String | Name of the division this course belongs to | No |
Curriculum ID | curriculumId | String | ID of the curriculum this course belongs to | No |
Curriculum Title | curriculumTitle | String | Title of the curriculum this course belongs to | No |
Description | description | String | Description of the course | No |
Course Owner | admin | String | Owner of the course | No |
Course Status | courseStatus | String | Status of the course:
| No |
Course Created | courseCreated | String | Date the course was created (YYYY/MM/DD ) | No |
Group ID | groupId | String | ID of the group | No |
Group Name | groupTitle | String | Name of the group | Yes |
Group Created Date | groupCreated | String | Date the group was created (YYYY/MM/DD ) | No |
Rolling Due Date | dueDays | Integer | Number of days after the group is assigned (or a new user is assigned to the group) that the course will be due | No |
Due Date | dueDate | String | Date the course is due for users in this group (YYYY/MM/DD ) | No |
Is Required (Not Elective) | required | String | Whether or not this course is required for the users in the group (Yes , No ) | No |
Is Visible (Not Hidden) | visible | String | Whether or not this course is visible in the Coach UI for users in the group (Yes , No ) | No |
Assigned Date | assignedDate | String | Date the group was assigned to the course (YYYY/MM/DD ) | No |
User Count | userCount | Integer | Count of users in this group assigned to the course | Yes |
Start Count | startCount | Integer | Count of users in this group who have started the course | Yes |
Start Percentage | startPercentage | Integer | Percentage of assigned users who have started the course | Yes |
Completion Count | completedCount | Integer | Count of users in this group who have completed the course | Yes |
Completion Percentage | completedPercentage | Integer | Percentage of assigned users who have completed the course | Yes |
Overdue Count | overdueCount | Integer | Count of users in this group who are overdue on the course | Yes |
Overdue Percentage | overduePercentage | Integer | Percentage of assigned users who are overdue on the course | Yes |
Test Average | testAverage | Integer | Average score received by all users in this group who have submitted the test on this course (- if no test exists) | Yes |
Pitch Average | pitchAverage | Integer | Average score received by all users in this group who have submitted a Pitch IQ on this course (- if no Pitch IQ exists) | Yes |
Is SCORM | isScorm | String | Whether or not this is a SCORM-enabled course (Yes , No ) | No |
Has Test | hasTest | String | Whether or not there is a test attached to this course (Yes , No ) | No |
Has Pitch IQ | hasPitchIQ | String | Whether or not there is a Pitch IQ attached to this course (Yes , No ) | No |
Course & User
Object name for API: CourseUser
Field | JSON field | Data Type | Description | Visible by default |
---|---|---|---|---|
User ID | userId | String | ID of the user | No |
First Name | firstName | String | First name of the user | Yes |
Last Name | lastName | String | Last name of the user | Yes |
email | String | Email address of the user | No | |
User Status | userStatus | String | Status of the user (Registered , Invited ) | No |
User Created Date | userCreated | String | Date the user was created (YYYY/MM/DD ) | No |
Assigned Group IDs | assignedGroupIds | String | Comma-separated list of IDs of groups the user is assigned to | No |
Assigned Group Names | assignedGroupTitles | String | Comma-separated list of names of groups the user is assigned to | No |
Course ID | courseId | String | ID of the course | No |
Course Title | courseTitle | String | Title of the course | Yes |
Division ID | divisionId | String | ID of the division this course belongs to | No |
Division Name | divisionName | String | Name of the division this course belongs to | No |
Curriculum ID | curriculumId | String | ID of the curriculum this course belongs to | No |
Curriculum Title | curriculumTitle | String | Title of the curriculum this course belongs to | No |
Description | description | String | Description of the course | No |
Course Owner | admin | String | Owner of the course | No |
Course Status | courseStatus | String | Status of the course:
| No |
Course Created | courseCreated | String | Date the course was created | No |
Assigned Date | assignedDate | String | Date the user was assigned to the course (YYYY/MM/DD ) | No |
Due Date | dueDate | String | Date the course is due for the user (YYYY/MM/DD ) | Yes |
Completion Date | completed | String | Date the user completed the course (YYYY/MM/DD ) | Yes |
Is Overdue | overdue | String | Whether or not the user is overdue for this course (Yes , No ) | Yes |
Is Required (Not Elective) | required | String | Whether or not the user is required to complete this course (Yes , No ) | No |
Learn Minutes | learnMinutes | Integer | Number of minutes the user has spent on the course | Yes |
Learn Progress | learnProgress | Integer | Percentage of items in this course completed (Yes , No ) | Yes |
Test Attempts | testAttempts | Integer | Number of attempts the user has made on the test for the course | Yes |
Test Score | testScore | Integer | Score the user received on the test for this course | Yes |
Pitch Attempts | pitchAttempts | Integer | Number of attempts the user has made on the Pitch IQ for the course | Yes |
Is Pitch IQ Submitted | pitchSubmitted | String | Whether or not the user has submitted a pitch for this course (Yes , No ) | Yes |
Pitch Score | pitchScore | Integer | Score the user received on the Pitch IQ for the course | Yes |
Pitch Passed | pitchPassed | String | Whether or not the user received a passing score on this Pitch IQ (Yes , No ) | No |
Is SCORM | isScorm | String | Whether or not this is a SCORM-enabled course (Yes , No ) | No |
Has Test | hasTest | String | Whether or not there is a test attached to this course (Yes , No ) | No |
Has Pitch IQ | hasPitchIQ | String | Whether or not there is a Pitch IQ attached to this course (Yes , No ) | No |
Pitch Review Due Date | pitchReviewDueDate | String | Date reviews for this pitch are due, if one exists (YYYY/MM/DD ) | No |
Pass/Fail Course | isPassFail | String | Whether or not the course can be failed (Yes , No ) | No |
Pitch Pass/Fail Status | pitchPassFailStatus | String | Whether or not the Pitch IQ attached to this course can be failed (Yes , No ) | No |
Test Pass/Fail Status | testPassFailStatus | String | Whether or not the test attached to this course can be failed (Yes , No ) | No |
Curriculum
Object name for API: Curriculum
Field | JSON field | Data Type | Description | Visible by default |
---|---|---|---|---|
Curriculum ID | curriculumId | String | ID of the curriculum | No |
Curriculum Title | curriculumTitle | String | Title of the curriculum | Yes |
Curriculum Created Date | curriculumCreated | String | Date the curriculum was created (YYYY/MM/DD ) | No |
Division ID | divisionId | String | ID of the division this curriculum belongs to | No |
Division Name | divisionName | String | Name of the division this curriculum belongs to | No |
Course Count | courseCount | Integer | Count of courses in the curriculum | Yes |
User Count | userCount | Integer | Count of users assigned to courses in this curriculum | Yes |
Start Count | startCount | Integer | Count of users who have started courses in this curriculum | Yes |
Start Percentage | startPercentage | Integer | Percentage of assigned users who have started courses in this curriculum | Yes |
Test Average | testAverage | Integer | Average score received by all users who have submitted the test on courses in this curriculum (- if no test exists) | Yes |
Pitch Average | pitchAverage | Integer | Average score received by all users who have submitted a Pitch IQ on courses in this curriculum (- if no Pitch IQ exists) | Yes |
Curriculum & Group
Object name for API: CurriculumGroup
Field | JSON field | Data Type | Description | Visible by default |
---|---|---|---|---|
Curriculum ID | curriculumId | String | ID of the curriculum | No |
Curriculum Title | curriculumTitle | String | Title of the curriculum | Yes |
Curriculum Created Date | curriculumCreated | String | Date the curriculum was created (YYYY/MM/DD ) | No |
Division ID | divisionId | String | ID of the division this curriculum belongs to | No |
Division Name | divisionName | String | Name of the division this curriculum belongs to | No |
Group ID | groupId | String | ID of the group | No |
Group Name | groupTitle | String | Name of the group | Yes |
Group Created Date | groupCreated | String | Date the group was created (YYYY/MM/DD ) | No |
Course Count | courseCount | Integer | Count of courses in the curriculum assigned to the group | Yes |
User Count | userCount | Integer | Count of users in this group assigned to courses in this curriculum | Yes |
Start Count | startCount | Integer | Count of users in this group who have started courses in this curriculum | Yes |
Start Percentage | startPercentage | Integer | Percentage of assigned users who have started courses in this curriculum | Yes |
Test Average | testAverage | Integer | Average score received by all users in this group who have submitted the test on courses in this curriculum (- if no test exists) | Yes |
Pitch Average | pitchAverage | Integer | Average score received by all users in this group who have submitted a Pitch IQ on courses in this curriculum (- if no Pitch IQ exists) | Yes |
Curriculum & User
Object name for API: CurriculumUser
Field | JSON field | Data Type | Description | Visible by default |
---|---|---|---|---|
Curriculum ID | curriculumId | String | ID of the curriculum | No |
Curriculum Title | curriculumTitle | String | Title of the curriculum | Yes |
Curriculum Created Date | curriculumCreated | String | Date the curriculum was created (YYYY/MM/DD ) | No |
Division ID | divisionId | String | ID of the division this curriculum belongs to | No |
Division Name | divisionName | String | Name of the division this curriculum belongs to | No |
User ID | userId | String | ID of the user | No |
First Name | firstName | String | First name of the user | Yes |
Last Name | lastName | String | Last name of the user | Yes |
Full Name | name | String | Full name of the user | No |
email | String | Email address of the user | No | |
User Status | userStatus | String | Status of the user (Registered , Invited ) | No |
User Created Date | userCreated | String | Date the user was created (YYYY/MM/DD ) | No |
Assigned Group IDs | assignedGroupIds | String | Comma-separated list of IDs of groups the user is assigned to | No |
Assigned Group Names | assignedGroupTitles | String | Comma-separated list of names of groups the user is assigned to | No |
Courses Assigned | coursesAssigned | Integer | Count of courses in the curriculum that the user is assigned to | Yes |
Courses Started | coursesStarted | Integer | Count of courses in the curriculum that the user has started | Yes |
Courses Completed | coursesCompleted | Integer | Count of courses in the curriculum that the user has completed | Yes |
Courses Overdue | coursesOverdue | Integer | Count of courses in the curriculum that the user is overdue on | No |
Published Courses Overdue | publishedCoursesOverdue | Integer | Count of published courses in the curriculum that the user is overdue on | No |
Test Average | testAverage | Integer | Average score received on all tests submitted in this curriculum | Yes |
Tests Taken | testsTaken | Integer | Count of tests in this curriculum that the user has submitted | No |
Tests Assigned | testsAssigned | Integer | Count of tests in this curriculum that the user is assigned to | No |
Pitch Average | pitchAverage | Integer | Average score received on all Pitch IQs submitted in this curriculum | Yes |
Group
Object name for API: Group
Field | JSON field | Data Type | Description | Visible by default |
---|---|---|---|---|
Division ID | divisionId | String | ID of the division the group belongs to | No |
Division Name | divisionName | String | Name of the division the group belongs to | No |
Group ID | groupId | String | ID of the group | No |
Group Name | groupTitle | String | Name of the group | Yes |
Group Created Date | groupCreated | String | Date the group was created (YYYY/MM/DD ) | No |
Course Count | courseCount | Integer | Count of courses the group is assigned to | No |
Assignment Count | assignmentCount | Integer | Count of all user assignments in the group (courses + paths) | No |
User Count | userCount | Integer | Count of users in the group | Yes |
Start Count | startCount | Integer | Count of courses started by all users in the group | Yes |
Start Percentage | startPercentage | Integer | Percentage of all assignments that have been started by users in the group | Yes |
Completion Count | completedCount | Integer | Count of completed courses for all users in the group | Yes |
Completion Percentage | completedPercentage | Integer | Overall percentage of assignments completed by users in the group | Yes |
Overdue Count | overdueCount | Integer | Count of assignments which are overdue for users in the group | Yes |
Overdue Percentage | overduePercentage | Integer | Overall percentage of assignments which are overdue for users in the group | Yes |
Test Average | testAverage | Integer | Average score received by all users in this group who have submitted tests (- if no test exists) | Yes |
Pitch Average | pitchAverage | Integer | Average score received by all users in this group who have submitted Pitch IQs (- if no Pitch IQ exists) | Yes |
Path
Object name for API: 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 UI.
Field | JSON field | Data Type | Description | Visible by default |
---|---|---|---|---|
Path ID | checklistId | String | ID of the path | No |
Path Title | checklistTitle | String | Title of the path | Yes |
Division ID | divisionId | String | ID of the division the path belongs to | No |
Division Name | divisionName | String | Name of the division the path belongs to | No |
Description | description | String | Description of the path | No |
Path Owner | admin | String | Owner of the path | Yes |
Path Status | checklistStatus | String | Status of the path:
| No |
Date Published | datePublished | String | Date the path was published (YYYY/MM/DD ) | No |
Path Created Date | checklistCreated | String | Date the path as created (YYYY/MM/DD ) | No |
Path Item Count | checklistItemCount | Integer | Count of items in the path | No |
User Count | userCount | Integer | Count of users assigned to the path | Yes |
Start Count | startCount | Integer | Count of users who have started the path | Yes |
Start Percentage | startPercentage | Integer | Percentage of assigned users who have started the path | Yes |
Completion Count | completedCount | Integer | Count of users who have completed the path | Yes |
Completion Percentage | completedPercentage | Integer | Percentage of assigned users who have completed the path | Yes |
Path & Group
Object name for API: ChecklistGroup
Field | JSON field | Data Type | Description | Visible by default |
---|---|---|---|---|
Path ID | checklistId | String | ID of the path | No |
Path Title | checklistTitle | String | Title of the path | Yes |
Division ID | divisionId | String | ID of the division the path belongs to | No |
Division Name | divisionName | String | Name of the division the path belongs to | No |
Description | description | String | Description of the path | No |
Path Owner | admin | String | Owner of the path | Yes |
Path Status | checklistStatus | String | Status of the path:
| No |
Date Published | datePublished | String | Date the path was published (YYYY/MM/DD ) | No |
Path Created Date | checklistCreated | String | Date the path as created (YYYY/MM/DD ) | No |
Group ID | groupId | String | ID of the group | No |
Group Name | groupTitle | String | Name of the group | Yes |
Group Created Date | groupCreated | String | Date the group was created (YYYY/MM/DD ) | No |
Path Item Count | checklistItemCount | Integer | Count of items in the path | No |
User Count | userCount | Integer | Count of users in the group assigned to the path | Yes |
Start Count | startCount | Integer | Count of users in the group who have started the path | Yes |
Start Percentage | startPercentage | Integer | Percentage of assigned users who have started the path | Yes |
Completion Count | completedCount | Integer | Count of users in the group who have completed the path | Yes |
Completion Percentage | completedPercentage | Integer | Percentage of assigned users who have completed the path | Yes |
Require Y/N | required | String | Whether or not the users in the group are required to complete the path | No |
Path Due Days | dueDays | String | Number of days after the group is assigned (or a new user is assigned to the group) that the path will be due | No |
Path Due Date | dueDate | String | Date the path is due for users in the group (YYYY/MM/DD ) | No |
Path & User
Object name for API: ChecklistUser
Field | JSON field | Data Type | Description | Visible by default |
---|---|---|---|---|
User ID | userId | String | ID of the user | No |
First Name | firstName | String | First name of the user | Yes |
Last Name | lastName | String | Last name of the user | Yes |
email | String | Email address of the user | No | |
User Status | userStatus | String | Status of the user (Registered , Invited ) | No |
Assigned Group IDs | assignedGroupIds | String | Comma-separated list of IDs of groups the user is assigned to | No |
Assigned Group Names | assignedGroupTitles | String | Comma-separated list of names of groups the user is assigned to | No |
Path ID | checklistId | String | ID of the path | No |
Path Title | checklistTitle | String | Title of the path | Yes |
Division ID | divisionId | String | ID of the division the path belongs to | No |
Division Name | divisionName | String | Name of the division the path belongs to | No |
Description | description | String | Description of the path | No |
Path Owner | admin | String | Owner of the path | Yes |
Path Status | checklistStatus | String | Status of the path:
| No |
Date Published | datePublished | String | Date the path was published (YYYY/MM/DD ) | No |
Path Created Date | checklistCreated | String | Date the path as created (YYYY/MM/DD ) | No |
Path Items Assigned | checklistItemsAssigned | Integer | Count of items in the path assigned to the user | Yes |
Path Items Started | checklistItemsStarted | Integer | Count of items in the path that the user has started | Yes |
Path Items Completed | checklistItemsCompleted | Integer | Count of items in the path that the user has completed | Yes |
Path Items Overdue | checklistItemsOverdue | Integer | Count of items in the path that the user is overdue on | Yes |
Required Y/N | required | String | Whether or not the user is required to complete the path (Y , N ) | No |
Path Due Date | dueDate | String | Date the path is due for this user | No |
Path Percent Complete | completedPercentage | Integer | Percentage of the path completed by the user | No |
Completion Date | completed | String | Date the user completed the path | No |
Path Item
Object name for API: Task
Field | JSON field | Data Type | Description | Visible by default |
---|---|---|---|---|
Path Item ID | checklistItemId | String | ID of the path item | No |
Path Item Title | checklistItemTitle | String | Title of the path item | Yes |
Description | description | String | Description of the path item | No |
Path Item Type | checklistItemType | String | Type of the path item (Task , Course , Live Training ) | Yes |
Path Item Status | checklistItemStatus | String | Path Item Status:
| No |
Path Item Created Date | checklistItemCreated | String | Date the path item was created | No |
Path ID | checklistId | String | ID of the path | No |
Path Title | checklistTitle | String | Title of the path | Yes |
Path Status | checklistStatus | String | Status of the path:
| No |
Division ID | divisionId | String | ID of the division the path belongs to | No |
Division Name | divisionName | String | Name of the division the path belongs to | No |
User Count | userCount | Integer | Count of users assigned to the course | Yes |
Start Count | startCount | Integer | Count of users who have started the course | Yes |
Start Percentage | startPercentage | Integer | Percentage of assigned users who have started the course | Yes |
Completion Count | completedCount | Integer | Count of users have completed the course | Yes |
Completion Percentage | completedPercentage | Integer | Percentage of assigned users who have completed the course | Yes |
Overdue Count | overdueCount | Integer | Count of users who are overdue on the course | Yes |
Overdue Percentage | overduePercentage | Integer | Percentage of assigned users who are overdue on the course | Yes |
Path Item & Group
Object name for API: TaskGroup
Field | JSON field | Data Type | Description | Visible by default |
---|---|---|---|---|
Path Item ID | checklistItemId | String | ID of the path item | No |
Path Item Title | checklistItemTitle | String | Title of the path item | Yes |
Description | description | String | Description of the path item | No |
Path Item Type | checklistItemType | String | Type of the path item (Task , Course , Live Training ) | Yes |
Path Item Status | checklistItemStatus | String | Path Item Status:
| No |
Path Item Created Date | checklistItemCreated | String | Date the path item was created | No |
Path ID | checklistId | String | ID of the path | No |
Path Title | checklistTitle | String | Title of the path | Yes |
Path Status | checklistStatus | String | Status of the path:
| No |
Division ID | divisionId | String | ID of the division the path belongs to | No |
Division Name | divisionName | String | Name of the division the path belongs to | No |
Group ID | groupId | String | ID of the group | No |
Group Name | groupTitle | String | Name of the group | Yes |
Group Created Date | groupCreated | String | Date the group was created (YYYY/MM/DD ) | No |
Rolling Due Date | dueDays | String | Number of days after the group is assigned (or a new user is assigned to the group) that the path item will be due | No |
Due Date | dueDate | String | Date the path item is due for users in the group (YYYY/MM/DD ) | No |
Assigned Date | assignedDate | String | Date the path item was assigned to the group (YYYY/MM/DD ) | No |
User Count | userCount | Integer | Count of users assigned to the course | Yes |
Start Count | startCount | Integer | Count of users who have started the course | Yes |
Start Percentage | startPercentage | Integer | Percentage of assigned users who have started the course | Yes |
Completion Count | completedCount | Integer | Count of users have completed the course | Yes |
Completion Percentage | completedPercentage | Integer | Percentage of assigned users who have completed the course | Yes |
Overdue Count | overdueCount | Integer | Count of users who are overdue on the course | Yes |
Overdue Percentage | overduePercentage | Integer | Percentage of assigned users who are overdue on the course | Yes |
Required Y/N | required | String | Whether or not the users in the group is required to complete the path (Y , N ) | No |
Path Item & User
Object name for API: TaskUser
Field | JSON field | Data Type | Description | Visible by default |
---|---|---|---|---|
User ID | userId | String | ID of the user | No |
First Name | firstName | String | First name of the user | Yes |
Last Name | lastName | String | Last name of the user | Yes |
email | String | Email address of the user | No | |
User Status | userStatus | String | Status of the user (Registered , Invited ) | No |
User Created Date | userCreated | String | Date the user was created (YYYY/MM/DD ) | No |
Assigned Group IDs | assignedGroupIds | String | Comma-separated list of IDs of groups the user is assigned to | No |
Assigned Group Names | assignedGroupTitles | String | Comma-separated list of names of groups the user is assigned to | No |
Path Item ID | checklistItemId | String | ID of the path item | No |
Path Item Title | checklistItemTitle | String | Title of the path item | Yes |
Description | description | String | Description of the path item | No |
Path Item Type | checklistItemType | String | Type of the path item (Task , Course , Live Training ) | Yes |
Path Item Status | checklistItemStatus | String | Path Item Status:
| No |
Path Item Created Date | checklistItemCreated | String | Date the path item was created | No |
Path ID | checklistId | String | ID of the path | No |
Path Title | checklistTitle | String | Title of the path | Yes |
Path Status | checklistStatus | String | Status of the path:
| No |
Division ID | divisionId | String | ID of the division the path belongs to | No |
Division Name | divisionName | String | Name of the division the path belongs to | No |
Due Date | dueDate | String | Date the path item is due for the user (YYYY/MM/DD ) | Yes |
Assigned Date | assignedDate | String | Date the path item was assigned to the user (YYYY/MM/DD ) | Yes |
Completion Date | completed | String | Date the user completed the path item (YYYY/MM/DD ) | Yes |
Is Overdue | overdue | String | Whether or not the user is overdue on the path item (Yes , No ) | Yes |
Required Y/N | required | String | Whether or not the user is required to complete the path item (Yes , No ) | No |
Pitch IQ Results
Object name for API: PitchReviews
Field | JSON field | Data Type | Description | Visible by default |
---|---|---|---|---|
Course ID | courseId | String | ID of the course | No |
Course Title | courseTitle | String | Title of the course | Yes |
Division ID | divisionId | String | ID of the division the course belongs to | No |
Division Name | divisionName | String | Name of the division the course belongs to | No |
User ID | userId | String | ID of the user | No |
First Name | firstName | String | First name of the user | Yes |
Last Name | lastName | String | Last name of the user | Yes |
email | String | Email address of the user | No | |
Assigned Group IDs | assignedGroupIds | String | Comma-separated list of IDs of groups the user is assigned to | No |
Assigned Group Names | assignedGroupTitles | String | Comma-separated list of names of groups the user is assigned to | Yes |
Reviewer Type | reviewerType | String | Type of review submitted by the reviewer (Peer , Manager , Admin ) | Yes |
Reviewer User ID | reviewerId | String | User ID of the reviewer | No |
Reviewer First Name | reviewerFirstName | String | First name of the reviewer | Yes |
Reviewer Last Name | reviewerLastName | String | Last name of the reviewer | Yes |
Pitch Score | pitchScore | Integer | Score given to the pitch by the reviewer | Yes |
Positives | positives | String | Positive feedback given by the reviewer | Yes |
Constructive | negatives | String | Constructive feedback given by the reviewer | Yes |
Pitch Reviewer Activities
Object name for API: PitchReviewerActivity
Field | JSON field | Data Type | Description | Visible by default |
---|---|---|---|---|
Course ID | courseId | String | ID of the course | No |
Course Title | courseTitle | String | Title of the course | Yes |
Division ID | divisionId | String | ID of the division the course belongs to | No |
Division Name | divisionName | String | Name of the division the course belongs to | No |
User ID | userId | String | ID of the user | No |
First Name | firstName | String | First name of the user | Yes |
Last Name | lastName | String | Last name of the user | Yes |
email | String | Email address of the user | No | |
Reviewer Type | reviewerType | String | Type of review submitted by the reviewer (Scorer , Reviewer ) | Yes |
Pitch Score | pitchScore | Integer | Average score given to pitches on the course by the reviewer | Yes |
Reviews Given | reviewsCompleted | Integer | Count of pitches reviewed on the course for the reviewer | Yes |
Reviews To Give | reviewsToGive | Integer | Count of pitches pending review on the course for the reviewer | Yes |
Test Results
Object name for API: TestQuestions
Field | JSON field | Data Type | Description | Visible by default |
---|---|---|---|---|
Test ID | testId | String | ID of the test | No |
Course ID | courseId | String | ID of the course | No |
Course Title | courseTitle | String | Title of the course | Yes |
Division ID | divisionId | String | ID of the division the course belongs to | No |
Division Name | divisionName | String | Name of the division the course belongs to | No |
Type | testType | String | Type of the test (Test , Survey ) | Yes |
User ID | userId | String | ID of the user | No |
First Name | firstName | String | First name of the user | Yes |
Last Name | lastName | String | Last name of the user | Yes |
email | String | Email address of the user | Yes | |
Assigned Group IDs | assignedGroupIds | String | Comma-separated list of IDs of groups the user is assigned to | No |
Assigned Group Names | assignedGroupTitles | String | Comma-separated list of names of groups the user is assigned to | No |
Test Score | testScore | Integer | Score received on the test by the user | Yes |
Question | question | String | Question content | Yes |
Response | response | String | Response submitted by the user for the question | Yes |
Correct | correct | String | Whether or not the user answered correctly (Yes , No ) | Yes |
User
Object name for API: User
Field | JSON field | Data Type | Description | Visible by default |
---|---|---|---|---|
User ID | userId | String | ID of the user | No |
First Name | firstName | String | First name of the user | Yes |
Last Name | lastName | String | Last name of the user | Yes |
Full Name | name | String | Full name of the user | No |
email | String | Email address of the user | No | |
User Status | userStatus | String | Status of the user (Registered , Invited ) | No |
User Created Date | userCreated | String | Date the user was created (YYYY/MM/DD ) | No |
Assigned Group IDs | assignedGroupIds | String | Comma-separated list of IDs of groups the user is assigned to | No |
Assigned Group Names | assignedGroupTitles | String | Comma-separated list of names of groups the user is assigned to | No |
Division ID | divisionId | String | ID of the division these statistics are calculated over | No |
Division Name | divisionName | String | Name of the division these statistics are calculated over | No |
Courses Assigned | coursesAssigned | Integer | Count of courses the user is assigned to | Yes |
Courses Completed | coursesCompleted | Integer | Count of courses the user has completed | Yes |
Courses Complete Percentage | coursesCompletedPercentage | Integer | Percentage of assigned courses the user has completed | Yes |
Courses Overdue | coursesOverdue | Integer | Count of courses the user is overdue for | Yes |
Published Courses Overdue | publishedCoursesOverdue | Integer | Count of published courses the user is overdue for | No |
Lessons Completed | lessonsCompleted | Integer | Count of all lessons completed in courses assigned to the user | No |
Test Average | testAverage | Integer | Average score received by the user on all tests | Yes |
Tests Taken | testsTaken | Integer | Count of tests submitted by the user | Yes |
Tests Assigned | testsAssigned | Integer | Count of courses with tests assigned to the user | Yes |
Pitches Assigned | pitchesAssigned | Integer | Count of courses with Pitch IQs assigned to the user | No |
Pitches Submitted | pitchesSubmitted | Integer | Count of Pitch IQs submitted by the user | No |
Pitch Average | pitchAverage | Integer | Average score received by the user on all Pitch IQs | Yes |