ibl-data-manager (3.59.0-ai-plus)
API for iblai
Request
Retrieve user rating metrics over time.
This endpoint returns data on the number of user ratings submitted within a specified date range, aggregated by day or hour.
Args: request: The HTTP request containing filter query parameters. org: Organization key identifier.
Returns: Response: Time series of rating counts aggregated by day or hour.
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. group_by (str): Aggregation level (day or hour) - default: day.
- Mock server
https://docs.ibl.ai/_mock/apis/ibl/api/ai-analytics/orgs/{org}/users/{user_id}/rating-summary/
https://base.manager.iblai.app/api/ai-analytics/orgs/{org}/users/{user_id}/rating-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}/rating-summary/?end_date=string&group_by=day&start_date=string' \
-H 'Authorization: YOUR_API_KEY_HERE'
[ [ { … }, { … }, { … } ] ]
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.
- Mock server
https://docs.ibl.ai/_mock/apis/ibl/api/ai-analytics/orgs/{org}/users/{user_id}/registered-users-trend/
https://base.manager.iblai.app/api/ai-analytics/orgs/{org}/users/{user_id}/registered-users-trend/
- 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}/registered-users-trend/?aggregation=daily&end_date=string&group_by=day&start_date=string' \
-H 'Authorization: YOUR_API_KEY_HERE'
[ [ { … }, { … }, { … } ] ]
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.
- Mock server
https://docs.ibl.ai/_mock/apis/ibl/api/ai-analytics/orgs/{org}/users/{user_id}/sentiment-count/
https://base.manager.iblai.app/api/ai-analytics/orgs/{org}/users/{user_id}/sentiment-count/
- 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}/sentiment-count/?period=7d' \
-H 'Authorization: YOUR_API_KEY_HERE'
[ [ { … }, { … }, { … } ] ]