API Data Information

Assessment Endpoint:

GET /partners/users/{external_user_id}/assessments/

This endpoint allows you to gather data around the VPA® and VPA® with the oral proficiency test (OPT). For each learner, you can get information on:

  1. The date the assessment was completed
  2. Whether or not the VPA® had a speaking section
  3. The total score
  4. The listening score
  5. The reading score
  6. The speaking score
  7. The overall level name the learner is in
  8. The reading level name the learner is in
  9. The grammar level name the learner is in
  10. The listening level name the learner is in
  11. The speaking level name the learner is in

Group Tutoring Endpoints:

GET /partners/users/{external_user_id}/group_sessions

This endpoint allows you to get data on the group sessions attended for each learner. Specifically, you will be able to see:

  1. The session ID
  2. The title of the group session
  3. The start time for the session
  4. The end time for the session
  5. Whether the learner attended or not

GET /partners/group_sessions/{group_session_id}/feedback/

This endpoint will enable you to gather data around the feedback received for learners within group sessions. Specifically, you will be able to get information on:

  1. The group session ID
  2. Session comments
  3. A description and score for each learning area (fluency, listening, grammar, pronunciation, vocabulary)

GET /partners/group_sessions/tutor/{external_user_id}

This endpoint will enable you to gather data around the group sessions a tutor within your organization has conducted. Specifically, the information will include:

  1. Group session title
  2. Group session start time
  3. Group session end time
  4. User IDs of learners who attended the session

GET /partners/feature_groups/{group_id}/group_sessions

This endpoint will enable you to gather data around private group sessions that were provided to specific groups within an organization. Specifically, the data will include information on:

  1. The group session title
  2. The group session tutor
  3. The start time
  4. The end time
  5. The user IDs for learners who attended

GET /partners/group_sessions/

This endpoint will provide you with information around group sessions that were held for your organization. Specifically, the data will include:

  1. Group session title
  2. Group session tutor
  3. Session start time
  4. Session end time
  5. User IDs of learners who attended the session

Private Tutoring Endpoints:

GET /partners/users/{external_user_id}/private_sessions

This endpoint allows you to get data on the all past and future private sessions learners have booked and whether or not they attended. Specifically, you will be able to see:

  1. The session ID
  2. User ID
  3. The start time for the session
  4. The end time for the session
  5. Whether the learner attended or not

GET /partners/private_sessions/{id}/feedback

This endpoint allows you to get data on the all private session feedback that was delivered to a learner by a tutor. Specifically, you will be able to see:

  1. The session ID
  2. The start time for the session
  3. The end time for the session
  4. Tutor notes
  5. Targeted feedback
  6. Next steps
  7. Vocabulary score for the session
  8. Grammar score for the session
  9. Pronunciation score for the session
  10. Listening score for the session

GET /partners/private_sessions/tutor/{external_user_id}

This endpoint allows you to get data on the all past and future private sessions that are and have been scheduled for a specific tutor within the organization. Specifically, you will be able to see:

  1. The session ID
  2. User ID
  3. The start time for the session
  4. The end time for the session
  5. Whether the tutor attended or not

 

Time On Task

GET /partners/users/{external_user_id}/timeontask

You can now use the Partner API to gather data for time on task for individual learners within an organization. You can optionally pass a start date and end date to gather data for a specific period of time.

Specific data that can be accessed includes:

  1. Time on task in assessments
  2. Time on task in lessons/activities
  3. Time on task in Grammar Guide
  4. Tie on task in word bank
  5. Time on task in private sessions
  6. Time on task in group sessions
  7. Total time on task

Note: Time on task data is passed in seconds.

Was this article helpful?
0 out of 0 found this helpful
Have more questions? Submit a request

Comments

0 comments

Article is closed for comments.