Skip to content
API Reference/
/
analytics_users_retrieve

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_topics_details_retrieve

Request

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 topic name

start_datestring(date)
curl -i -X GET \
  'https://docs.ibl.ai/_mock/apis/ibl/api/analytics/topics/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

Bodyapplication/json
resultsArray of objects(TopicDetail)required
results[].​namestringrequired
results[].​messagesintegerrequired
results[].​conversationsintegerrequired
results[].​sessionsintegerrequired
results[].​average_ratingstring
results[].​rating_countinteger
paginationobjectrequired
pagination.​property name*anyadditional property
Response
application/json
{
  "results": [
    { … }
  ],
  "pagination": {
    "property1": null,
    "property2": null
  }
}

analytics_users_retrieve

Request

User Analytics API - Comprehensive user activity metrics and trends.

Provides real-time and historical user analytics including:

  • Currently active users (last hour)
  • Active users over time periods (7d, 30d, 90d)
  • Registered user counts and growth
  • Time series charts with customizable granularity

Key Features:

  • Real-time active user counting
  • Percentage change calculations vs previous periods
  • Flexible date filtering and granularity
  • Platform and mentor-specific filtering
  • Forward-filled time series data

Supported Metrics:

  • currently_active: Users active in last hour
  • active_users: Unique users in specified period
  • registered_users: Total and new user counts
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)
granularitystringnon-empty
  • day - day
  • hour - hour
  • week - week
  • month - month
Default "hour"
Enum"day""hour""week""month"
mentor_unique_idstring(uuid)
metricstringnon-emptyrequired
  • currently_active - Users logged in right now
  • active_users - Active users in a period
  • registered_users - Registered users
  • active_users_last_30d - Active users in the last 30 days
Enum"currently_active""active_users""registered_users""active_users_last_30d"
platform_keystringnon-empty
start_datestring(date)
curl -i -X GET \
  'https://docs.ibl.ai/_mock/apis/ibl/api/analytics/users/?date_filter=today&end_date=2019-08-24&granularity=day&mentor_unique_id=497f6eca-6276-4993-bfeb-53cbbbba6f08&metric=currently_active&platform_key=string&start_date=2019-08-24' \
  -H 'Authorization: YOUR_API_KEY_HERE'

Responses

User analytics metrics with comparison data

Bodyapplication/json
metricstring
Default "currently_active"
countintegerrequired
changeintegerrequired
Response
application/json

Users currently active in the last hour

{
  "metric": "currently_active",
  "count": 45,
  "change": 12
}

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
  }
}

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