Skip to content
API Reference
/
ai-analytics
/
ai_analytics_orgs_users_user_metrics_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_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_analytics_orgs_users_user_metrics_retrieve

Request

Retrieve comprehensive user metrics.

This endpoint returns data on various user metrics with month-over-month change calculations:

  • Registered users: Total users registered on the platform
  • New users: Users who joined in the current month
  • Unique users: Distinct users who have had sessions
  • Veteran users: Users who have been active for at least 6 months

Results can be filtered by mentor.

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

Returns: Response: Comprehensive user metrics with month-over-month changes.

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

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

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

Filter metrics by mentor unique ID

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

Responses

Bodyapplication/json
registered_usersobject(UserMetric)required
registered_users.​totalintegerrequired
registered_users.​change_percentagenumber(double)required
new_usersobject(UserMetric)required
new_users.​totalintegerrequired
new_users.​change_percentagenumber(double)required
unique_usersobject(UserMetric)required
unique_users.​totalintegerrequired
unique_users.​change_percentagenumber(double)required
veteran_usersobject(UserMetric)required
veteran_users.​totalintegerrequired
veteran_users.​change_percentagenumber(double)required
Response
application/json
{
  "registered_users": {
    "total": 1250,
    "change_percentage": 8.75
  },
  "new_users": {
    "total": 85,
    "change_percentage": 12.5
  },
  "unique_users": {
    "total": 420,
    "change_percentage": 5.25
  },
  "veteran_users": {
    "total": 335,
    "change_percentage": 3.8
  }
}

ai_analytics_orgs_users_user_metrics_pie_chart_retrieve

Request

Retrieve user distribution data for pie charts.

This endpoint returns data on the distribution of new versus returning users within a specified date range, including both counts and percentages, suitable for pie chart visualization.

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

Returns: Response: Distribution of new versus returning users with counts and percentages.

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.

Security
PlatformApiKeyAuthentication
Path
orgstringrequired
user_idstringrequired
Query
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-metrics-pie-chart/?end_date=string&mentor_id=string&start_date=string' \
  -H 'Authorization: YOUR_API_KEY_HERE'

Responses

Bodyapplication/json
new_usersobject(PieChartSegment)required
new_users.​countintegerrequired
new_users.​percentagenumber(double)required
returning_usersobject(PieChartSegment)required
returning_users.​countintegerrequired
returning_users.​percentagenumber(double)required
Response
application/json
{
  "new_users": {
    "count": 85,
    "percentage": 28.33
  },
  "returning_users": {
    "count": 215,
    "percentage": 71.67
  }
}

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