/rest/reports/learning
Description:
A learning report for incremental reporting.
Results are queried incrementally, bringing only data updated after a past date (default/max is 31 days).
Request Example:
POST /rest/reports/learning HTTP/1.1 Authorization: Bearer {access-token} Body: { "accountSlugs": ["AccountSlug"], "medium": "download" }Response Example:
Response Headers: content-type: text/csv; charset=utf-8 Response Body: "account_id";"user_id";"user_email";"user_job_position";"user_first_name";"user_last_name";"user_username";"account_user_external_id";"group_slugs";"store_slug";"country_name_first_translation";"category_id";"category_title_id_first_translation";"metric_category_available_tracks";"metric_category_finished_tracks";"metric_category_engagement";"learning_path_id";"learning_path_name";"learning_path_start_date";"learning_path_start_time";"learning_path_published_date";"learning_content_id";"learning_content_name";"learning_content_start_date";"learning_content_start_time";"learning_content_published_date";"metric_user_learning_path_amount_available_modules";"metric_user_learning_path_amount_finished_modules";"metric_user_learning_path_amount_engagement_modules";"module_id";"module_name";"module_created_at";"metric_user_module_completion_time_secs";"module_score";"metric_user_learning_path_final_test_score";"metric_user_learning_path_final_test_date";"metric_user_learning_path_final_test_time";"module_progress_done_at";"metric_user_link_progress";"learning_content_type";"learning_path_published";"learning_path_publish_job";"learning_content_published";"learning_content_publish_job";"store_ref_code" ...
/rest/reports/users/learning-paths
Description:
Returns a list of learning paths belonging to the account.
The result is sorted by learning_path_id. For each learning path, it includes:
Number of users with access
Number of active users
Percentage of active users
Request Example:
POST /rest/reports/users/learning-paths HTTP/1.1 Authorization: Bearer {access-token} Body: { "accountSlugs": ["AccountSlug"], "medium": "download" }Response Example:
Response Headers: content-type: text/csv; charset=utf-8 Response Body: "learning_path_id","learning_path_name","learing_path_type","access_users","active_users","active_of_access" "4578","Leco Name 1","Crash Course","40","20",0.5 "4579","Leco Name 2","Crash Course","10","10",1.0 ...
/rest/reports/users/progress
Description:
Returns a score report for a specific user.
Request Example:
POST /rest/reports/users/progress HTTP/1.1 Authorization: Bearer {access-token} Body: { "accountSlugs": ["AccountSlug"], "medium": "download", "parameters": { "userId": 123 } }Response Example:
Response Headers: content-type: text/csv; charset=utf-8 Response Body: "account_id";"user_id";"user_email";"user_full_name";"user_username";"user_company_id";"learning_path_id";"learning_path_name";"level_id";"level_title";"level_test_highest_score";"topic_id";"topic_title";"topic_test_highest_score";"moment_id";"moment_title";"moment_test_highest_score" ...
/rest/reports/learning-paths/engagements
Description:
Returns a list of learning paths belonging to the account.
The result is sorted by learning_path_id. For each learning path, it includes:
Number of users with access
Number of active users
Percentage of active users
Request Example:
POST /rest/reports/learning-paths/engagements HTTP/1.1 Authorization: Bearer {access-token} Body: { "accountSlugs": ["AccountSlug"], "medium": "download" }Response Example:
Response Headers: content-type: text/csv; charset=utf-8 Response Body: "learning_path_id","learning_path_name","learing_path_type","access_users","active_users","active_of_access" "4578","Leco Name 1","Crash Course","40","20",0.5 "4579","Leco Name 2","Crash Course","10","10",1.0 ...
/rest/reports/learning-contents
Description:
Returns a list of learning contents belonging to the account.
The result is sorted by learning_content_id and type.
If the content is a learning path, its rows are expanded by learning moments (modules).
Request Example:
POST /rest/reports/learning-contents HTTP/1.1 Authorization: Bearer {access-token} Body: { "accountSlugs": ["AccountSlug"], "medium": "download" }Response Example:
Response Headers: content-type: text/csv; charset=utf-8 Response Body: "learning_content_id","learning_content_name","type","categories","learning_moment_id","learning_moment_name" "4578","Leco Name","Learning Path","Category1, Category2","543","Learning Moment 1" "4578","Leco Name","Learning Path","Category1, Category2","544","Learning Moment 2" "4578","Leco Name","Learning Path","Category1, Category2","545","Learning Moment 3" ...
/rest/reports/stores/engagements
Description:
Returns a list of stores with engagement
The result is sorted by store name. For each store, it includes:
Number of associated users
Number of active users (started a learning path)
Percentage of active users
Request Example:
POST /rest/reports/stores/engagements HTTP/1.1 Authorization: Bearer {access-token} Body: { "accountSlugs": ["AccountSlug"], "medium": "download" }Response Example:
Response Headers: content-type: text/csv; charset=utf-8 Response Body: "Store","users","active_users","active_of_users" "XPTO","70","15","0.21" ...
/rest/reports/users/performance/top
Description:
Returns the top 10 users with performance metrics, sorted by average scores. For each user:
Average module score (first attempt only)
Average module score (all attempts)
Request Example:
POST /rest/reports/users/performance/top HTTP/1.1 Authorization: Bearer {access-token} Body: { "accountSlugs": ["AccountSlug"], "medium": "download" }Response Example:
Response Headers: content-type: text/csv; charset=utf-8 Response Body: "id","first_name","last_name","username","email","avg_first_modules_score","avg_modules_score" "3429","John","Doe","JohnDoe","[email protected]","77.6","96.5" ...
/rest/reports/users/activation
Description:
Returns account-level activation metrics, including:
Total users (invited + registered)
Registered users
Anonymous users (no email/phone)
SSO users (external integration)
Active users (completed at least one learning moment)
Active user percentages
Request Example:
POST /rest/reports/users/activation HTTP/1.1 Authorization: Bearer {access-token} Body: { "accountSlugs": ["AccountSlug"], "medium": "download" }Response Example:
Response Headers: content-type: text/plain; charset=utf-8 Response Body: { "users": 3487, "registered_users": 3487, "anonymous_users": 0, "sso_users": 0, "active_users": 3487, "active_of_all_inclusive": 1, "active_of_users": 1 }/rest/reports/users/performance/average
Description:
Returns a list of users with their average scores, sorted by user_id. For each user:
Average module score (first attempt only)
Average module score (all attempts)
Average test score (first attempt only)
Average test score (all attempts)
Request Example:
POST /rest/reports/users/performance/average HTTP/1.1 Authorization: Bearer {access-token} Body: { "accountSlugs": ["AccountSlug"], "medium": "download" }Response Example:
Response Headers: content-type: text/csv; charset=utf-8 Response Body: "id","first_name","last_name","username","email","avg_first_modules_score","avg_modules_score","avg_first_tests_score","avg_tests_score" "3429","John","Doe","JohnDoe","[email protected]","77.6","96.5","71.2","90.8" ...
/rest/reports/users/modules/time
Description:
Returns module completion time per user.
⚠️ A cutoff of 20 minutes is applied in case the app is left open.
Request Example:
POST /rest/reports/users/modules/time HTTP/1.1 Authorization: Bearer {access-token} Body: { "accountSlugs": ["AccountSlug"], "medium": "download" }Response Example:
Response Headers: content-type: text/csv; charset=utf-8 Response Body: "user_id";"username";"user_full_name";"user_email";"learning_path_id";"learning_path_name";"level_id";"level_name";"topic_id";"topic_name";"module_id";"module_name";"time_spent" ...
/rest/reports/users/modules
Description:
Returns a list of users associated with learning paths, expanded up to modules.
For each user-module:
Start date
Completion date (null if not finished)
Results are ordered by user ID, then learning path ID. Roles:user, coach.
Request Example:
POST /rest/reports/users/modules HTTP/1.1 Authorization: Bearer {access-token} Body: { "accountSlugs": ["AccountSlug"], "medium": "download" }Response Example:
Response Headers: content-type: text/csv; charset=utf-8 Response Body: "id","first_name","last_name","username","email","learning_path_id","learning_path_name","module_1","module_name","module_started_at","module_finished_at" "3429","John","Doe","JohnDoe","[email protected]","166","Cool Lepa","1","Module 1","2022-06-32 16:33:21","null" "3429","John","Doe","JohnDoe","[email protected]","166","Cool Lepa","2","Module 2","null","null" ...
/rest/reports/users/performance/v2/modules
Description:
Returns users associated with learning paths, expanded up to modules.
Includes module score, first attempts, completion status, and timing.
Request Example:
POST /rest/reports/users/performance/v2/modules HTTP/1.1 Authorization: Bearer {access-token} Body: { "accountSlugs": ["AccountSlug"], "medium": "download" }Response Example:
Response Headers: content-type: text/csv; charset=utf-8 Response Body: "account_id";"user_id";"user_company_id";"user_email";"username";"user_full_name";"learning_path_id";"learning_path_name";"learning_path_type";"level_id";"level_name";"topic_id";"topic_name";"module_id";"module_name";"module_score";"module_first_attempt";"module_first_pass";"time" ...
/rest/reports/users/performance/v2/skills
Description:
Returns users expanded by skill/topic progress and scores.
Includes attempts, first attempt markers, and learning path/level details.
Request Example:
POST /rest/reports/users/performance/v2/skills HTTP/1.1 Authorization: Bearer {access-token} Body: { "accountSlugs": ["AccountSlug"], "medium": "download" }Response Example:
Response Headers: content-type: text/csv; charset=utf-8 Response Body: "account_id";"user_id";"user_company_id";"user_email";"username";"user_full_name";"learning_path_id";"learning_path_name";"level_id";"level_title";"topic_id";"topic_title";"topic_score";"topic_first_attempt";"topic_first_pass";"time" ...
/rest/reports/users/performance/v2/levels
Description:
Returns users expanded by level progress and scores.
Includes attempts, first attempt markers, and learning path/level details.
Request Example:
POST /rest/reports/users/performance/v2/levels HTTP/1.1 Authorization: Bearer {access-token} Body: { "accountSlugs": ["AccountSlug"], "medium": "download" }Response Example:
Response Headers: content-type: text/csv; charset=utf-8 Response Body: "account_id";"user_id";"user_company_id";"user_email";"username";"user_full_name";"learning_path_id";"learning_path_name";"level_id";"level_title";"level_score";"level_first_attempt";"level_first_pass";"time" ...
/rest/reports/countries/engagements
Description:
Returns a list of countries with associated users.
For each country:
Number of associated users
Active users
Active user percentage
Request Example:
POST /rest/reports/countries/engagements HTTP/1.1 Authorization: Bearer {access-token} Body: { "accountSlugs": ["AccountSlug"], "medium": "download" }Response Example:
Response Headers: content-type: text/csv; charset=utf-8 Response Body: "country","users","active_users","active_of_users" "Belgium","70","15","0.21" ...
/rest/reports/users/categories
Description:
Returns users associated with learning paths, expanded by categories.
For each user-path, the report shows completion status and categories.
Results are ordered by user ID, then learning path ID.
Request Example:
POST /rest/reports/users/categories HTTP/1.1 Authorization: Bearer {access-token} Body: { "accountSlugs": ["AccountSlug"], "medium": "download" }Response Example:
Response Headers: content-type: text/csv; charset=utf-8 Response Body: "id","first_name","last_name","username","email","learning_path_id","learning_path_name","finished_at","category" "3429","John","Doe","JohnDoe","[email protected]","166","Cool Lepa","2022-06-32 16:33:21","Finance" ...
/rest/reports/users/performance/learning-formats
Description:
Returns learning format attempt information per user.
Request Example:
POST /rest/reports/users/performance/learning-formats HTTP/1.1 Authorization: Bearer {access-token} Body: { "accountSlugs": ["AccountSlug"], "medium": "download" }Response Example:
Response Headers: content-type: text/csv; charset=utf-8 Response Body: "account_id";"user_id";"user_email";"user_job_position";"user_full_name";"user_username";"user_account_id";"user_groups";"user_stores";"user_stores_countries";"learning_path_slug";"learning_path_type";"level_id";"level_title";"skill_id";"skill_title";"module_id";"module_title";"learning_format_id";"learning_format_title";"learning_format_question";"total_attempts";"total_correct";"total_mistakes";"correct_last_attempt" ...
/rest/reports/users/learning-path-completion
Description:
Returns learning path completion and certification data per user.
Request Example:
POST /rest/reports/users/learning-path-completion HTTP/1.1 Authorization: Bearer {access-token} Body: { "accountSlugs": ["AccountSlug"], "medium": "download" }Response Example:
Response Headers: content-type: text/csv; charset=utf-8 Response Body: "account_id";"user_id";"user_email";"user_job_position";"user_full_name";"user_username";"account_user_external_id";"group_slugs";"store_slug";"country_name_first_translation";"category_title_id_first_translation";"learning_path_id";"learning_path_name";"learning_path_started";"learning_path_completed";"learning_path_start_date";"learning_path_published_date";"metric_user_learning_path_amount_available_modules";"metric_user_learning_path_amount_finished_modules";"metric_user_learning_path_amount_engagement_modules";"metric_user_learning_path_final_test_score";"metric_user_learning_path_final_test_date";"learning_path_publish_job";"learning_path_published";"certified" ...
/rest/reports/learning-paths/ratings
Description:
Returns all ratings per learning
path.
Request Example:
POST /rest/reports/learning-paths/ratings HTTP/1.1 Authorization: Bearer {access-token} Body: { "accountSlugs": ["AccountSlug"], "medium": "download" }Response Example:
Response Headers: content-type: text/csv; charset=utf-8 Response Body: "account_id";"user_id";"user_email";"user_job_position";"user_full_name";"user_username";"account_user_external_id";"group_slugs";"store_slug";"country_name_first_translation";"learning_path_id";"learning_path_name";"learning_path_published_date";"learning_path_publish_job";"learning_path_published";"learning_path_started";"learning_path_completed";"rating_score";"rating_date" ...
/rest/reports/users/scorm
Description:
This endpoint lists all users that have access to SCORM content with the completion rates of each user/content.
Request Example:
POST /rest/reports/users/scorm HTTP/1.1 Authorization: Bearer {access-token} Body:{"accountSlugs": ["AccountSlug"],"medium": "download"}Response Example:
Response Headers: content-type: text/csv; charset=utf-8 Response Body:"account_id";"user_id";"user_email";"user_job_position";"user_full_name";"user_username";"company_id";"groups_slugs";"stores";"category_id";"category";"scorm_id";"scorm_name";"scorm_published_date";"created_date";"first_access_date";"last_access_date";"completed_date";"score";"total_seconds_tracked";"content_type";"is_published_or_scheduled"...