Skip to content
API Reference
/
ai-analytics
/
ai_analytics_orgs_users_chat_history_list

ibl-data-manager (3.59.0-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_analytics_orgs_users_average_messages_per_session_list

Request

Retrieve average message counts per session over time.

This endpoint returns data on the average number of messages exchanged in each conversation session within a specified date range, with options for filtering by mentor and aggregating by different time periods (hourly, daily, weekly).

Args: request: The HTTP request containing filter query parameters. org: Organization key identifier.

Returns: Response: Time series of average message counts and session totals.

Raises: NotFound: If the specified organization does not exist. BadRequest: If the provided parameters are invalid.

Query Parameters: start_date (str): Start date for filtering (YYYY-MM-DD) - required. end_date (str): End date for filtering (YYYY-MM-DD) - required. mentor_id (str): Filter by mentor unique ID. aggregation (str): Time aggregation level (hourly, daily, weekly) - default: daily.

Security
PlatformApiKeyAuthentication
Path
orgstringrequired
user_idstringrequired
Query
aggregationstring

Time aggregation level (hourly, daily, weekly)

Default "daily"
Enum"daily""hourly""weekly"
end_datestringrequired

End date for filtering (YYYY-MM-DD)

group_bystringnon-empty
Default "day"
mentor_idstring

Filter by mentor unique ID

start_datestringrequired

Start date for filtering (YYYY-MM-DD)

curl -i -X GET \
  'https://docs.ibl.ai/_mock/apis/ibl/api/ai-analytics/orgs/{org}/users/{user_id}/average-messages-per-session/?aggregation=daily&end_date=string&group_by=day&mentor_id=string&start_date=string' \
  -H 'Authorization: YOUR_API_KEY_HERE'

Responses

Bodyapplication/jsonArray [
timestring(date-time)required
avg_messagesintegerrequired
total_sessionsintegerrequired
]
Response
application/json
[
  [
    { … },
    { … },
    { … }
  ]
]

ai_analytics_orgs_users_chat_history_list

Request

API viewset for retrieving and filtering chat message history.

This viewset provides endpoints for retrieving chat message history within an organization, with extensive filtering options by date range, user, topic, mentor, and sentiment.

Permissions:

  • Restricted to platform administrators only
Security
PlatformApiKeyAuthentication
Path
orgstringrequired
user_idstringrequired
Query
end_datestring(date)
filter_user_idstringnon-empty
mentorstring(uuid)
pageinteger

A page number within the paginated result set.

page_sizeinteger

Number of results to return per page.

sentimentstringnon-empty
start_datestring(date)
topicsstringnon-empty
curl -i -X GET \
  'https://docs.ibl.ai/_mock/apis/ibl/api/ai-analytics/orgs/{org}/users/{user_id}/chat-history/?end_date=2019-08-24&filter_user_id=string&mentor=497f6eca-6276-4993-bfeb-53cbbbba6f08&page=0&page_size=0&sentiment=string&start_date=2019-08-24&topics=string' \
  -H 'Authorization: YOUR_API_KEY_HERE'

Responses

Bodyapplication/json
countintegerrequired
Example: 123
nextstring or null(uri)
Example: "http://api.example.org/accounts/?page=4"
previousstring or null(uri)
Example: "http://api.example.org/accounts/?page=2"
resultsArray of objects(Conversations)required
results[].​idstring(uuid)read-onlyrequired
results[].​messagesstringread-onlyrequired
results[].​topicsArray of objects(TopicModel)required
results[].​topics[].​namestring<= 255 charactersrequired
results[].​sentimentstringread-onlyrequired
results[].​mentorstring(uuid)required
results[].​studentstringread-onlyrequired
results[].​emailstringread-onlyrequired
results[].​modelstringrequired
results[].​ratingintegerread-onlyrequired
results[].​platformstringrequired
results[].​lti_emailstringread-onlyrequired

Email claim from LTI1.3 JWT if an LTI user and available

results[].​lti_usernamestringread-onlyrequired

Username claim from LTI1.3 JWT if an LTI user and available

results[].​inserted_atstring(date-time)read-onlyrequired
results[].​has_documentboolean
results[].​memory_trackedboolean
results[].​llm_namestring or null<= 255 characters
results[].​llm_providerstring or null<= 255 characters
results[].​metadataany or null
results[].​toolsArray of integers
Response
application/json
{
  "count": 123,
  "next": "http://api.example.org/accounts/?page=4",
  "previous": "http://api.example.org/accounts/?page=2",
  "results": [
    { … }
  ]
}

ai_analytics_orgs_users_chat_history_create

Request

API viewset for retrieving and filtering chat message history.

This viewset provides endpoints for retrieving chat message history within an organization, with extensive filtering options by date range, user, topic, mentor, and sentiment.

Permissions:

  • Restricted to platform administrators only
Security
PlatformApiKeyAuthentication
Path
orgstringrequired
user_idstringrequired
Query
end_datestring(date)
filter_user_idstringnon-empty
mentorstring(uuid)
sentimentstringnon-empty
start_datestring(date)
topicsstringnon-empty
Body
required
topicsArray of objects(TopicModel)required
topics[].​namestring<= 255 charactersrequired
mentorstring(uuid)required
modelstringrequired
platformstringrequired
has_documentboolean
memory_trackedboolean
llm_namestring or null<= 255 characters
llm_providerstring or null<= 255 characters
metadataany or null
toolsArray of integers
curl -i -X POST \
  'https://docs.ibl.ai/_mock/apis/ibl/api/ai-analytics/orgs/{org}/users/{user_id}/chat-history/?end_date=2019-08-24&filter_user_id=string&mentor=497f6eca-6276-4993-bfeb-53cbbbba6f08&sentiment=string&start_date=2019-08-24&topics=string' \
  -H 'Authorization: YOUR_API_KEY_HERE' \
  -H 'Content-Type: application/json' \
  -d '{
    "topics": [
      {
        "name": "string"
      }
    ],
    "mentor": "ecbf8dc6-e97d-4602-939f-cda86082faa0",
    "model": "string",
    "platform": "string",
    "has_document": true,
    "memory_tracked": true,
    "llm_name": "string",
    "llm_provider": "string",
    "metadata": null,
    "tools": [
      0
    ]
  }'

