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_registered_users_trend_list

Request

Retrieve trends of registered users over time.

This endpoint returns data on the number of new user registrations within a specified date range, with options for different time aggregations (hourly, daily, weekly, monthly). The data is backfilled to ensure continuous time series even for periods with zero registrations.

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

Returns: Response: Time series of user registration 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. aggregation (str): Time aggregation level (hourly, daily, weekly, monthly) - default: daily.

Security
PlatformApiKeyAuthentication
Path
orgstringrequired
user_idstringrequired
Query
aggregationstring

Time aggregation level (hourly, daily, weekly, monthly)

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

End date for filtering (YYYY-MM-DD)

group_bystringnon-empty
Default "day"
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}/registered-users-trend/?aggregation=daily&end_date=string&group_by=day&start_date=string' \
  -H 'Authorization: YOUR_API_KEY_HERE'

Responses

Bodyapplication/jsonArray [
intervalstring(date-time)required
countintegerrequired
]
Response
application/json
[ [ {}, {}, {} ] ]

ai_analytics_orgs_users_sentiment_count_list

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.

Security
PlatformApiKeyAuthentication
Path
orgstringrequired
user_idstringrequired
Query
periodstringnon-empty
Default "7d"
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'

Responses

Bodyapplication/jsonArray [
datestring(date-time)required
sentiment_countintegerrequired
]
Response
application/json
[ [ {}, {}, {} ] ]

ai_analytics_orgs_users_tenant_cost_retrieve

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.

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}/tenant-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-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