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

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_orgs_time_update_create

Request

Update time spent tracking data from client-side events.

This endpoint receives time spent data collected on the client side and stores it in the analytics database. It requires a valid authentication token.

Methods: POST: Submit time spent tracking data

Returns: A response indicating success or failure: { "success": true|false, "message": "Error message if failed" (optional) }

Error Responses: 400 Bad Request: If the request data is invalid or the API is disabled

Notes: This API must be enabled via the ENABLE_TIME_SPENT_UPDATE_API setting.

Security
PlatformApiKeyAuthentication
Path
orgstringrequired
Body
required
timestampstring(date-time)required

Time when the event occurred, ensure it is UTC (ISO 8601 format)

course_idstring

Course ID to track time spent

mentor_uuidstring

Mentor UUID to track time spent

block_idstring

Block ID to track time spent

countintegerrequired

Time spent in seconds

urlstringrequired

Source URL

metadataany

Additional metadata

Default {}
session_uuidstring

Session UUID to track time spent

curl -i -X POST \
  'https://docs.ibl.ai/_mock/apis/ibl/api/analytics/orgs/{org}/time/update/' \
  -H 'Authorization: YOUR_API_KEY_HERE' \
  -H 'Content-Type: application/json' \
  -d '{
    "timestamp": "2019-08-24T14:15:22Z",
    "course_id": "string",
    "mentor_uuid": "string",
    "block_id": "string",
    "count": 0,
    "url": "string",
    "metadata": {},
    "session_uuid": "string"
  }'

Responses

Bodyapplication/json
successboolean
Default true
messageany
Default "Time spent updated successfully"
Response
application/json
{
  "success": true,
  "message": "Time spent updated successfully"
}

ai-bot

Operations

ai-finetuning

Operations

ai-index

Operations

ai-marketing

Operations

ai-media

Operations

ai-mentor

Operations

ai-prompt

Operations

analytics

Operations

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