The Timeline API returns a chronological list of platform events and user activities. Use the Get timeline endpoint to retrieve events. Each event has a type; the API returns the API value (e.g. user_login_user).
Timeline event mappings
User events
| Event | API value |
|---|
| User log in | user_login_user |
| User registration | user_create_user |
| User self registration | user_self_register |
| User deletion | user_delete_user |
| Undelete user | user_undelete_user |
| User update | user_update_user |
| User payment | user_create_payment |
| User level | user_upgrade_level |
| User badge | user_unlock_badge |
Course events
| Event | API value |
|---|
| Course creation | course_create_course |
| Course deletion | course_delete_course |
| Undelete course | course_undelete_course |
| Course update | course_update_course |
| Added user to course | course_add_user |
| Removed user from course | course_remove_user |
| User completed course | course_completion |
| User did not pass course | course_failure |
| Reset progress | course_user_progress_reset |
Branch events
| Event | API value |
|---|
| Branch creation | branch_create_branch |
| Branch deletion | branch_delete_branch |
| Branch update | branch_update_branch |
| Added user to branch | branch_add_user |
| Removed user from branch | branch_remove_user |
| Added course to branch | branch_add_course |
| Removed course from branch | branch_remove_course |
Group events
| Event | API value |
|---|
| Group creation | group_create_group |
| Group deletion | group_delete_group |
| Group update | group_update_group |
| Added user to group | group_add_user |
| Removed user from group | group_remove_user |
| Added course to group | group_add_course |
| Removed course from group | group_remove_course |
Certification events
| Event | API value |
|---|
| Certification issued to user | certification_issue_certification |
| Certification renewed | certification_refresh_certification |
| Certification removed | certification_remove_certification |
| Certification expired | certification_expire_certification |
Unit progress events
| Event | API value |
|---|
| Test completion | unitprogress_test_completion |
| Test fail | unitprogress_test_fail |
| Survey completion | unitprogress_survey_completion |
| Assignment submission | unitprogress_assignment_answered |
| Assignment grading | unitprogress_assignment_graded |
| ILT grading | unitprogress_ilt_graded |
Notification events
| Event | API value |
|---|
| Notification creation | notification_create_notification |
| Notification deletion | notification_delete_notification |
| Notification update | notification_update_notification |
Automation events
| Event | API value |
|---|
| Automation creation | automation_create_automation |
| Automation deletion | automation_delete_automation |
| Automation update | automation_update_automation |
Custom report events
| Event | API value |
|---|
| Custom report creation | reports_create_custom_report |
| Custom report deletion | reports_delete_custom_report |
| Custom report update | reports_update_custom_report |
Using the timeline
Call GET /api/v2/timeline with your API key and X-API-Version header. Use the event type values in the response to filter or display activities. For full request and response details, see Get timeline in the API Reference.