Built LMS Help Center
API Reference and PlaygroundUsers and GroupsUser Analytics

GET Get user analytics

Retrieve comprehensive analytics and statistics for users, including enrollment data, role distribution, and learning activity metrics

GET
/users/analytics

Retrieve comprehensive analytics and statistics for users, including enrollment data, role distribution, and learning activity metrics

Authorization

AuthorizationBearer <token>

Send API keys and access tokens as Authorization: Bearer .

In: header

Query Parameters

user_id?string

Filter analytics for specific user

Formatuuid
period?string

Time period for analytics data

Default"30d"

Value in

  • "7d"
  • "30d"
  • "90d"
  • "1y"
include_details?boolean

Include detailed analytics like top users and time series data

Defaultfalse

Response Body

application/json

application/json

application/json

application/json

application/json

curl -X GET "https://example.com/users/analytics"
{  "data": {    "summary": {      "total_users": 0,      "active_users": 0,      "inactive_users": 0,      "new_users_in_period": 0,      "users_with_enrollments": 0,      "user_engagement_rate": 0,      "avg_enrollments_per_user": 0    },    "distributions": {      "roles": {        "property1": 0,        "property2": 0      }    },    "learning_activity": {      "total_enrollments": 0,      "completed_enrollments": 0,      "completion_rate": 0    },    "user_analytics": {      "user_id": "{user_id}",      "email": "user@example.com",      "first_name": "string",      "last_name": "string",      "total_enrollments": 0,      "completed_enrollments": 0,      "completion_rate": 0,      "total_time_minutes": 0,      "last_activity_at": "2019-08-24T14:15:22Z"    },    "top_users": [      {        "user_id": "{user_id}",        "email": "user@example.com",        "first_name": "string",        "last_name": "string",        "display_name": "string",        "total_enrollments": 0,        "completed_enrollments": 0,        "completion_rate": 0,        "last_activity_at": "2019-08-24T14:15:22Z"      }    ],    "time_series": [      {        "date": "2019-08-24",        "new_users": 0,        "active_users": 0,        "total_enrollments": 0,        "completed_enrollments": 0      }    ]  },  "meta": {    "period": "string",    "start_date": "2019-08-24T14:15:22Z",    "end_date": "2019-08-24T14:15:22Z",    "user_id": "{user_id}",    "include_details": true,    "organization_id": "{organization_id}",    "rls_validation": {      "enforced": true,      "organization_isolated": true    }  }}