ibl-data-manager (3.59.0-ai-plus)
API for iblai
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 }
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.
- Mock server
https://docs.ibl.ai/_mock/apis/ibl/api/ai-analytics/overview/orgs/{org}/active-users
https://base.manager.iblai.app/api/ai-analytics/overview/orgs/{org}/active-users
- 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/overview/orgs/{org}/active-users?department_id=0&end_date=string&format=json&include_main_platform=true&start_date=string' \
-H 'Authorization: YOUR_API_KEY_HERE'{ "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 } }