Responses

Bodyapplication/json
idstring(uuid)read-onlyrequired
messagesstringread-onlyrequired
topicsArray of objects(TopicModel)required
topics[].​namestring<= 255 charactersrequired
sentimentstringread-onlyrequired
mentorstring(uuid)required
studentstringread-onlyrequired
emailstringread-onlyrequired
modelstringrequired
ratingintegerread-onlyrequired
platformstringrequired
lti_emailstringread-onlyrequired

Email claim from LTI1.3 JWT if an LTI user and available

lti_usernamestringread-onlyrequired

Username claim from LTI1.3 JWT if an LTI user and available

inserted_atstring(date-time)read-onlyrequired
has_documentboolean
memory_trackedboolean
llm_namestring or null<= 255 characters
llm_providerstring or null<= 255 characters
metadataany or null
toolsArray of integers
Response
application/json
{
  "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
  "messages": "string",
  "topics": [
    { … }
  ],
  "sentiment": "string",
  "mentor": "ecbf8dc6-e97d-4602-939f-cda86082faa0",
  "student": "string",
  "email": "string",
  "model": "string",
  "rating": 0,
  "platform": "string",
  "lti_email": "string",
  "lti_username": "string",
  "inserted_at": "2019-08-24T14:15:22Z",
  "has_document": true,
  "memory_tracked": true,
  "llm_name": "string",
  "llm_provider": "string",
  "metadata": null,
  "tools": [
    0
  ]
}

ai-bot

Operations

ai-finetuning

Operations

ai-index

Operations

ai-marketing

Operations

ai-media

Operations

ai-mentor

Operations

ai-prompt

Operations

career

Operations

catalog

Operations

core

Operations

credentials

Operations

features

Operations

media

Operations

notifications

Operations

scim

Operations

commerce

Operations

recommendations

Operations

reports

Operations

skills

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