Skip to content
API Reference/
/
analytics_orgs_time_updat...

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_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"
}

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": [
    { … }
  ]
}

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