perlearner_orgs_users_last_access

ai-account

Operations

ai-analytics

Operations

perlearner_orgs_users_info_retrieve

Request

Retrieve detailed information about a specific learner.

This endpoint returns personal and activity information about a learner, including profile data, activity metrics, and location information.

Path Parameters: user_id (str): The username or email of the learner

Query Parameters: meta (bool): Include additional analytics information when true

Returns: Detailed learner information including:

Profile data (username, name, email)
Registration and activity dates
Activity metrics (assessments, time spent, videos watched)
Location and browser information (when available)

Access Control:

Platform admins can access any learner
Learners can access their own information
Department admins can access learners in their departments

Security

PlatformApiKeyAuthentication

Path

orgstringrequired

user_idstringrequired

Query

department_idinteger

When department_mode=1 is passed, it allows to filter data for only user content groups for the specified department

formatstringnon-empty

Format

json - json

Default "json"

Value"json"

include_main_platformboolean

Include main platform data

Default true

metastringnon-empty

Include extra analytics information?

y - y
yes - yes
true - true
True - True
n - n
no - no
false - false
False - False

Default "n"

Enum"y""yes""true""True""n""no""false""False"

searchstringnon-empty

curl -i -X GET \
  'https://docs.ibl.ai/_mock/apis/ibl/api/perlearner/orgs/{org}/users/{user_id}/info?department_id=0&format=json&include_main_platform=true&meta=y&search=string' \
  -H 'Authorization: YOUR_API_KEY_HERE'

Responses

Bodyapplication/json

dataobject(LearnerInformationAPIData)required

data.usernamestringrequired

learner username

data.namestringrequired

learner Name

data.emailstringrequired

learner email

data.date_joinedstringrequired

Registration Timestamp e.g 2022-05-05T00:00:00+00:00

data.last_activitystringrequired

Last Activity Timestamp e.g 2022-05-05T00:00:00+00:00

data.total_assessmentsinteger

Total assessments attempted

data.total_time_spentinteger

Total time spent in seconds

data.total_videosinteger

Total videos watched

data.course_completionsinteger

Total courses completed

data.time_spent_overtimeobject

data.continentstring

last location - continent

data.continent_codestring

last location - continent code

data.countrystring

last location - country

data.country_codestring

last location - country code

data.regionstring

last location - region

data.region_codestring

last location - region code

data.locationstring

last location

data.citystring

last location - city

data.browserstring

last known browser

data.operating_systemstring

last known operating system

data.resolutionstring

last known browser resolution

Response

application/json

{
  "data": {
    "username": "string",
    "name": "string",
    "email": "string",
    "date_joined": "string",
    "last_activity": "string",
    "total_assessments": 0,
    "total_time_spent": 0,
    "total_videos": 0,
    "course_completions": 0,
    "time_spent_overtime": { … },
    "continent": "string",
    "continent_code": "string",
    "country": "string",
    "country_code": "string",
    "region": "string",
    "region_code": "string",
    "location": "string",
    "city": "string",
    "browser": "string",
    "operating_system": "string",
    "resolution": "string"
  }
}