Skip to content
API Reference/
/
audience_orgs_active_user...

ibl-data-manager (4.84.1-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

analytics_users_details_retrieve

Request

User Details API - Comprehensive user activity details with search and filtering.

Provides detailed user information including:

  • User contact information (email, full name)
  • Activity metrics (message count, last activity)
  • Search functionality across multiple fields
  • Flexible date range filtering
  • CSV export capability

Key Features:

  • Full-text search across email, name, and user ID
  • Date range filtering for activity periods
  • Platform and mentor-specific filtering
  • Comprehensive pagination with metadata
  • CSV export for data analysis
  • User aggregation across platforms/mentors

Search Capabilities:

  • Email address matching
  • Full name search
  • User ID lookup
  • Partial string matching (case-insensitive)

Export Options:

  • JSON response (default)
  • CSV export (?export=csv)
  • Includes all user fields in export
Security
PlatformApiKeyAuthentication
Query
date_filterstringnon-empty
  • today - Today only
  • 7d - Last 7 days
  • 30d - Last 30 days
  • 90d - Last 90 days
  • all_time - All time
  • custom - Custom date range
Default "today"
Enum"today""7d""30d""90d""all_time""custom"
end_datestring(date)
limitinteger[ 1 .. 100 ]
Default 20
mentor_unique_idstring(uuid)
pageinteger>= 1
Default 1
platform_keystringnon-empty
searchstring

Search by email, full name, or user ID

start_datestring(date)
curl -i -X GET \
  'https://docs.ibl.ai/_mock/apis/ibl/api/analytics/users/details/?date_filter=today&end_date=2019-08-24&limit=20&mentor_unique_id=497f6eca-6276-4993-bfeb-53cbbbba6f08&page=1&platform_key=string&search=string&start_date=2019-08-24' \
  -H 'Authorization: YOUR_API_KEY_HERE'

Responses

Paginated user details with activity metrics

Bodyapplication/json
emailstring(email)required
full_namestringrequired
messagesintegerrequired
conversationsintegerrequired
last_activitystring(date-time)required
Response
application/json

Paginated list of users with activity details

{
  "results": [
    { … },
    { … }
  ],
  "total": 1250,
  "pagination": {
    "page": 1,
    "limit": 50,
    "total_pages": 25,
    "has_next": true,
    "has_previous": false,
    "start_index": 1,
    "end_index": 50
  }
}

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

analytics

Operations

career

Operations

catalog

Operations

core

Operations

credentials

Operations

custom-domains

Operations

features

Operations

media

Operations

notifications

Operations

scim

Operations

commerce

Operations

recommendations

Operations

reports

Operations

skills

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