Skip to content
API Reference/
/
analytics_sessions_retrie...

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

analytics_sessions_retrieve

Request

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
  • sessions - Sessions over time
  • headline - Headline metrics for sessions (avg messages per session, avg rating)
Default "sessions"
Enum"sessions""headline"
platform_keystringnon-empty
start_datestring(date)
curl -i -X GET \
  'https://docs.ibl.ai/_mock/apis/ibl/api/analytics/sessions/?date_filter=today&end_date=2019-08-24&granularity=day&mentor_unique_id=497f6eca-6276-4993-bfeb-53cbbbba6f08&metric=sessions&platform_key=string&start_date=2019-08-24' \
  -H 'Authorization: YOUR_API_KEY_HERE'

Responses

Bodyapplication/json
metricstringrequired
pointsArray of objects(SessionChartPoint)required
points[].​datestring(date-time)required
points[].​valueintegerrequired
Response
application/json
{
  "metric": "string",
  "points": [
    { … }
  ]
}

analytics_sessions_details_retrieve

Request

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)
limitinteger[ 1 .. 100 ]
Default 20
mentor_unique_idstring(uuid)
pageinteger>= 1
Default 1
platform_keystringnon-empty
searchstring

Search by topic name

start_datestring(date)
curl -i -X GET \
  'https://docs.ibl.ai/_mock/apis/ibl/api/analytics/sessions/details/?date_filter=today&end_date=2019-08-24&limit=20&mentor_unique_id=497f6eca-6276-4993-bfeb-53cbbbba6f08&page=1&platform_key=string&search=string&start_date=2019-08-24' \
  -H 'Authorization: YOUR_API_KEY_HERE'

Responses

Bodyapplication/json
resultsArray of objects(TopicDetail)required
results[].​namestringrequired
results[].​messagesintegerrequired
results[].​conversationsintegerrequired
results[].​sessionsintegerrequired
results[].​average_ratingstring
results[].​rating_countinteger
paginationobjectrequired
pagination.​property name*anyadditional property
Response
application/json
{
  "results": [
    { … }
  ],
  "pagination": {
    "property1": null,
    "property2": null
  }
}

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