Skip to content
API Reference
/
ai-analytics
/
ai_analytics_orgs_users_topics_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_topic_statistics_retrieve

Request

Retrieve paginated statistics about topics.

This endpoint returns detailed statistics about topics, including:

  • Number of conversations related to each topic
  • Total message count for each topic
  • Average sentiment of conversations about each topic
  • Average user rating for conversations about each topic

Results can be filtered by mentor and date range, and are paginated.

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

Returns: Response: Paginated list of topic statistics.

Raises: NotFound: If the specified organization or mentor does not exist. BadRequest: If the provided parameters are invalid.

Query Parameters: start_date (str): Start date for filtering (YYYY-MM-DD). end_date (str): End date for filtering (YYYY-MM-DD). mentor_id (str): Filter by mentor unique ID. page (int): Page number for pagination - default: 1. page_size (int): Number of results per page - default: 20.

Security
PlatformApiKeyAuthentication
Path
orgstringrequired
user_idstringrequired
Query
end_datestring

End date for filtering (YYYY-MM-DD)

group_bystringnon-empty
Default "day"
mentor_idstring

Filter by mentor unique ID

pageinteger

Page number for pagination

Default 1
page_sizeinteger

Number of results per page

Default 20
start_datestring

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}/topic-statistics/?end_date=string&group_by=day&mentor_id=string&page=1&page_size=20&start_date=string' \
  -H 'Authorization: YOUR_API_KEY_HERE'

Responses

Bodyapplication/json
countintegerrequired
nextstring or null(uri)required
previousstring or null(uri)required
resultsArray of objects(TopicStatistics)required
results[].​namestringrequired
results[].​conversationsintegerrequired
results[].​messagesintegerrequired
results[].​avg_sentimentstringrequired
results[].​avg_user_ratingstringrequired
Response
application/json
{
  "count": 35,
  "next": "https://api.example.com/analytics/topics/?page=2",
  "previous": null,
  "results": [
    { … },
    { … }
  ]
}

ai_analytics_orgs_users_topics_summary_list

Request

Retrieve a summary of the most frequent topics.

This endpoint returns a summary of the top 10 topics discussed in chat sessions, ordered by conversation count. Results can be filtered by mentor and date range.

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

Returns: Response: A list of the top 10 topics with their conversation counts.

Raises: NotFound: If the specified organization does not exist. BadRequest: If the provided date format is invalid.

Query Parameters: mentor_id (str): Filter by mentor unique ID. start_date (str): Start date for filtering (YYYY-MM-DD). end_date (str): End date for filtering (YYYY-MM-DD).

Security
PlatformApiKeyAuthentication
Path
orgstringrequired
user_idstringrequired
Query
end_datestring(date)
start_datestring(date)
curl -i -X GET \
  'https://docs.ibl.ai/_mock/apis/ibl/api/ai-analytics/orgs/{org}/users/{user_id}/topics/summary/?end_date=2019-08-24&start_date=2019-08-24' \
  -H 'Authorization: YOUR_API_KEY_HERE'

Responses

Bodyapplication/jsonArray [
namestringrequired
conversation_countintegerrequired
]
Response
application/json
[
  [
    { … },
    { … },
    { … }
  ]
]

ai_analytics_orgs_users_total_users_by_mentor_list

Request

Retrieve the total number of users interacting with mentors over time.

This endpoint returns data on the number of unique users who interacted with mentors each day or hour within a specified date range, with optional filtering by specific mentor. If no date range is provided, the last 30 days are used by default.

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

Returns: Response: Time series of unique user counts.

Raises: NotFound: If the specified organization or mentor does not exist. BadRequest: If the provided parameters are invalid.

Query Parameters: start_date (str): Start date for filtering (YYYY-MM-DD) - defaults to 30 days ago. end_date (str): End date for filtering (YYYY-MM-DD) - defaults to today. aggregation (str): Time aggregation level (hourly, daily) - default: daily. mentor_id (str): Filter by mentor unique ID.

Security
PlatformApiKeyAuthentication
Path
orgstringrequired
user_idstringrequired
Query
aggregationstring

Time aggregation level (hourly, daily)

Default "daily"
Enum"daily""hourly"
end_datestring

End date for filtering (YYYY-MM-DD)

group_bystringnon-empty
Default "day"
mentor_idstring

Filter by mentor unique ID

start_datestring

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}/total-users-by-mentor/?aggregation=daily&end_date=string&group_by=day&mentor_id=string&start_date=string' \
  -H 'Authorization: YOUR_API_KEY_HERE'

Responses

Bodyapplication/jsonArray [
periodstring(date-time)required
user_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