ibl-data-manager (3.59.0-ai-plus)
API for iblai
Request
Retrieve user sentiment counts over time.
This endpoint returns data on the number of user sentiment entries within a specified time period, aggregated by date.
Args: request: The HTTP request containing filter query parameters. org: Organization key identifier. user_id: User identifier.
Returns: Response: Time series data of sentiment counts.
Raises: NotFound: If the specified organization does not exist. ValidationError: If the provided query parameters are invalid.
Query Parameters: period (str): Time period filter (today, yesterday, 7d, 30d, 90d) - default: 7d.
- Mock server
https://docs.ibl.ai/_mock/apis/ibl/api/ai-analytics/orgs/{org}/users/{user_id}/sentiment-count/
https://base.manager.iblai.app/api/ai-analytics/orgs/{org}/users/{user_id}/sentiment-count/
- 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}/sentiment-count/?period=7d' \
-H 'Authorization: YOUR_API_KEY_HERE'[ [ { … }, { … }, { … } ] ]
Request
Retrieve LLM usage costs for a specific tenant.
This endpoint returns data on the total cost of LLM usage for a specific tenant within a specified date range. The cost is calculated by summing the costs of all observations associated with traces from the tenant's sessions.
Args: request: The HTTP request containing filter query parameters. org: Organization key identifier.
Returns: Response: Total LLM usage cost for the specified tenant.
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}/tenant-cost/
https://base.manager.iblai.app/api/ai-analytics/orgs/{org}/users/{user_id}/tenant-cost/
- 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}/tenant-cost/?end_date=2019-08-24T14%3A15%3A22Z&start_date=2019-08-24T14%3A15%3A22Z' \
-H 'Authorization: YOUR_API_KEY_HERE'{ "total_cost": 5.75 }
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'[ [ { … }, { … }, { … } ] ]