Skip to content
API Reference
/
ai-analytics
/
ai_analytics_orgs_users_rating_summary_list

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_overview_summary_retrieve

Request

Retrieve an overview of key analytics metrics.

This endpoint returns a comprehensive overview of key analytics metrics for an organization, including:

  • Conversation volume: Total sessions and month-over-month change
  • Users: Total unique users and month-over-month change
  • Topics: Total unique topics and month-over-month change
  • User ratings: Total ratings and month-over-month change

Results can be filtered by mentor.

Args: request: The HTTP request containing filter query parameters. org: Organization key identifier. user_id: User identifier (not used in the implementation).

Returns: Response: Overview of key analytics metrics with month-over-month changes.

Raises: NotFound: If the specified organization does not exist.

Query Parameters: mentor_id (str): Filter analytics by mentor unique ID.

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

Filter analytics by mentor unique ID

curl -i -X GET \
  'https://docs.ibl.ai/_mock/apis/ibl/api/ai-analytics/orgs/{org}/users/{user_id}/overview-summary/?group_by=day&mentor_id=string' \
  -H 'Authorization: YOUR_API_KEY_HERE'

Responses

Bodyapplication/json
conversation_volumeobject(MetricChange)required
conversation_volume.​totalintegerrequired
conversation_volume.​changenumber(double)required
usersobject(MetricChange)required
users.​totalintegerrequired
users.​changenumber(double)required
topicsobject(MetricChange)required
topics.​totalintegerrequired
topics.​changenumber(double)required
user_ratingobject(MetricChange)required
user_rating.​totalintegerrequired
user_rating.​changenumber(double)required
Response
application/json
{
  "conversation_volume": {
    "total": 450,
    "change": 12.5
  },
  "users": {
    "total": 120,
    "change": 8.3
  },
  "topics": {
    "total": 35,
    "change": 5.2
  },
  "user_rating": {
    "total": 280,
    "change": 15.7
  }
}

ai_analytics_orgs_users_rating_summary_list

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.

Security
PlatformApiKeyAuthentication
Path
orgstringrequired
user_idstringrequired
Query
end_datestringrequired

End date for filtering (YYYY-MM-DD)

group_bystring

Aggregation level (day or hour)

Default "day"
Enum"day""hour"
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}/rating-summary/?end_date=string&group_by=day&start_date=string' \
  -H 'Authorization: YOUR_API_KEY_HERE'

Responses

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

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-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