ibl-data-manager (3.59.0-ai-plus)
API for iblai
Request
Retrieve the most engaged students based on chat message count.
This endpoint returns data on the top 20 students with the highest number of chat messages, with optional filtering by mentor and date range.
Args: request: The HTTP request containing filter query parameters. org: Organization key identifier. user_id: User identifier (not used in the implementation).
Returns: Response: List of top students with their chat message counts.
Raises: NotFound: If the specified organization does not exist. BadRequest: If the provided parameters are invalid.
Query Parameters: mentor_id (str): Filter by mentor unique ID. start_date (str): Start date for filtering (YYYY-MM-DD). end_date (str): End date for filtering (YYYY-MM-DD).
- Mock server
https://docs.ibl.ai/_mock/apis/ibl/api/ai-analytics/orgs/{org}/users/{user_id}/top-students-by-chat-messages/
https://base.manager.iblai.app/api/ai-analytics/orgs/{org}/users/{user_id}/top-students-by-chat-messages/
- 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}/top-students-by-chat-messages/?group_by=day' \
-H 'Authorization: YOUR_API_KEY_HERE'[ [ { … }, { … }, { … } ] ]
Request
Retrieve aggregated topic statistics.
This endpoint returns statistical information about topics within an organization, including total topics, new topics, and percentage changes compared to the previous month. Results can be filtered by mentor.
Args: request: The HTTP request containing filter query parameters. org: Organization key identifier.
Returns: Response: Statistical information about topics.
Raises: NotFound: If the specified organization or mentor does not exist.
Query Parameters: mentor_id (str): Filter statistics by mentor unique ID.
- Mock server
https://docs.ibl.ai/_mock/apis/ibl/api/ai-analytics/orgs/{org}/users/{user_id}/topic-overview/
https://base.manager.iblai.app/api/ai-analytics/orgs/{org}/users/{user_id}/topic-overview/
- 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}/topic-overview/?mentor_id=string' \
-H 'Authorization: YOUR_API_KEY_HERE'{ "total_topics": 150, "total_topics_change_percentage": 12.5, "new_topics": 35, "new_topics_change_percentage": 8.3 }
Request
Retrieve paginated statistics about topics.
This endpoint returns detailed statistics about topics, including:
- Number of conversations related to each topic
- Total message count for each topic
- Average sentiment of conversations about each topic
- Average user rating for conversations about each topic
Results can be filtered by mentor and date range, and are paginated.
Args: request: The HTTP request containing filter query parameters. org: Organization key identifier.
Returns: Response: Paginated list of topic statistics.
Raises: NotFound: If the specified organization or mentor does not exist. BadRequest: If the provided parameters are invalid.
Query Parameters: start_date (str): Start date for filtering (YYYY-MM-DD). end_date (str): End date for filtering (YYYY-MM-DD). mentor_id (str): Filter by mentor unique ID. page (int): Page number for pagination - default: 1. page_size (int): Number of results per page - default: 20.
- Mock server
https://docs.ibl.ai/_mock/apis/ibl/api/ai-analytics/orgs/{org}/users/{user_id}/topic-statistics/
https://base.manager.iblai.app/api/ai-analytics/orgs/{org}/users/{user_id}/topic-statistics/
- 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}/topic-statistics/?end_date=string&group_by=day&mentor_id=string&page=1&page_size=20&start_date=string' \
-H 'Authorization: YOUR_API_KEY_HERE'{ "count": 35, "next": "https://api.example.com/analytics/topics/?page=2", "previous": null, "results": [ { … }, { … } ] }