Skip to content
API Reference
/
ai-analytics
/
audience_orgs_active_users_over_time_retrieve

ibl-data-manager (3.59.0-ai-plus)

API for iblai

Download OpenAPI description
ibl.json
ibl.yaml
Languages
Servers
Mock server

https://docs.ibl.ai/_mock/apis/ibl/

https://base.manager.iblai.app/

ai-account

Operations

ai-analytics

Operations

Get total time spent for current user

Request

Returns the total time spent (in seconds) for the current authenticated user. Can be filtered by platform, date range, course ID, URL, mentor UUID, and session UUID.

Query
course_idstringnon-empty

Course ID to filter by (can be partial)

end_datestring(date)

End date for time range (YYYY-MM-DD)

include_main_platformboolean

Whether to include main platform data

Default true
learner_idstringnon-empty

Username to get data for (admin users only)

mentor_uuidstringnon-empty

Mentor UUID to filter by

platformstring or nullnon-empty

Platform name or key to filter by

session_uuidstringnon-empty

Session UUID to filter by

start_datestring(date)

Start date for time range (YYYY-MM-DD)

urlstringnon-empty

URL to filter by (can be partial)

curl -i -X GET \
  'https://docs.ibl.ai/_mock/apis/ibl/api/analytics/time-spent/user/?course_id=string&end_date=2019-08-24&include_main_platform=true&learner_id=string&mentor_uuid=string&platform=string&session_uuid=string&start_date=2019-08-24&url=string'

Responses

Bodyapplication/json
total_secondsintegerrequired
Response
application/json
{
  "total_seconds": 0
}

audience_orgs_active_users_over_time_retrieve

Request

Get active user counts over time.

This endpoint provides daily counts of active users (users with known activity) over a specified time period.

Query Parameters: start_date (str, optional): Start date for the time range (ISO format) end_date (str, optional): End date for the time range (ISO format)

Returns: Daily active user counts over the specified time period, with change metrics compared to previous periods.

Default time range is the last 7 days if no dates are specified.

An active user is defined as a user with any activity within the past 30 days.

Security
PlatformApiKeyAuthentication
Path
orgstringrequired
Query
department_idinteger

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

end_datestringnon-empty

end date. ISO 8601

formatstringnon-empty

Format

  • json - json
Default "json"
Value"json"
include_main_platformboolean

Include main platform data

Default true
start_datestringnon-empty

start date. ISO 8601

curl -i -X GET \
  'https://docs.ibl.ai/_mock/apis/ibl/api/audience/orgs/{org}/active-users/over-time?department_id=0&end_date=string&format=json&include_main_platform=true&start_date=string' \
  -H 'Authorization: YOUR_API_KEY_HERE'

Responses

Bodyapplication/json
dataobject

Dates are keys and values are the value for the date in the key. e,g {"2020-01-01": 30. ...}

totalinteger

Total

metaobject(OvertimeMeta)required
meta.​totalintegerrequired

Total records

meta.​change_rangeinteger

Change in range

Default 0
meta.​change_last_seven_daysinteger

Change in last 7 days

Default 0
meta.​change_last_thirty_daysinteger

Change in last 30 days

Default 0
meta.​change_last_seven_days_percentnumber(double)

Change in last 7 days in percentage

Default 0
meta.​change_last_thirty_days_percentnumber(double)

Change in last 30 days in percentage

Default 0
meta.​change_range_percentnumber(double)

Change in range in percentage

Response
application/json
{
  "data": {
    "property1": null,
    "property2": null
  },
  "total": 0,
  "meta": {
    "total": 0,
    "change_range": 0,
    "change_last_seven_days": 0,
    "change_last_thirty_days": 0,
    "change_last_seven_days_percent": 0,
    "change_last_thirty_days_percent": 0,
    "change_range_percent": 0.1
  }
}

audience_orgs_active_users_per_course_retrieve

Request

Get active user counts on a per-course basis.

This endpoint provides counts of active users for each course within the specified date range.

Query Parameters: start_date (str, optional): Start date for filtering (ISO format) end_date (str, optional): End date for filtering (ISO format)

Returns: A list of courses with their active user counts.

Default time range is the last 7 days if no dates are specified.

Security
PlatformApiKeyAuthentication
Path
orgstringrequired
Query
department_idinteger

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

end_datestringnon-empty

end date. ISO 8601

formatstringnon-empty

Format

  • json - json
Default "json"
Value"json"
include_main_platformboolean

Include main platform data

Default true
start_datestringnon-empty

start date. ISO 8601

curl -i -X GET \
  'https://docs.ibl.ai/_mock/apis/ibl/api/audience/orgs/{org}/active-users/per-course?department_id=0&end_date=string&format=json&include_main_platform=true&start_date=string' \
  -H 'Authorization: YOUR_API_KEY_HERE'

Responses

Bodyapplication/json
dataArray of objects(ActiveUsersPerCourseData)required
data[].​course_idstringrequired

Edx Course ID

data[].​namestringrequired

Course Name

data[].​user_countintegerrequired

Active users for the period

totalintegerrequired

Total unique active users in this period

metaobject(OvertimeMeta)required
meta.​totalintegerrequired

Total records

meta.​change_rangeinteger

Change in range

Default 0
meta.​change_last_seven_daysinteger

Change in last 7 days

Default 0
meta.​change_last_thirty_daysinteger

Change in last 30 days

Default 0
meta.​change_last_seven_days_percentnumber(double)

Change in last 7 days in percentage

Default 0
meta.​change_last_thirty_days_percentnumber(double)

Change in last 30 days in percentage

Default 0
meta.​change_range_percentnumber(double)

Change in range in percentage

Response
application/json
{
  "data": [
    { … }
  ],
  "total": 0,
  "meta": {
    "total": 0,
    "change_range": 0,
    "change_last_seven_days": 0,
    "change_last_thirty_days": 0,
    "change_last_seven_days_percent": 0,
    "change_last_thirty_days_percent": 0,
    "change_range_percent": 0.1
  }
}

ai-bot

Operations

ai-finetuning

Operations

ai-index

Operations

ai-marketing

Operations

ai-media

Operations

ai-mentor

Operations

ai-prompt

Operations

career

Operations

catalog

Operations

core

Operations

credentials

Operations

features

Operations

media

Operations

notifications

Operations

scim

Operations

commerce

Operations

recommendations

Operations

reports

Operations

skills

Operations
Copyright © ibl.ai | support@iblai.zendesk.com