ibl-data-manager (3.59.0-ai-plus)
API for iblai
Request
API viewset for retrieving and filtering chat message history.
This viewset provides endpoints for retrieving chat message history within an organization, with extensive filtering options by date range, user, topic, mentor, and sentiment.
Permissions:
- Restricted to platform administrators only
- Mock server
https://docs.ibl.ai/_mock/apis/ibl/api/ai-analytics/orgs/{org}/users/{user_id}/chat-history/{id}/
https://base.manager.iblai.app/api/ai-analytics/orgs/{org}/users/{user_id}/chat-history/{id}/
- curl
- JavaScript
- Node.js
- Python
- Java
- C#
- PHP
- Go
- Ruby
- R
- Payload
curl -i -X DELETE \
'https://docs.ibl.ai/_mock/apis/ibl/api/ai-analytics/orgs/{org}/users/{user_id}/chat-history/{id}/?end_date=2019-08-24&filter_user_id=string&mentor=497f6eca-6276-4993-bfeb-53cbbbba6f08&sentiment=string&start_date=2019-08-24&topics=string' \
-H 'Authorization: YOUR_API_KEY_HERE'Request
Retrieve conversation volume data over time.
This endpoint returns data on the number of conversations that occurred within a specified date range, with options for different time aggregations (hourly, daily, weekly). Results can be filtered by mentor.
Args: request: The HTTP request containing filter query parameters. org: Organization key identifier. user_id: User identifier (not used in the implementation).
Returns: Response: Time series data of conversation counts.
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. aggregation (str): Time aggregation level (hourly, daily, weekly) - default: daily.
- Mock server
https://docs.ibl.ai/_mock/apis/ibl/api/ai-analytics/orgs/{org}/users/{user_id}/conversation/
https://base.manager.iblai.app/api/ai-analytics/orgs/{org}/users/{user_id}/conversation/
- 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}/conversation/?aggregation=daily&end_date=string&mentor_id=string&start_date=string' \
-H 'Authorization: YOUR_API_KEY_HERE'[ [ { … }, { … }, { … } ] ]
Request
Retrieve a summary of conversation metrics.
This endpoint returns aggregated metrics about conversations within an organization, including:
- Total number of conversations
- Total number of human messages
- Total number of AI messages
Results can be filtered by mentor.
Args: request: The HTTP request containing filter query parameters. org: Organization key identifier.
Returns: Response: Summary of conversation metrics.
Raises: NotFound: If the specified organization does not exist.
Query Parameters: 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}/conversation-summary/
https://base.manager.iblai.app/api/ai-analytics/orgs/{org}/users/{user_id}/conversation-summary/
- 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}/conversation-summary/?group_by=day&mentor_id=string' \
-H 'Authorization: YOUR_API_KEY_HERE'{ "total_conversations": 450, "total_human_messages": 2250, "total_ai_messages": 2450 }