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_mentors_cost_retrieve

Request

Retrieve LLM usage costs for a specific mentor.

This endpoint returns data on the total cost of LLM usage for a specific mentor 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. mentor_unique_id: User 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.

Security
PlatformApiKeyAuthentication
Path
mentor_unique_idstringrequired
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}/mentors/{mentor_unique_id}/cost/?end_date=2019-08-24T14%3A15%3A22Z&start_date=2019-08-24T14%3A15%3A22Z' \
  -H 'Authorization: YOUR_API_KEY_HERE'

Responses

Bodyapplication/json
total_costnumber(double)required
Response
application/json
{ "total_cost": 5.75 }

ai_analytics_orgs_users_most_discussed_topics_list

Request

Retrieve the most discussed topics over time.

This endpoint returns data on the frequency of topics discussed in conversations within a specified date range, with options for filtering by mentor and aggregating by different time periods (hourly, daily, weekly).

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

Returns: Response: List of topics with their conversation counts, ordered by frequency.

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.

Security
PlatformApiKeyAuthentication
Path
orgstringrequired
user_idstringrequired
Query
aggregationstring

Time aggregation level (hourly, daily, weekly)

Default "daily"
Enum"daily""hourly""weekly"
end_datestringrequired

End date for filtering (YYYY-MM-DD)

group_bystringnon-empty
Default "day"
mentor_idstring

Filter by mentor unique ID

start_datestringrequired

Start date for filtering (YYYY-MM-DD)

curl -i -X GET \
  'https://docs.ibl.ai/_mock/apis/ibl/api/ai-analytics/orgs/{org}/users/{user_id}/most-discussed-topics/?aggregation=daily&end_date=string&group_by=day&mentor_id=string&start_date=string' \
  -H 'Authorization: YOUR_API_KEY_HERE'

Responses

Bodyapplication/jsonArray [
topic_namestringrequired
conversation_countintegerrequired
]
Response
application/json
[ [ {}, {}, {} ] ]

ai_analytics_orgs_users_observations_list

Request

Viewset for retrieving and listing Langfuse observations.

This viewset provides read-only access to Langfuse observations data for platform admins. Observations represent detailed tracking of AI model interactions and responses.

Permissions:

  • Restricted to platform administrators only
Security
PlatformApiKeyAuthentication
Path
orgstringrequired
user_idstringrequired
Query
limitinteger

Number of results to return per page.

offsetinteger

The initial index from which to return the results.

orderingstring

Which field to use when ordering the results.

searchstring

A search term.

curl -i -X GET \
  'https://docs.ibl.ai/_mock/apis/ibl/api/ai-analytics/orgs/{org}/users/{user_id}/observations/?limit=0&offset=0&ordering=string&search=string' \
  -H 'Authorization: YOUR_API_KEY_HERE'

Responses

Bodyapplication/json
countintegerrequired
Example: 123
nextstring or null(uri)
Example: "http://api.example.org/accounts/?offset=400&limit=100"
previousstring or null(uri)
Example: "http://api.example.org/accounts/?offset=200&limit=100"
resultsArray of objects(Observation)required
results[].​idstringrequired
results[].​trace_idstringrequired
results[].​typestringrequired
results[].​parent_observation_idstring or null
results[].​start_timestring(date-time)required
results[].​end_timestring or null(date-time)
results[].​namestringrequired
results[].​metadataanyrequired
results[].​levelstringrequired
results[].​status_messagestring or null
results[].​versionstring or null
results[].​inputstring or null
results[].​outputstring or null
results[].​provided_model_namestring or null
results[].​internal_model_idstring or null
results[].​model_parametersstring or null
results[].​provided_usage_detailsstringrequired
results[].​usage_detailsstringrequired
results[].​provided_cost_detailsstringrequired
results[].​cost_detailsstringrequired
results[].​total_coststring or null(decimal)^-?\d{0,6}(?:\.\d{0,12})?$
results[].​completion_start_timestring or null(date-time)
results[].​prompt_idstring or null
results[].​prompt_namestring or null
results[].​prompt_versioninteger or null[ 0 .. 65535 ]
results[].​created_atstring(date-time)read-onlyrequired
results[].​updated_atstring(date-time)
results[].​event_tsstring(date-time)required
results[].​is_deletedinteger[ 0 .. 255 ]required
Response
application/json
{ "count": 123, "next": "http://api.example.org/accounts/?offset=400&limit=100", "previous": "http://api.example.org/accounts/?offset=200&limit=100", "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