Skip to content
API Reference
/
ai-analytics
/
ai_analytics_orgs_users_user_cost_retrieve

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

API for iblai

Download OpenAPI description
ibl.json
ibl.yaml
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_user_cohorts_over_time_retrieve

Request

Retrieve user cohort trends over time.

This endpoint returns data on the distribution of new versus veteran users over time, with options for different time aggregations and filtering by mentor. New users are those who registered within the specified date range, while veteran users are those who registered before the date range but were active during it.

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

Returns: Response: Time series of new and veteran user 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) - default: daily. mentor_id (str): Filter by mentor unique ID.

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)

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}/user-cohorts-over-time/?aggregation=daily&end_date=string&mentor_id=string&start_date=string' \
  -H 'Authorization: YOUR_API_KEY_HERE'

Responses

Bodyapplication/json
periodsArray of strings(date-time)required
new_usersArray of integersrequired
veteran_usersArray of integersrequired
Response
application/json
{
  "periods": [
    "2023-06-01T00:00:00Z",
    "2023-06-02T00:00:00Z",
    "2023-06-03T00:00:00Z"
  ],
  "new_users": [
    8,
    12,
    5
  ],
  "veteran_users": [
    42,
    38,
    45
  ]
}

ai_analytics_orgs_users_user_cost_retrieve

Request

Retrieve LLM usage costs for a specific user.

This endpoint returns data on the total cost of LLM usage for a specific user 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. user_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
orgstringrequired
user_idstringrequired
Query
end_datestring(date-time)required
start_datestring(date-time)required
usernamestringnon-emptyrequired
curl -i -X GET \
  'https://docs.ibl.ai/_mock/apis/ibl/api/ai-analytics/orgs/{org}/users/{user_id}/user-cost/?end_date=2019-08-24T14%3A15%3A22Z&start_date=2019-08-24T14%3A15%3A22Z&username=string' \
  -H 'Authorization: YOUR_API_KEY_HERE'

Responses

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

ai_analytics_orgs_users_user_feedback_list

Request

Retrieve aggregated user chat feedback counts.

This endpoint returns data on the number of user chat feedback entries 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.

Returns: Response: Time series data of feedback 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.

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)

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}/user-feedback/?aggregation=daily&end_date=string&mentor_id=string&start_date=string' \
  -H 'Authorization: YOUR_API_KEY_HERE'

Responses

Bodyapplication/jsonArray [
periodstring(date-time)required
feedback_countintegerrequired
]
Response
application/json
[
  [
    { … },
    { … },
    { … }
  ]
]

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
Copyright © ibl.ai | support@iblai.zendesk.com