The LearningStudio User Interface tracks the time that students spend throughout the course - on all content items and learning tools. This API allows your app to add information to that collection. This includes rendering content, providing an alternate threaded discussions experience, and exams.
Best Practice: If your app replicates features of the User Interface, you are strongly encouraged to leverage these APIs.
When the clock starts with this API, it continues tracking time until either of the following occurs:
- This API is called again to start tracking the user activity for another course item. This action ends the previously active ping.
.../endpingresource is called (see Stop Tracking Time Spent).
- The clock reaches 45 minutes, at which point it times out. This is undesirable because it will skew metrics, be sure to call the Stop Tracking Time Spent API.
Note: This data is not retrievable by API. It can be viewed in the User Activity view of the LearningStudio Gradebook User Interface, or retrieved via the institution's Enterprise Reporting subscription.
|Authentication Protocols||OAuth 1.0a, OAuth 2.0|
|Valid for Roles (OAuth 2):||Professor, Teaching Assistant, Student|
HTTP Verbs and URIs
- Starts the activity tracking clock.
||LearningStudio User ID or
||LearningStudio Course ID. This API does not support overloads.||Numeric ID issued by LearningStudio|
||LearningStudio Content Item ID the user is accessing via your application. Time is recorded against content.||Numeric ID issued by LearningStudio|
||Desired format of response data. See Response Formats.||
Query String Parameters
No query string parameters are supported.
The API returns a
204 - No Content error code on success.
No response body is returned by this API.
HTTP Status Code
204 - No Content