Skip to content

ibl-data-manager (3.59.0-ai-plus)

API for iblai

Download OpenAPI description
Languages
Servers
Mock server

https://docs.ibl.ai/_mock/apis/ibl/

https://base.manager.iblai.app/

ai-account

Operations

ai-analytics

Operations

ai_analytics_orgs_users_conversation_summary_retrieve

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.

Security
PlatformApiKeyAuthentication
Path
orgstringrequired
user_idstringrequired
Query
group_bystringnon-empty
Default "day"
mentor_idstring

Filter by mentor unique ID

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'

Responses

Bodyapplication/json
total_conversationsintegerrequired
total_human_messagesintegerrequired
total_ai_messagesintegerrequired
Response
application/json
{ "total_conversations": 450, "total_human_messages": 2250, "total_ai_messages": 2450 }

ai_analytics_orgs_users_costs_model_retrieve

Request

Retrieve the model costs for a tenant

Filter parameters for period are start_date and enddate

Accessible to tenant Admins only.

Security
PlatformApiKeyAuthentication
Path
orgstringrequired
user_idstringrequired
Query
end_datestring(date-time)required
start_datestring(date-time)required
curl -i -X GET \
  'https://docs.ibl.ai/_mock/apis/ibl/api/ai-analytics/orgs/{org}/users/{user_id}/costs/model/?end_date=2019-08-24T14%3A15%3A22Z&start_date=2019-08-24T14%3A15%3A22Z' \
  -H 'Authorization: YOUR_API_KEY_HERE'

Responses

Bodyapplication/json
modelstringrequired
total_costnumber(double)required
Response
application/json
{ "model": "string", "total_cost": 0.1 }

ai_analytics_orgs_users_costs_permentor_retrieve

Request

Retrieve LLM usage costs aggregated by mentor.

This endpoint returns data on the total cost of LLM usage for each mentor within a specified date range, with pagination support. The costs are calculated by summing the costs of all observations associated with traces from the mentor's sessions.

Args: request: The HTTP request containing filter query parameters. org: Organization key identifier.

Returns: Response: Paginated list of mentors with their total LLM usage costs.

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. limit (int): Number of results per page - default: 5. offset (int): Offset for pagination - default: 0.

Security
PlatformApiKeyAuthentication
Path
orgstringrequired
user_idstringrequired
Query
end_datestring(date-time)required
start_datestring(date-time)required
curl -i -X GET \
  'https://docs.ibl.ai/_mock/apis/ibl/api/ai-analytics/orgs/{org}/users/{user_id}/costs/permentor/?end_date=2019-08-24T14%3A15%3A22Z&start_date=2019-08-24T14%3A15%3A22Z' \
  -H 'Authorization: YOUR_API_KEY_HERE'

Responses

Bodyapplication/json
tenantstringrequired
tenant_total_costnumber(double)required
mentor_dataArray of objects(MentorData)required
mentor_data[].​mentor_unique_idstringrequired
mentor_data[].​mentor_namestringrequired
mentor_data[].​total_costnumber(double)required
mentor_data[].​mentor_sessionsArray of objects(MentorSession)required
mentor_data[].​mentor_sessions[].​session_idstringrequired
mentor_data[].​mentor_sessions[].​costnumber(double)required
Response
application/json
{ "count": 15, "next": "https://api.example.com/analytics/llm-traces/cost/mentors/?limit=5&offset=5", "previous": null, "results": [ {}, {} ] }

ai-bot

Operations

ai-finetuning

Operations

ai-index

Operations

ai-marketing

Operations

ai-media

Operations

ai-mentor

Operations

ai-prompt

Operations

career

Operations

catalog

Operations

core

Operations

credentials

Operations

features

Operations

media

Operations

notifications

Operations

scim

Operations

commerce

Operations

recommendations

Operations

reports

Operations

skills

Operations