Skip to content
API Reference/
/
analytics_time_retrieve

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

analytics_time_retrieve

Request

Time Analytics API - User activity patterns by time of day and day of week.

Provides heatmap data showing when users are most active, useful for:

  • Understanding peak usage times
  • Capacity planning and resource allocation
  • User behavior analysis
  • Support scheduling optimization

Key Features:

  • Day of week patterns (0=Sunday through 6=Saturday)
  • Hour of day activity levels (0-23)
  • Flexible date range filtering
  • Platform and mentor-specific filtering
  • Message count aggregation

Data Structure:

  • day_of_week: 0-6 (Sunday-Saturday)
  • hour: 0-23 (24-hour format)
  • value: Message count for that time slot
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)
platform_keystringnon-empty
start_datestring(date)
curl -i -X GET \
  'https://docs.ibl.ai/_mock/apis/ibl/api/analytics/time/?date_filter=today&end_date=2019-08-24&granularity=day&mentor_unique_id=497f6eca-6276-4993-bfeb-53cbbbba6f08&platform_key=string&start_date=2019-08-24' \
  -H 'Authorization: YOUR_API_KEY_HERE'

Responses

Access times heatmap data with day/hour patterns

Bodyapplication/json
day_of_weekintegerrequired
hourintegerrequired
valueintegerrequired
Response
application/json

Hourly activity patterns by day of week (0=Sunday, 1=Monday, etc.)

{
  "metric": "access_times",
  "data": [
    { … },
    { … },
    { … },
    { … },
    { … }
  ]
}

analytics_topics_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
  • overview - Overall topic metrics
  • sessions - Sessions over time
  • ratings - Ratings over time
  • highlighted - Highlighted topics
Default "overview"
Enum"overview""sessions""ratings""highlighted"
platform_keystringnon-empty
start_datestring(date)
curl -i -X GET \
  'https://docs.ibl.ai/_mock/apis/ibl/api/analytics/topics/?date_filter=today&end_date=2019-08-24&granularity=day&mentor_unique_id=497f6eca-6276-4993-bfeb-53cbbbba6f08&metric=overview&platform_key=string&start_date=2019-08-24' \
  -H 'Authorization: YOUR_API_KEY_HERE'

Responses

Bodyapplication/json
topicsobjectrequired
topics.​all_time_totalintegerrequired

Total count since the beginning of time

topics.​this_monthintegerrequired

Count for current month

topics.​last_monthintegerrequired

Count for previous month

topics.​percentage_changenumber(double)required

Percentage change from last month to this month

sessionsobjectrequired
sessions.​all_time_totalintegerrequired

Total count since the beginning of time

sessions.​this_monthintegerrequired

Count for current month

sessions.​last_monthintegerrequired

Count for previous month

sessions.​percentage_changenumber(double)required

Percentage change from last month to this month

conversationsobjectrequired
conversations.​all_time_totalintegerrequired

Total count since the beginning of time

conversations.​this_monthintegerrequired

Count for current month

conversations.​last_monthintegerrequired

Count for previous month

conversations.​percentage_changenumber(double)required

Percentage change from last month to this month

messagesobjectrequired
messages.​all_time_totalintegerrequired

Total count since the beginning of time

messages.​this_monthintegerrequired

Count for current month

messages.​last_monthintegerrequired

Count for previous month

messages.​percentage_changenumber(double)required

Percentage change from last month to this month

Response
application/json
{
  "topics": {
    "all_time_total": 0,
    "this_month": 0,
    "last_month": 0,
    "percentage_change": 0.1
  },
  "sessions": {
    "all_time_total": 0,
    "this_month": 0,
    "last_month": 0,
    "percentage_change": 0.1
  },
  "conversations": {
    "all_time_total": 0,
    "this_month": 0,
    "last_month": 0,
    "percentage_change": 0.1
  },
  "messages": {
    "all_time_total": 0,
    "this_month": 0,
    "last_month": 0,
    "percentage_change": 0.1
  }
}

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