Skip to content
API Reference/
/
analytics_messages_detail...

ibl-data-manager (4.84.1-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-bot

Operations

ai-finetuning

Operations

ai-index

Operations

ai-marketing

Operations

ai-media

Operations

ai-mentor

Operations

ai-prompt

Operations

analytics

Operations

analytics_messages_retrieve

Request

Conversation list endpoint for analytics.

Query params (all optional unless specified by permissions):

  • platform_key: filter by platform
  • mentor_unique_id: filter by mentor
  • page: page number (default 1)
  • limit: page size (default 20, max 100)
  • search: search in user name and first user message
  • min_messages, max_messages: message_count range
  • sentiment: positive|negative|neutral
  • topic: topic name contains
  • start_date, end_date: date filter on conversation date

Returns: summary totals, results list (paginated), and pagination metadata.

Security
PlatformApiKeyAuthentication
Query
end_datestring(date)
limitinteger[ 1 .. 100 ]
Default 20
max_messagesinteger>= 0
mentor_unique_idstring(uuid)
min_messagesinteger>= 0
pageinteger>= 1
Default 1
platform_keystringnon-empty
searchstring
sentimentstringnon-empty
  • positive - positive
  • negative - negative
  • neutral - neutral
Enum"positive""negative""neutral"
start_datestring(date)
topicstringnon-empty
curl -i -X GET \
  'https://docs.ibl.ai/_mock/apis/ibl/api/analytics/messages/?end_date=2019-08-24&limit=20&max_messages=0&mentor_unique_id=497f6eca-6276-4993-bfeb-53cbbbba6f08&min_messages=0&page=1&platform_key=string&search=string&sentiment=positive&start_date=2019-08-24&topic=string' \
  -H 'Authorization: YOUR_API_KEY_HERE'

Responses

Bodyapplication/json
summaryobjectrequired
summary.​property name*anyadditional property
resultsArray of objects(ConversationListItem)required
results[].​platform_namestringrequired
results[].​platform_keystringrequired
results[].​mentorstringrequired
results[].​mentor_unique_idstringrequired
results[].​modelstringrequired
results[].​coststringread-onlyrequired
results[].​usernamestring or null<= 255 characters
results[].​namestring<= 255 charactersrequired
results[].​first_user_messagestring or null
results[].​topicsanyrequired
results[].​message_countinteger[ -2147483648 .. 2147483647 ]required
results[].​user_queriesinteger or null[ -2147483648 .. 2147483647 ]
results[].​assistant_responsesinteger or null[ -2147483648 .. 2147483647 ]
results[].​average_sentimentnumber or null(double)
results[].​sentimentstring or null<= 16 characters
results[].​created_atstring(date-time)required
results[].​platformintegerrequired
results[].​sessionstring(uuid)required
results[].​userinteger or null[ 0 .. 2147483647 ]

edX user ID

paginationobjectrequired
pagination.​property name*anyadditional property
Response
application/json
{
  "summary": {
    "property1": null,
    "property2": null
  },
  "results": [
    { … }
  ],
  "pagination": {
    "property1": null,
    "property2": null
  }
}

analytics_messages_details_retrieve

Request

Conversation detail endpoint for analytics.

Query params:

  • session_id (required): UUID of the session to fetch
  • platform_key, mentor_unique_id (optional): further scope
  • start_date, end_date (optional): date filter on message timestamps

Returns: summary metadata from conversation_list MV, and a list of human/ai message pairs in chronological order.

Security
PlatformApiKeyAuthentication
Query
end_datestring(date)
mentor_unique_idstring(uuid)
platform_keystringnon-empty
session_idstringnon-emptyrequired
start_datestring(date)
curl -i -X GET \
  'https://docs.ibl.ai/_mock/apis/ibl/api/analytics/messages/details/?end_date=2019-08-24&mentor_unique_id=497f6eca-6276-4993-bfeb-53cbbbba6f08&platform_key=string&session_id=string&start_date=2019-08-24' \
  -H 'Authorization: YOUR_API_KEY_HERE'

Responses

Bodyapplication/json
summaryobjectrequired
summary.​property name*anyadditional property
messagesArray of objectsrequired
messages[].​property name*anyadditional property
Response
application/json
{
  "summary": {
    "property1": null,
    "property2": null
  },
  "messages": [
    { … }
  ]
}

analytics_ratings_retrieve

Request

Ratings overtime endpoint.

Query params:

  • metric: only 'ratings' is supported (default)
  • platform_key, mentor_unique_id: optional filters
  • granularity: 'day' (default) or 'hour' (hour only for today)
  • start_date, end_date: optional date range; defaults applied if not provided

Returns: { metric: 'ratings', points: [{date, value}, ...] }

Security
PlatformApiKeyAuthentication
Query
date_filterstringnon-empty
  • today - Today only
  • 7d - Last 7 days
  • 30d - Last 30 days
  • 90d - Last 90 days
  • all_time - All time
  • custom - Custom date range
Default "today"
Enum"today""7d""30d""90d""all_time""custom"
end_datestring(date)
granularitystringnon-empty
  • day - day
  • hour - hour
  • week - week
  • month - month
Default "hour"
Enum"day""hour""week""month"
mentor_unique_idstring(uuid)
metricstringnon-empty
  • ratings - Ratings over time
Default "ratings"
Value"ratings"
platform_keystringnon-empty
start_datestring(date)
curl -i -X GET \
  'https://docs.ibl.ai/_mock/apis/ibl/api/analytics/ratings/?date_filter=today&end_date=2019-08-24&granularity=day&mentor_unique_id=497f6eca-6276-4993-bfeb-53cbbbba6f08&metric=ratings&platform_key=string&start_date=2019-08-24' \
  -H 'Authorization: YOUR_API_KEY_HERE'

Responses

Bodyapplication/json
metricstringrequired
pointsArray of objects(RatingAverageRecord)required
points[].​datestringrequired
points[].​valuenumber(double)required

Average rating value for this time period

Response
application/json
{
  "metric": "string",
  "points": [
    { … }
  ]
}

career

Operations

catalog

Operations

core

Operations

credentials

Operations

custom-domains

Operations

features

Operations

media

Operations

notifications

Operations

scim

Operations

commerce

Operations

recommendations

Operations

reports

Operations

skills

Operations
Copyright © ibl.ai | support@iblai.zendesk.com