ibl-data-manager (3.59.0-ai-plus)
API for iblai
Request
Retrieve comprehensive user metrics.
This endpoint returns data on various user metrics with month-over-month change calculations:
- Registered users: Total users registered on the platform
- New users: Users who joined in the current month
- Unique users: Distinct users who have had sessions
- Veteran users: Users who have been active for at least 6 months
Results can be filtered by mentor.
Args: request: The HTTP request containing filter query parameters. org: Organization key identifier.
Returns: Response: Comprehensive user metrics with month-over-month changes.
Raises: NotFound: If the specified organization does not exist.
Query Parameters: mentor_id (str): Filter metrics by mentor unique ID.
- Mock server
https://docs.ibl.ai/_mock/apis/ibl/api/ai-analytics/orgs/{org}/users/{user_id}/user-metrics/
https://base.manager.iblai.app/api/ai-analytics/orgs/{org}/users/{user_id}/user-metrics/
- curl
- JavaScript
- Node.js
- Python
- Java
- C#
- PHP
- Go
- Ruby
- R
- Payload
curl -i -X GET \
'https://docs.ibl.ai/_mock/apis/ibl/api/ai-analytics/orgs/{org}/users/{user_id}/user-metrics/?group_by=day&mentor_id=string' \
-H 'Authorization: YOUR_API_KEY_HERE'{ "registered_users": { "total": 1250, "change_percentage": 8.75 }, "new_users": { "total": 85, "change_percentage": 12.5 }, "unique_users": { "total": 420, "change_percentage": 5.25 }, "veteran_users": { "total": 335, "change_percentage": 3.8 } }
Request
Retrieve user distribution data for pie charts.
This endpoint returns data on the distribution of new versus returning users within a specified date range, including both counts and percentages, suitable for pie chart visualization.
Args: request: The HTTP request containing filter query parameters. org: Organization key identifier.
Returns: Response: Distribution of new versus returning users with counts and percentages.
Raises: NotFound: If the specified organization does not exist. BadRequest: If the provided parameters are invalid.
Query Parameters: start_date (str): Start date for filtering (YYYY-MM-DD) - required. end_date (str): End date for filtering (YYYY-MM-DD) - required. mentor_id (str): Filter by mentor unique ID.
- Mock server
https://docs.ibl.ai/_mock/apis/ibl/api/ai-analytics/orgs/{org}/users/{user_id}/user-metrics-pie-chart/
https://base.manager.iblai.app/api/ai-analytics/orgs/{org}/users/{user_id}/user-metrics-pie-chart/
- curl
- JavaScript
- Node.js
- Python
- Java
- C#
- PHP
- Go
- Ruby
- R
- Payload
curl -i -X GET \
'https://docs.ibl.ai/_mock/apis/ibl/api/ai-analytics/orgs/{org}/users/{user_id}/user-metrics-pie-chart/?end_date=string&mentor_id=string&start_date=string' \
-H 'Authorization: YOUR_API_KEY_HERE'{ "new_users": { "count": 85, "percentage": 28.33 }, "returning_users": { "count": 215, "percentage": 71.67 } }
Request
Retrieve user sentiment distribution.
This endpoint returns data on the distribution of user sentiments (positive, negative, neutral) within a specified date range, expressed as percentages.
Args: request: The HTTP request containing filter query parameters. org: Organization key identifier.
Returns: Response: Sentiment distribution percentages and total sentiment count.
Raises: NotFound: If the specified organization does not exist. BadRequest: If the provided parameters are invalid.
Query Parameters: start_date (str): Start date for filtering (YYYY-MM-DD) - required. end_date (str): End date for filtering (YYYY-MM-DD) - required.
- Mock server
https://docs.ibl.ai/_mock/apis/ibl/api/ai-analytics/orgs/{org}/users/{user_id}/user-sentiment/
https://base.manager.iblai.app/api/ai-analytics/orgs/{org}/users/{user_id}/user-sentiment/
- curl
- JavaScript
- Node.js
- Python
- Java
- C#
- PHP
- Go
- Ruby
- R
- Payload
curl -i -X GET \
'https://docs.ibl.ai/_mock/apis/ibl/api/ai-analytics/orgs/{org}/users/{user_id}/user-sentiment/?end_date=string&group_by=day&start_date=string' \
-H 'Authorization: YOUR_API_KEY_HERE'{ "sentiment_distribution": { "positive": 65.25, "negative": 12.5, "neutral": 22.25 }, "total_sentiments": 400 }