Dashboard
The Dashboard API handles large data for the purpose of customer usage analytics.
The Dashboard API is made to retrieve data in a format proper to either supply an excel file or plot a graph. Every one of them follow similar request rules.
All Date formats are standard ISO Datetime:
yyyy-MM-dd'T'hh:mm:ss.SSS'Z'Auxiliary Methods
Acquires the dashboards' configurations and availability summary. Should be called on dashboard opening.
A valid uuid of an organization
A valid uuid of an environment
The UUID of the bot whose entities you are searching
GET /org/{orgUUID}/env/{envUUID}/bot/{botUUID}/dashboard/summary HTTP/1.1
Host:
Accept: */*
{
"hasData": true,
"firstDataSet": "2025-07-13T06:38:36.388Z"
}Acquires the configurations and rules to present in the request report prompts for conversations.
A valid uuid of an organization
A valid uuid of an environment
The UUID of the bot whose conversations you are searching
GET /org/{orgUUID}/env/{envUUID}/bot/{botUUID}/conversations/report_configurations HTTP/1.1
Host:
Accept: */*
{
"maxSample": 1,
"availableExportTypes": [
"text"
]
}Acquires the configurations and rules to present in the request report prompts for conversations.
A valid uuid of an organization
A valid uuid of an environment
The UUID of the bot whose conversations you are searching
GET /org/{orgUUID}/env/{envUUID}/bot/{botUUID}/messages/report_configurations HTTP/1.1
Host:
Accept: */*
{
"maxSample": 1,
"availableExportTypes": [
"text"
]
}Data Analytics
Fetches information regarding Conversations traffic, regarding a given period of time. This information is used to build both conversation boxes in the dashboard.
A valid uuid of an organization
A valid uuid of an environment
The UUID of the bot whose entities you are searching
Parameters used to filter the data of user conversations and messages.
Starting date for the search (inclusive). Must conform to ISO format.
End date for the search (inclusive). Must conform to ISO format.
Starting hour of the search interval. 0 if unfiltered.
Ending hour of the search interval. 23 if unfiltered.
Represents the timezone or offset to be applied. Can be specified either as a timezone identifier (like 'UTC', 'America/Los_Angeles', etc.) or as an offset (like '+03:00', '-05:00', etc.). The timezone will be applied to time-related queries and operations.
UTCALL channelUuids to filter. If empty, all are used instead.
ALL tags name to filter. If empty, no tag filter will be applied.
POST /org/{orgUUID}/env/{envUUID}/bot/{botUUID}/dashboard/conversations HTTP/1.1
Host:
Content-Type: application/json
Accept: */*
Content-Length: 256
{
"startDate": "2025-07-13T06:38:36.388Z",
"endDate": "2025-07-13T06:38:36.388Z",
"startHour": 1,
"endHour": 1,
"timezone": "UTC",
"channelUUIDs": [
"text"
],
"tagsName": [
"text"
],
"previousStartDate": "2025-07-13T06:38:36.388Z",
"previousEndDate": "2025-07-13T06:38:36.388Z"
}{
"resource": "ANALYTIC_CONVERSATION",
"periodOverview": {
"totalAmount": 1,
"hasRelativeData": true,
"relativeIncrease": 1,
"hasIncreased": true,
"relativeStartDate": "2025-07-13T06:38:36.388Z",
"relativeEndDate": "2025-07-13T06:38:36.388Z"
},
"channelAnalytics": [
{
"channelType": "text",
"channelName": "text",
"hours": [
{
"date": "2025-07-13T06:38:36.388Z",
"value": 1
}
],
"days": [
{
"date": "2025-07-13T06:38:36.388Z",
"value": 1
}
],
"weeks": [
{
"monthDate": "2025-07-13T06:38:36.388Z",
"weekNumber": 1,
"value": 1
}
],
"months": [
{
"date": "2025-07-13T06:38:36.388Z",
"value": 1
}
]
}
]
}Fetches information regarding messages traffic, regarding a given period of time. This information is used to build both conversation boxes in the dashboard.
A valid uuid of an organization
A valid uuid of an environment
The UUID of the bot whose entities you are searching
Parameters used to filter the data of user conversations and messages.
Starting date for the search (inclusive). Must conform to ISO format.
End date for the search (inclusive). Must conform to ISO format.
Starting hour of the search interval. 0 if unfiltered.
Ending hour of the search interval. 23 if unfiltered.
Represents the timezone or offset to be applied. Can be specified either as a timezone identifier (like 'UTC', 'America/Los_Angeles', etc.) or as an offset (like '+03:00', '-05:00', etc.). The timezone will be applied to time-related queries and operations.
UTCALL channelUuids to filter. If empty, all are used instead.
ALL tags name to filter. If empty, no tag filter will be applied.
POST /org/{orgUUID}/env/{envUUID}/bot/{botUUID}/dashboard/messages HTTP/1.1
Host:
Content-Type: application/json
Accept: */*
Content-Length: 256
{
"startDate": "2025-07-13T06:38:36.388Z",
"endDate": "2025-07-13T06:38:36.388Z",
"startHour": 1,
"endHour": 1,
"timezone": "UTC",
"channelUUIDs": [
"text"
],
"tagsName": [
"text"
],
"previousStartDate": "2025-07-13T06:38:36.388Z",
"previousEndDate": "2025-07-13T06:38:36.388Z"
}{
"resource": "ANALYTIC_CONVERSATION",
"periodOverview": {
"totalAmount": 1,
"hasRelativeData": true,
"relativeIncrease": 1,
"hasIncreased": true,
"relativeStartDate": "2025-07-13T06:38:36.388Z",
"relativeEndDate": "2025-07-13T06:38:36.388Z"
},
"trafficAnalyticsDTO": {
"hours": [
{
"date": "2025-07-13T06:38:36.388Z",
"value": 1
}
],
"days": [
{
"date": "2025-07-13T06:38:36.388Z",
"value": 1
}
],
"weeks": [
{
"monthDate": "2025-07-13T06:38:36.388Z",
"weekNumber": 1,
"value": 1
}
],
"months": [
{
"date": "2025-07-13T06:38:36.388Z",
"value": 1
}
],
"averageHoursValue": 1,
"averageDaysValue": 1,
"averageWeeksValue": 1,
"averageMonthsValue": 1
}
}Fetches information regarding users traffic, regarding a given period of time. This information is used to build both conversation boxes in the dashboard.
A valid uuid of an organization
A valid uuid of an environment
The UUID of the bot whose entities you are searching
Parameters used to filter the data of user conversations and messages.
Starting date for the search (inclusive). Must conform to ISO format.
End date for the search (inclusive). Must conform to ISO format.
Starting hour of the search interval. 0 if unfiltered.
Ending hour of the search interval. 23 if unfiltered.
Represents the timezone or offset to be applied. Can be specified either as a timezone identifier (like 'UTC', 'America/Los_Angeles', etc.) or as an offset (like '+03:00', '-05:00', etc.). The timezone will be applied to time-related queries and operations.
UTCALL channelUuids to filter. If empty, all are used instead.
ALL tags name to filter. If empty, no tag filter will be applied.
POST /org/{orgUUID}/env/{envUUID}/bot/{botUUID}/dashboard/users HTTP/1.1
Host:
Content-Type: application/json
Accept: */*
Content-Length: 256
{
"startDate": "2025-07-13T06:38:36.388Z",
"endDate": "2025-07-13T06:38:36.388Z",
"startHour": 1,
"endHour": 1,
"timezone": "UTC",
"channelUUIDs": [
"text"
],
"tagsName": [
"text"
],
"previousStartDate": "2025-07-13T06:38:36.388Z",
"previousEndDate": "2025-07-13T06:38:36.388Z"
}{
"resource": "ANALYTIC_CONVERSATION",
"periodOverview": {
"totalAmount": 1,
"hasRelativeData": true,
"relativeIncrease": 1,
"hasIncreased": true,
"relativeStartDate": "2025-07-13T06:38:36.388Z",
"relativeEndDate": "2025-07-13T06:38:36.388Z"
},
"trafficAnalyticsDTO": {
"hours": [
{
"date": "2025-07-13T06:38:36.388Z",
"value": 1
}
],
"days": [
{
"date": "2025-07-13T06:38:36.388Z",
"value": 1
}
],
"weeks": [
{
"monthDate": "2025-07-13T06:38:36.388Z",
"weekNumber": 1,
"value": 1
}
],
"months": [
{
"date": "2025-07-13T06:38:36.388Z",
"value": 1
}
],
"averageHoursValue": 1,
"averageDaysValue": 1,
"averageWeeksValue": 1,
"averageMonthsValue": 1
}
}Acquires the accuracy for analytics into this bot, considering the range of dates and specified channels.
A valid uuid of an organization
A valid uuid of an environment
The UUID of the bot whose entities you are searching
Parameters used to filter the data of user conversations and messages.
Starting date for the search (inclusive). Must conform to ISO format.
End date for the search (inclusive). Must conform to ISO format.
Starting hour of the search interval. 0 if unfiltered.
Ending hour of the search interval. 23 if unfiltered.
Represents the timezone or offset to be applied. Can be specified either as a timezone identifier (like 'UTC', 'America/Los_Angeles', etc.) or as an offset (like '+03:00', '-05:00', etc.). The timezone will be applied to time-related queries and operations.
UTCALL channelUuids to filter. If empty, all are used instead.
ALL tags name to filter. If empty, no tag filter will be applied.
POST /org/{orgUUID}/env/{envUUID}/bot/{botUUID}/dashboard/accuracy HTTP/1.1
Host:
Content-Type: application/json
Accept: */*
Content-Length: 256
{
"startDate": "2025-07-13T06:38:36.388Z",
"endDate": "2025-07-13T06:38:36.388Z",
"startHour": 1,
"endHour": 1,
"timezone": "UTC",
"channelUUIDs": [
"text"
],
"tagsName": [
"text"
],
"previousStartDate": "2025-07-13T06:38:36.388Z",
"previousEndDate": "2025-07-13T06:38:36.388Z"
}{
"rateCurrent": 1,
"ratePrevious": 1,
"hasIncreased": true,
"relativeIncrease": 1,
"relativeStartDate": "2025-07-13T06:38:36.388Z",
"relativeEndDate": "2025-07-13T06:38:36.388Z"
}A valid uuid of an organization
A valid uuid of an environment
The UUID of the bot whose entities you are searching
Parameters used to filter the data of user conversations and messages.
Starting date for the search (inclusive). Must conform to ISO format.
End date for the search (inclusive). Must conform to ISO format.
Starting hour of the search interval. 0 if unfiltered.
Ending hour of the search interval. 23 if unfiltered.
Represents the timezone or offset to be applied. Can be specified either as a timezone identifier (like 'UTC', 'America/Los_Angeles', etc.) or as an offset (like '+03:00', '-05:00', etc.). The timezone will be applied to time-related queries and operations.
UTCALL channelUuids to filter. If empty, all are used instead.
ALL tags name to filter. If empty, no tag filter will be applied.
POST /org/{orgUUID}/env/{envUUID}/bot/{botUUID}/dashboard/stacking/intents HTTP/1.1
Host:
Content-Type: application/json
Accept: */*
Content-Length: 256
{
"startDate": "2025-07-13T06:38:36.388Z",
"endDate": "2025-07-13T06:38:36.388Z",
"startHour": 1,
"endHour": 1,
"timezone": "UTC",
"channelUUIDs": [
"text"
],
"tagsName": [
"text"
],
"previousStartDate": "2025-07-13T06:38:36.388Z",
"previousEndDate": "2025-07-13T06:38:36.388Z"
}{
"resource": "ANALYTIC_INTENTS",
"channelList": [
{
"name": "text",
"topicBreakdown": [
{
"name": "text",
"channelValue": 1,
"totalValue": 1
}
]
}
]
}A valid uuid of an organization
A valid uuid of an environment
The UUID of the bot whose entities you are searching
Parameters used to filter the data of user conversations and messages.
Starting date for the search (inclusive). Must conform to ISO format.
End date for the search (inclusive). Must conform to ISO format.
Starting hour of the search interval. 0 if unfiltered.
Ending hour of the search interval. 23 if unfiltered.
Represents the timezone or offset to be applied. Can be specified either as a timezone identifier (like 'UTC', 'America/Los_Angeles', etc.) or as an offset (like '+03:00', '-05:00', etc.). The timezone will be applied to time-related queries and operations.
UTCALL channelUuids to filter. If empty, all are used instead.
ALL tags name to filter. If empty, no tag filter will be applied.
POST /org/{orgUUID}/env/{envUUID}/bot/{botUUID}/dashboard/stacking/flows HTTP/1.1
Host:
Content-Type: application/json
Accept: */*
Content-Length: 256
{
"startDate": "2025-07-13T06:38:36.388Z",
"endDate": "2025-07-13T06:38:36.388Z",
"startHour": 1,
"endHour": 1,
"timezone": "UTC",
"channelUUIDs": [
"text"
],
"tagsName": [
"text"
],
"previousStartDate": "2025-07-13T06:38:36.388Z",
"previousEndDate": "2025-07-13T06:38:36.388Z"
}{
"resource": "ANALYTIC_INTENTS",
"channelList": [
{
"name": "text",
"topicBreakdown": [
{
"name": "text",
"channelValue": 1,
"totalValue": 1
}
]
}
]
}A valid uuid of an organization
A valid uuid of an environment
The UUID of the bot whose entities you are searching
Parameters used to filter the data of user conversations and messages.
Starting date for the search (inclusive). Must conform to ISO format.
End date for the search (inclusive). Must conform to ISO format.
Starting hour of the search interval. 0 if unfiltered.
Ending hour of the search interval. 23 if unfiltered.
Represents the timezone or offset to be applied. Can be specified either as a timezone identifier (like 'UTC', 'America/Los_Angeles', etc.) or as an offset (like '+03:00', '-05:00', etc.). The timezone will be applied to time-related queries and operations.
UTCALL channelUuids to filter. If empty, all are used instead.
ALL tags name to filter. If empty, no tag filter will be applied.
POST /org/{orgUUID}/env/{envUUID}/bot/{botUUID}/dashboard/stacking/abandonments HTTP/1.1
Host:
Content-Type: application/json
Accept: */*
Content-Length: 256
{
"startDate": "2025-07-13T06:38:36.388Z",
"endDate": "2025-07-13T06:38:36.388Z",
"startHour": 1,
"endHour": 1,
"timezone": "UTC",
"channelUUIDs": [
"text"
],
"tagsName": [
"text"
],
"previousStartDate": "2025-07-13T06:38:36.388Z",
"previousEndDate": "2025-07-13T06:38:36.388Z"
}{
"resource": "ANALYTIC_INTENTS",
"channelList": [
{
"name": "text",
"topicBreakdown": [
{
"name": "text",
"channelValue": 1,
"totalValue": 1
}
]
}
]
}Conversations
Searches and paginates through conversations started by our users, according to the current filters.
A valid uuid of an organization.
A valid uuid of an environment.
The UUID of the bot whose conversations you are searching.
Parameters used to filter the data of user conversations and messages.
Starting date for the search (inclusive). Must conform to ISO format.
End date for the search (inclusive). Must conform to ISO format.
Starting hour of the search interval. 0 if unfiltered.
Ending hour of the search interval. 23 if unfiltered.
Represents the timezone or offset to be applied. Can be specified either as a timezone identifier (like 'UTC', 'America/Los_Angeles', etc.) or as an offset (like '+03:00', '-05:00', etc.). The timezone will be applied to time-related queries and operations.
UTCALL channelUuids to filter. If empty, all are used instead.
ALL tags name to filter. If empty, no tag filter will be applied.
Type of search filter being applied on this query. Possible fields are: [SESSION_CODE, BUSINESS_KEY, FLOW]
Term being searched according to the searchBy filter.
Current page, starting at 1
Size of the page
Criteria to order result, defaulted to conversationStartedAt. Possible fields include satisfaction, userMessages, flowsTravelled, conversationStartedAt and duration.
Order direction(ASC/DESC), defaulted to DESC
Used for when we want to filter user messages or conversations that have not been through tags.
POST /org/{orgUUID}/env/{envUUID}/bot/{botUUID}/conversations/list HTTP/1.1
Host:
Content-Type: application/json
Accept: */*
Content-Length: 387
{
"startDate": "2025-07-13T06:38:36.388Z",
"endDate": "2025-07-13T06:38:36.388Z",
"startHour": 1,
"endHour": 1,
"timezone": "UTC",
"channelUUIDs": [
"text"
],
"tagsName": [
"text"
],
"searchBy": "text",
"searchTerm": "text",
"page": 1,
"size": 1,
"orderBy": "text",
"direction": "text",
"funnelTags": [
[
"text"
]
],
"nonTags": true,
"previousStartDate": "2025-07-13T06:38:36.388Z",
"previousEndDate": "2025-07-13T06:38:36.388Z"
}{
"totalPages": 1,
"totalElements": 1,
"pageable": {
"unpaged": true,
"paged": true,
"pageNumber": 1,
"pageSize": 1,
"offset": 1,
"sort": {
"unsorted": true,
"sorted": true,
"empty": true
}
},
"numberOfElements": 1,
"size": 1,
"content": [
{
"sessionCode": "text",
"businessKey": "text",
"userMessage": "text",
"satisfaction": 1,
"userMessages": 1,
"flowsTravelled": 1,
"flowsTravelledNames": [
"text"
],
"conversationStartedAt": "text",
"durationInSeconds": 1,
"channel": {
"uuid": "text",
"botUuid": "text",
"name": "text",
"description": "text",
"channelType": {
"id": 1,
"name": "text",
"imageName": "text",
"channelClassification": {
"id": 1,
"name": "text"
}
}
},
"tags": [
{
"uuid": "text",
"name": "text"
}
]
}
],
"number": 1,
"sort": {
"unsorted": true,
"sorted": true,
"empty": true
},
"first": true,
"last": true,
"empty": true
}A valid uuid of an organization
A valid uuid of an environment
The UUID of the bot whose conversations you are searching
Body containing the properties to use in this report
Starting date for the search (inclusive). Must conform to ISO format.
End date for the search (inclusive). Must conform to ISO format.
Starting hour of the search interval. 0 if unfiltered.
Ending hour of the search interval. 23 if unfiltered.
Represents the timezone or offset to be applied. Can be specified either as a timezone identifier (like 'UTC', 'America/Los_Angeles', etc.) or as an offset (like '+03:00', '-05:00', etc.). The timezone will be applied to time-related queries and operations.
UTCA list of all channelUuids in the report, comma separated.
A list of all tagsName in the report, comma separated.
Capping ammount of items to be used in the report.
The report sorting type
Optional filter field name being queried at the page currently.
Optional filter field value being queried at the page currently.
POST /org/{orgUUID}/env/{envUUID}/bot/{botUUID}/conversations/request_report HTTP/1.1
Host:
Content-Type: application/json
Accept: */*
Content-Length: 358
{
"startDate": "2025-07-13T06:38:36.388Z",
"endDate": "2025-07-13T06:38:36.388Z",
"startHour": 1,
"endHour": 1,
"timezone": "UTC",
"channelUuids": [
"text"
],
"tagsName": [
"text"
],
"sampleSize": 1,
"reportType": "RANDOM",
"filterField": "text",
"filterTerm": "text",
"funnelTags": [
[
"text"
]
],
"previousStartDate": "2025-07-13T06:38:36.388Z",
"previousEndDate": "2025-07-13T06:38:36.388Z"
}No content
Requests the creation of a report in the Reports section, with the full content of a conversation.
A valid uuid of an organization
A valid uuid of an environment
The UUID of the bot whose conversations you are searching
Session Code of the conversation
GET /org/{orgUUID}/env/{envUUID}/bot/{botUUID}/conversations/details?sessionCode=text HTTP/1.1
Host:
Accept: */*
{
"sessionCode": "text",
"startedAt": "text",
"channel": {
"uuid": "text",
"botUuid": "text",
"name": "text",
"description": "text",
"channelType": {
"id": 1,
"name": "text",
"imageName": "text",
"channelClassification": {
"id": 1,
"name": "text"
}
}
},
"messages": [
{
"messageId": "text",
"content": "text",
"isNe": true,
"intent": "text",
"type": "CAROUSEL",
"buttons": [
{
"name": "text",
"value": "text",
"action": "text"
}
],
"entities": [
"text"
],
"nlpResponses": [
{
"responseType": "INTENT",
"paragraphNumber": 1,
"responseName": "text"
}
],
"hasButton": true,
"createdAt": "text"
}
]
}Requests the creation of a report in the Reports section, with the full content of a conversation.
A valid uuid of an organization
A valid uuid of an environment
The UUID of the bot whose conversations you are searching
Session Code of the conversation
Represents the timezone or offset to be applied. Can be specified either as a timezone identifier (like 'UTC', 'America/Los_Angeles', etc.) or as an offset (like '+03:00', '-05:00', etc.). The timezone will be applied to time-related queries and operations.
UTCPOST /org/{orgUUID}/env/{envUUID}/bot/{botUUID}/conversations/details/request_report?sessionCode=text HTTP/1.1
Host:
Accept: */*
No content
Previews the available report sample size, returning the estimate ammount of items that will be present in a report.
A valid uuid of an organization
A valid uuid of an environment
The UUID of the bot whose conversations you are searching
Body containing the properties to use in this report
Starting date of the report range, including itself, in ISO-8601 format (yyyy-MM-dd'T'HH:mm:ss.SSS'Z')
Ending date of the report range, including itself, in ISO-8601 format (yyyy-MM-dd'T'HH:mm:ss.SSS'Z')
Starting hour of the report range, from 0 to 23. Hour sent is included in the report.
Ending hour of the report range, from 0 to 23. Hour sent is included in the report.
A list of all channelUuids in the report, comma separated.
Capping ammount of items to be used in the report.
Minimal confidence level in the report results, simulating response to a configuration in the parameters screen.
An error margin into the confidence level, allowing for variance.
Optional filter field name being queried at the page currently.
Optional filter field value being queried at the page currently.
POST /org/{orgUUID}/env/{envUUID}/bot/{botUUID}/conversations/request_sample HTTP/1.1
Host:
Content-Type: application/json
Accept: */*
Content-Length: 217
{
"startDate": "2025-07-13T06:38:36.388Z",
"endDate": "2025-07-13T06:38:36.388Z",
"startHour": 1,
"endHour": 1,
"channelUuids": "text",
"sampleSize": 1,
"confidenceLevel": 1,
"errorMargin": 1,
"filterField": "text",
"filterTerm": "text"
}{
"sampleSize": 1
}Messages
A valid uuid of an organization.
A valid uuid of an environment.
The UUID of the bot whose messages you are searching.
Parameters used to filter the data of user conversations and messages.
Starting date for the search (inclusive). Must conform to ISO format.
End date for the search (inclusive). Must conform to ISO format.
Starting hour of the search interval. 0 if unfiltered.
Ending hour of the search interval. 23 if unfiltered.
Represents the timezone or offset to be applied. Can be specified either as a timezone identifier (like 'UTC', 'America/Los_Angeles', etc.) or as an offset (like '+03:00', '-05:00', etc.). The timezone will be applied to time-related queries and operations.
UTCALL channelUuids to filter. If empty, all are used instead.
ALL tags name to filter. If empty, no tag filter will be applied.
Type of search filter being applied on this query. Possible fields are: [SESSION_CODE, BUSINESS_KEY, FLOW]
Term being searched according to the searchBy filter.
Current page, starting at 1
Size of the page
Criteria to order result, defaulted to conversationStartedAt. Possible fields include satisfaction, userMessages, flowsTravelled, conversationStartedAt and duration.
Order direction(ASC/DESC), defaulted to DESC
Used for when we want to filter user messages or conversations that have not been through tags.
A comma-separated String containing ALL nlpResponseFilters to filter. Those may be one of: [FOUND, NONE, ALL].
POST /org/{orgUUID}/env/{envUUID}/bot/{botUUID}/messages/list HTTP/1.1
Host:
Content-Type: application/json
Accept: */*
Content-Length: 409
{
"startDate": "2025-07-13T06:38:36.388Z",
"endDate": "2025-07-13T06:38:36.388Z",
"startHour": 1,
"endHour": 1,
"timezone": "UTC",
"channelUUIDs": [
"text"
],
"tagsName": [
"text"
],
"searchBy": "text",
"searchTerm": "text",
"page": 1,
"size": 1,
"orderBy": "text",
"direction": "text",
"funnelTags": [
[
"text"
]
],
"nonTags": true,
"nlpResponses": "text",
"previousStartDate": "2025-07-13T06:38:36.388Z",
"previousEndDate": "2025-07-13T06:38:36.388Z"
}{
"totalPages": 1,
"totalElements": 1,
"pageable": {
"unpaged": true,
"paged": true,
"pageNumber": 1,
"pageSize": 1,
"offset": 1,
"sort": {
"unsorted": true,
"sorted": true,
"empty": true
}
},
"numberOfElements": 1,
"size": 1,
"content": [
{
"messageId": "text",
"messageText": "text",
"sessionCode": "text",
"businessKey": "text",
"minimumConfidenceAchieved": true,
"confidence": 1,
"nlpResponses": [
{
"responseType": "INTENT",
"paragraphNumber": 1,
"responseName": "text"
}
],
"answerNames": [
"text"
],
"answerTexts": [
"text"
],
"answerButtons": [
[
"text"
]
],
"deliveredAt": "text",
"channel": {
"uuid": "text",
"botUuid": "text",
"name": "text",
"description": "text",
"channelType": {
"id": 1,
"name": "text",
"imageName": "text",
"channelClassification": {
"id": 1,
"name": "text"
}
}
},
"tags": [
{
"uuid": "text",
"name": "text"
}
]
}
],
"number": 1,
"sort": {
"unsorted": true,
"sorted": true,
"empty": true
},
"first": true,
"last": true,
"empty": true
}A valid uuid of an organization
A valid uuid of an environment
The UUID of the bot whose conversations you are searching
Body containing the properties to use in this report
Starting date for the search (inclusive). Must conform to ISO format.
End date for the search (inclusive). Must conform to ISO format.
Starting hour of the search interval. 0 if unfiltered.
Ending hour of the search interval. 23 if unfiltered.
Represents the timezone or offset to be applied. Can be specified either as a timezone identifier (like 'UTC', 'America/Los_Angeles', etc.) or as an offset (like '+03:00', '-05:00', etc.). The timezone will be applied to time-related queries and operations.
UTCA list of all channelUuids in the report, comma separated.
A list of all tagsName in the report, comma separated.
Capping ammount of items to be used in the report.
The report sorting type
Optional filter field name being queried at the page currently.
Optional filter field value being queried at the page currently.
POST /org/{orgUUID}/env/{envUUID}/bot/{botUUID}/messages/request_report HTTP/1.1
Host:
Content-Type: application/json
Accept: */*
Content-Length: 358
{
"startDate": "2025-07-13T06:38:36.388Z",
"endDate": "2025-07-13T06:38:36.388Z",
"startHour": 1,
"endHour": 1,
"timezone": "UTC",
"channelUuids": [
"text"
],
"tagsName": [
"text"
],
"sampleSize": 1,
"reportType": "RANDOM",
"filterField": "text",
"filterTerm": "text",
"funnelTags": [
[
"text"
]
],
"previousStartDate": "2025-07-13T06:38:36.388Z",
"previousEndDate": "2025-07-13T06:38:36.388Z"
}No content
Previews the available report sample size, returning the estimate ammount of items that will be present in a report.
A valid uuid of an organization
A valid uuid of an environment
The UUID of the bot whose conversations you are searching
Body containing the properties to use in this report
Starting date of the report range, including itself, in ISO-8601 format (yyyy-MM-dd'T'HH:mm:ss.SSS'Z')
Ending date of the report range, including itself, in ISO-8601 format (yyyy-MM-dd'T'HH:mm:ss.SSS'Z')
Starting hour of the report range, from 0 to 23. Hour sent is included in the report.
Ending hour of the report range, from 0 to 23. Hour sent is included in the report.
A list of all channelUuids in the report, comma separated.
Capping ammount of items to be used in the report.
Minimal confidence level in the report results, simulating response to a configuration in the parameters screen.
An error margin into the confidence level, allowing for variance.
Optional filter field name being queried at the page currently.
Optional filter field value being queried at the page currently.
POST /org/{orgUUID}/env/{envUUID}/bot/{botUUID}/messages/request_sample HTTP/1.1
Host:
Content-Type: application/json
Accept: */*
Content-Length: 217
{
"startDate": "2025-07-13T06:38:36.388Z",
"endDate": "2025-07-13T06:38:36.388Z",
"startHour": 1,
"endHour": 1,
"channelUuids": "text",
"sampleSize": 1,
"confidenceLevel": 1,
"errorMargin": 1,
"filterField": "text",
"filterTerm": "text"
}{
"sampleSize": 1
}Reports
A valid uuid of an organization
A valid uuid of an environment
The UUID of the bot whose messages you are searching
Current page, starting at 1
1Example: 1Size of the page
5Example: 1GET /org/{orgUUID}/env/{envUUID}/bot/{botUUID}/reports/list?page=1&size=5 HTTP/1.1
Host:
Accept: */*
{
"totalPages": 1,
"totalElements": 1,
"pageable": {
"unpaged": true,
"paged": true,
"pageNumber": 1,
"pageSize": 1,
"offset": 1,
"sort": {
"unsorted": true,
"sorted": true,
"empty": true
}
},
"numberOfElements": 1,
"size": 1,
"content": [
{
"fileName": "text",
"createdAt": "text",
"fileUrl": "text",
"reportType": "GROUPED_MESSAGES"
}
],
"number": 1,
"sort": {
"unsorted": true,
"sorted": true,
"empty": true
},
"first": true,
"last": true,
"empty": true
}Last updated
Was this helpful?