User Guide
API DOCSVOICE GATEWAYHELPSECURITY
Current Version
Current Version
  • Welcome
  • What's New
  • 🚀GETTING STARTED
    • Login
    • Concepts and Glossary
    • Language Models
      • Syntphony NLP
      • Other NLP and LLM Connectors
      • FAQs
    • Build a Virtual Agent
      • Overview
      • From Scratch
      • By Importing
      • Pre-Built Templates
      • Training task
    • Testing
      • Automated Test
      • Advanced Request
      • Simulate Dialog
      • View Logs
    • Create and manage profiles
  • 💬BUILD DIALOGS
    • Flows
    • Dialog Cells
      • Intent
      • Entity
      • Answer
      • Input
      • Jump
      • End
      • Service
      • Rest Connector
      • Code
      • Rule
        • Variable answers using Code and Rule cells
        • Enable and disable flows using Rule Cells
    • Data Masking of Personal Identificable Information
    • Dynamic Content and Contexts
    • Voice Agent
    • Multilingual Agent (beta)
  • ✨GENERATIVE AI
    • AI features
    • Assist Answer (beta)
    • Examples Generator
    • Knowledge AI
    • Prompt cell
      • Prompt crafting
      • Practical examples
    • Rephrase Answer
    • Zero-Shot LLM
  • 🌐CHANNELS
    • Channels
      • WhatsApp (by Infobip)
      • Facebook Messenger
      • Microsoft Teams
      • Integrating Existing Channels
    • Webchat Plugin
  • ⚙️CONFIGURATIONS
    • Parameters
    • Advanced Resources
    • Other Options
      • Intent Navigator
  • 📊ANALYTICS & INSIGHTS
    • Dashboards
      • Overview
      • Funnel charts
      • User messages
      • Conversations
      • Reports
    • External Analytics Platforms
  • API DOCS
    • Overview
    • API Guidelines
      • Conversation API
      • Cloner API
      • EVG Connector
      • Management API
        • Admin API
          • Bot Admin
          • Environment
          • Organization
          • User
          • Notification
        • Instance API
          • Knowledge AI
          • Knowledge AI NLP
          • Answer
          • Automated Tests
          • Bot
          • Broker
          • Channel
          • Dashboard
          • Dialog Manager
          • Entity
          • Generative Service
          • Intent
          • Parameters
          • Tag
          • Technical Log
          • Training
          • Transactional Service
          • Rest Connector
          • Wait Input
          • Websnippet
      • Webhooks
    • Infrastructure Guidelines
      • Syntphony CAI server Installation guide
      • Maintenance Methods
      • Supported/verified third-party software
    • Data Structure
      • Admin Data Structure
      • Environment Data Structure
    • Voice Gateway
      • Genesys Cloud CX
Powered by GitBook
On this page

Was this helpful?

  1. API DOCS
  2. API Guidelines
  3. Management API
  4. Instance API

Dashboard

The Dashboard API handles large data for the purpose of customer usage analytics.

PreviousChannelNextDialog Manager

Last updated 5 months ago

Was this helpful?

API SUBPATH: eva-dashboard

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

These methods should be called before you accept any requests on a further dashboard version. The summary method will return the ammount of data which is available for you to query, while the report_configuration will give you the available filters, sorting parameters and query ammount cap you have access to. Querying anything beyond those designated filters will fail.

Data Analytics

Conversations

Messages

Reports

Acquires the dashboards' configurations and availability summary. Should be called on dashboard opening.

get
Path parameters
orgUUIDstringRequired

A valid uuid of an organization

envUUIDstringRequired

A valid uuid of an environment

botUUIDstringRequired

The UUID of the bot whose entities you are searching

Responses
200
Ok
application/json
400
Bad Request
*/*
401
Unauthorized
*/*
403
Forbidden
*/*
404
Not Found
*/*
409
Conflict
*/*
422
Unprocessable Entity
*/*
500
Internal Server Error
*/*
get
GET /org/{orgUUID}/env/{envUUID}/bot/{botUUID}/dashboard/summary HTTP/1.1
Host: 
Accept: */*
{
  "hasData": true,
  "firstDataSet": "2025-05-09T12:14:45.315Z"
}

Acquires the configurations and rules to present in the request report prompts for conversations.

get
Path parameters
orgUUIDstringRequired

A valid uuid of an organization

envUUIDstringRequired

A valid uuid of an environment

botUUIDstringRequired

The UUID of the bot whose conversations you are searching

Responses
200
Ok
application/json
400
Bad Request
*/*
401
Unauthorized
*/*
403
Forbidden
*/*
404
Not Found
*/*
409
Conflict
*/*
422
Unprocessable Entity
*/*
500
Internal Server Error
*/*
get
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.

get
Path parameters
orgUUIDstringRequired

A valid uuid of an organization

envUUIDstringRequired

A valid uuid of an environment

botUUIDstringRequired

The UUID of the bot whose conversations you are searching

Responses
200
Ok
application/json
400
Bad Request
*/*
401
Unauthorized
*/*
403
Forbidden
*/*
404
Not Found
*/*
409
Conflict
*/*
422
Unprocessable Entity
*/*
500
Internal Server Error
*/*
get
GET /org/{orgUUID}/env/{envUUID}/bot/{botUUID}/messages/report_configurations HTTP/1.1
Host: 
Accept: */*
{
  "maxSample": 1,
  "availableExportTypes": [
    "text"
  ]
}

Requests the creation of a report in the Reports section, with the full content of a conversation.

get
Path parameters
orgUUIDstringRequired

A valid uuid of an organization

envUUIDstringRequired

A valid uuid of an environment

botUUIDstringRequired

The UUID of the bot whose conversations you are searching

Query parameters
sessionCodestringRequired

Session Code of the conversation

Responses
200
Ok
application/json
400
Bad Request
*/*
401
Unauthorized
*/*
403
Forbidden
*/*
404
Not Found
*/*
409
Conflict
*/*
422
Unprocessable Entity
*/*
500
Internal Server Error
*/*
get
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.

post
Path parameters
orgUUIDstringRequired

A valid uuid of an organization

envUUIDstringRequired

A valid uuid of an environment

botUUIDstringRequired

The UUID of the bot whose conversations you are searching

Query parameters
sessionCodestringRequired

Session Code of the conversation

timezonestringOptional

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.

Default: UTC
Responses
200
Ok
400
Bad Request
*/*
401
Unauthorized
*/*
403
Forbidden
*/*
404
Not Found
*/*
409
Conflict
*/*
422
Unprocessable Entity
*/*
500
Internal Server Error
*/*
post
POST /org/{orgUUID}/env/{envUUID}/bot/{botUUID}/conversations/details/request_report?sessionCode=text HTTP/1.1
Host: 
Accept: */*

No content

Searches and paginates through messages sent by our users, according to the current filters.

get
Path parameters
orgUUIDstringRequired

A valid uuid of an organization

envUUIDstringRequired

A valid uuid of an environment

botUUIDstringRequired

The UUID of the bot whose messages you are searching

Query parameters
pageinteger · int32Required

Current page, starting at 1

Default: 1Example: 1
sizeinteger · int32Required

Size of the page

Default: 5Example: 1
Responses
200
Ok
application/json
400
Bad Request
*/*
401
Unauthorized
*/*
403
Forbidden
*/*
404
Not Found
*/*
409
Conflict
*/*
422
Unprocessable Entity
*/*
500
Internal Server Error
*/*
get
GET /org/{orgUUID}/env/{envUUID}/bot/{botUUID}/reports/list?page=1&size=1 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
}
  • Auxiliary Methods
  • GETAcquires the dashboards' configurations and availability summary. Should be called on dashboard opening.
  • GETAcquires the configurations and rules to present in the request report prompts for conversations.
  • GETAcquires the configurations and rules to present in the request report prompts for conversations.
  • Data Analytics
  • POSTFetches information regarding Conversations traffic, regarding a given period of time. This information is used to build both conversation boxes in the dashboard.
  • POSTFetches information regarding messages traffic, regarding a given period of time. This information is used to build both conversation boxes in the dashboard.
  • POSTFetches information regarding users traffic, regarding a given period of time. This information is used to build both conversation boxes in the dashboard.
  • POSTAcquires the accuracy for analytics into this bot, considering the range of dates and specified channels.
  • POSTFetches data for a stacked Graph. In this instance, Top 10 used intents.
  • POSTFetches data for a stacked Graph. In this instance, Top 10 accessed flows.
  • POSTFetches data for a stacked Graph. In this instance, Top 10 abandoned flows.
  • Conversations
  • POSTSearches and paginates through conversations started by our users, according to the current filters.
  • POSTRequests the creation of a report in the Reports section, according to sent parameters.
  • GETRequests the creation of a report in the Reports section, with the full content of a conversation.
  • POSTRequests the creation of a report in the Reports section, with the full content of a conversation.
  • POSTPreviews the available report sample size, returning the estimate ammount of items that will be present in a report.
  • Messages
  • POSTSearches and paginates through messages sent by our users, according to the current filters.
  • POSTRequests the creation of a report in the Reports section, according to sent parameters.
  • POSTPreviews the available report sample size, returning the estimate ammount of items that will be present in a report.
  • Reports
  • GETSearches and paginates through messages sent by our users, according to the current filters.

Fetches information regarding Conversations traffic, regarding a given period of time. This information is used to build both conversation boxes in the dashboard.

post
Path parameters
orgUUIDstringRequired

A valid uuid of an organization

envUUIDstringRequired

A valid uuid of an environment

botUUIDstringRequired

The UUID of the bot whose entities you are searching

Body

Parameters used to filter the data of user conversations and messages.

startDatestring · date-timeRequired

Starting date for the search (inclusive). Must conform to ISO format.

endDatestring · date-timeRequired

End date for the search (inclusive). Must conform to ISO format.

startHourinteger · int32Required

Starting hour of the search interval. 0 if unfiltered.

endHourinteger · int32Required

Ending hour of the search interval. 23 if unfiltered.

timezonestringOptional

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.

Default: UTC
channelUUIDsstring[]Optional

ALL channelUuids to filter. If empty, all are used instead.

tagsNamestring[]Optional

ALL tags name to filter. If empty, no tag filter will be applied.

previousStartDatestring · date-timeOptional
previousEndDatestring · date-timeOptional
Responses
200
Ok
application/json
400
Bad Request
*/*
401
Unauthorized
*/*
403
Forbidden
*/*
404
Not Found
*/*
409
Conflict
*/*
422
Unprocessable Entity
*/*
500
Internal Server Error
*/*
post
POST /org/{orgUUID}/env/{envUUID}/bot/{botUUID}/dashboard/conversations HTTP/1.1
Host: 
Content-Type: application/json
Accept: */*
Content-Length: 257

{
  "startDate": "2025-05-09T12:14:45.315Z",
  "endDate": "2025-05-09T12:14:45.315Z",
  "startHour": 1,
  "endHour": 1,
  "timezone": "text",
  "channelUUIDs": [
    "text"
  ],
  "tagsName": [
    "text"
  ],
  "previousStartDate": "2025-05-09T12:14:45.315Z",
  "previousEndDate": "2025-05-09T12:14:45.315Z"
}
{
  "resource": "ANALYTIC_CONVERSATION",
  "periodOverview": {
    "totalAmount": 1,
    "hasRelativeData": true,
    "relativeIncrease": 1,
    "hasIncreased": true,
    "relativeStartDate": "2025-05-09T12:14:45.315Z",
    "relativeEndDate": "2025-05-09T12:14:45.315Z"
  },
  "channelAnalytics": [
    {
      "channelType": "text",
      "channelName": "text",
      "hours": [
        {
          "date": "2025-05-09T12:14:45.315Z",
          "value": 1
        }
      ],
      "days": [
        {
          "date": "2025-05-09T12:14:45.315Z",
          "value": 1
        }
      ],
      "weeks": [
        {
          "monthDate": "2025-05-09T12:14:45.315Z",
          "weekNumber": 1,
          "value": 1
        }
      ],
      "months": [
        {
          "date": "2025-05-09T12:14:45.315Z",
          "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.

post
Path parameters
orgUUIDstringRequired

A valid uuid of an organization

envUUIDstringRequired

A valid uuid of an environment

botUUIDstringRequired

The UUID of the bot whose entities you are searching

Body

Parameters used to filter the data of user conversations and messages.

startDatestring · date-timeRequired

Starting date for the search (inclusive). Must conform to ISO format.

endDatestring · date-timeRequired

End date for the search (inclusive). Must conform to ISO format.

startHourinteger · int32Required

Starting hour of the search interval. 0 if unfiltered.

endHourinteger · int32Required

Ending hour of the search interval. 23 if unfiltered.

timezonestringOptional

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.

Default: UTC
channelUUIDsstring[]Optional

ALL channelUuids to filter. If empty, all are used instead.

tagsNamestring[]Optional

ALL tags name to filter. If empty, no tag filter will be applied.

previousStartDatestring · date-timeOptional
previousEndDatestring · date-timeOptional
Responses
200
Ok
application/json
400
Bad Request
*/*
401
Unauthorized
*/*
403
Forbidden
*/*
404
Not Found
*/*
409
Conflict
*/*
422
Unprocessable Entity
*/*
500
Internal Server Error
*/*
post
POST /org/{orgUUID}/env/{envUUID}/bot/{botUUID}/dashboard/messages HTTP/1.1
Host: 
Content-Type: application/json
Accept: */*
Content-Length: 257

{
  "startDate": "2025-05-09T12:14:45.315Z",
  "endDate": "2025-05-09T12:14:45.315Z",
  "startHour": 1,
  "endHour": 1,
  "timezone": "text",
  "channelUUIDs": [
    "text"
  ],
  "tagsName": [
    "text"
  ],
  "previousStartDate": "2025-05-09T12:14:45.315Z",
  "previousEndDate": "2025-05-09T12:14:45.315Z"
}
{
  "resource": "ANALYTIC_CONVERSATION",
  "periodOverview": {
    "totalAmount": 1,
    "hasRelativeData": true,
    "relativeIncrease": 1,
    "hasIncreased": true,
    "relativeStartDate": "2025-05-09T12:14:45.315Z",
    "relativeEndDate": "2025-05-09T12:14:45.315Z"
  },
  "trafficAnalyticsDTO": {
    "hours": [
      {
        "date": "2025-05-09T12:14:45.315Z",
        "value": 1
      }
    ],
    "days": [
      {
        "date": "2025-05-09T12:14:45.315Z",
        "value": 1
      }
    ],
    "weeks": [
      {
        "monthDate": "2025-05-09T12:14:45.315Z",
        "weekNumber": 1,
        "value": 1
      }
    ],
    "months": [
      {
        "date": "2025-05-09T12:14:45.315Z",
        "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.

post
Path parameters
orgUUIDstringRequired

A valid uuid of an organization

envUUIDstringRequired

A valid uuid of an environment

botUUIDstringRequired

The UUID of the bot whose entities you are searching

Body

Parameters used to filter the data of user conversations and messages.

startDatestring · date-timeRequired

Starting date for the search (inclusive). Must conform to ISO format.

endDatestring · date-timeRequired

End date for the search (inclusive). Must conform to ISO format.

startHourinteger · int32Required

Starting hour of the search interval. 0 if unfiltered.

endHourinteger · int32Required

Ending hour of the search interval. 23 if unfiltered.

timezonestringOptional

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.

Default: UTC
channelUUIDsstring[]Optional

ALL channelUuids to filter. If empty, all are used instead.

tagsNamestring[]Optional

ALL tags name to filter. If empty, no tag filter will be applied.

previousStartDatestring · date-timeOptional
previousEndDatestring · date-timeOptional
Responses
200
Ok
application/json
400
Bad Request
*/*
401
Unauthorized
*/*
403
Forbidden
*/*
404
Not Found
*/*
409
Conflict
*/*
422
Unprocessable Entity
*/*
500
Internal Server Error
*/*
post
POST /org/{orgUUID}/env/{envUUID}/bot/{botUUID}/dashboard/users HTTP/1.1
Host: 
Content-Type: application/json
Accept: */*
Content-Length: 257

{
  "startDate": "2025-05-09T12:14:45.315Z",
  "endDate": "2025-05-09T12:14:45.315Z",
  "startHour": 1,
  "endHour": 1,
  "timezone": "text",
  "channelUUIDs": [
    "text"
  ],
  "tagsName": [
    "text"
  ],
  "previousStartDate": "2025-05-09T12:14:45.315Z",
  "previousEndDate": "2025-05-09T12:14:45.315Z"
}
{
  "resource": "ANALYTIC_CONVERSATION",
  "periodOverview": {
    "totalAmount": 1,
    "hasRelativeData": true,
    "relativeIncrease": 1,
    "hasIncreased": true,
    "relativeStartDate": "2025-05-09T12:14:45.315Z",
    "relativeEndDate": "2025-05-09T12:14:45.315Z"
  },
  "trafficAnalyticsDTO": {
    "hours": [
      {
        "date": "2025-05-09T12:14:45.315Z",
        "value": 1
      }
    ],
    "days": [
      {
        "date": "2025-05-09T12:14:45.315Z",
        "value": 1
      }
    ],
    "weeks": [
      {
        "monthDate": "2025-05-09T12:14:45.315Z",
        "weekNumber": 1,
        "value": 1
      }
    ],
    "months": [
      {
        "date": "2025-05-09T12:14:45.315Z",
        "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.

post
Path parameters
orgUUIDstringRequired

A valid uuid of an organization

envUUIDstringRequired

A valid uuid of an environment

botUUIDstringRequired

The UUID of the bot whose entities you are searching

Body

Parameters used to filter the data of user conversations and messages.

startDatestring · date-timeRequired

Starting date for the search (inclusive). Must conform to ISO format.

endDatestring · date-timeRequired

End date for the search (inclusive). Must conform to ISO format.

startHourinteger · int32Required

Starting hour of the search interval. 0 if unfiltered.

endHourinteger · int32Required

Ending hour of the search interval. 23 if unfiltered.

timezonestringOptional

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.

Default: UTC
channelUUIDsstring[]Optional

ALL channelUuids to filter. If empty, all are used instead.

tagsNamestring[]Optional

ALL tags name to filter. If empty, no tag filter will be applied.

previousStartDatestring · date-timeOptional
previousEndDatestring · date-timeOptional
Responses
200
Ok
application/json
400
Bad Request
*/*
401
Unauthorized
*/*
403
Forbidden
*/*
404
Not Found
*/*
409
Conflict
*/*
422
Unprocessable Entity
*/*
500
Internal Server Error
*/*
post
POST /org/{orgUUID}/env/{envUUID}/bot/{botUUID}/dashboard/accuracy HTTP/1.1
Host: 
Content-Type: application/json
Accept: */*
Content-Length: 257

{
  "startDate": "2025-05-09T12:14:45.315Z",
  "endDate": "2025-05-09T12:14:45.315Z",
  "startHour": 1,
  "endHour": 1,
  "timezone": "text",
  "channelUUIDs": [
    "text"
  ],
  "tagsName": [
    "text"
  ],
  "previousStartDate": "2025-05-09T12:14:45.315Z",
  "previousEndDate": "2025-05-09T12:14:45.315Z"
}
{
  "rateCurrent": 1,
  "ratePrevious": 1,
  "hasIncreased": true,
  "relativeIncrease": 1,
  "relativeStartDate": "2025-05-09T12:14:45.315Z",
  "relativeEndDate": "2025-05-09T12:14:45.315Z"
}

Fetches data for a stacked Graph. In this instance, Top 10 used intents.

post
Path parameters
orgUUIDstringRequired

A valid uuid of an organization

envUUIDstringRequired

A valid uuid of an environment

botUUIDstringRequired

The UUID of the bot whose entities you are searching

Body

Parameters used to filter the data of user conversations and messages.

startDatestring · date-timeRequired

Starting date for the search (inclusive). Must conform to ISO format.

endDatestring · date-timeRequired

End date for the search (inclusive). Must conform to ISO format.

startHourinteger · int32Required

Starting hour of the search interval. 0 if unfiltered.

endHourinteger · int32Required

Ending hour of the search interval. 23 if unfiltered.

timezonestringOptional

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.

Default: UTC
channelUUIDsstring[]Optional

ALL channelUuids to filter. If empty, all are used instead.

tagsNamestring[]Optional

ALL tags name to filter. If empty, no tag filter will be applied.

previousStartDatestring · date-timeOptional
previousEndDatestring · date-timeOptional
Responses
200
Ok
application/json
400
Bad Request
*/*
401
Unauthorized
*/*
403
Forbidden
*/*
404
Not Found
*/*
409
Conflict
*/*
422
Unprocessable Entity
*/*
500
Internal Server Error
*/*
post
POST /org/{orgUUID}/env/{envUUID}/bot/{botUUID}/dashboard/stacking/intents HTTP/1.1
Host: 
Content-Type: application/json
Accept: */*
Content-Length: 257

{
  "startDate": "2025-05-09T12:14:45.315Z",
  "endDate": "2025-05-09T12:14:45.315Z",
  "startHour": 1,
  "endHour": 1,
  "timezone": "text",
  "channelUUIDs": [
    "text"
  ],
  "tagsName": [
    "text"
  ],
  "previousStartDate": "2025-05-09T12:14:45.315Z",
  "previousEndDate": "2025-05-09T12:14:45.315Z"
}
{
  "resource": "ANALYTIC_INTENTS",
  "channelList": [
    {
      "name": "text",
      "topicBreakdown": [
        {
          "name": "text",
          "channelValue": 1,
          "totalValue": 1
        }
      ]
    }
  ]
}

Fetches data for a stacked Graph. In this instance, Top 10 accessed flows.

post
Path parameters
orgUUIDstringRequired

A valid uuid of an organization

envUUIDstringRequired

A valid uuid of an environment

botUUIDstringRequired

The UUID of the bot whose entities you are searching

Body

Parameters used to filter the data of user conversations and messages.

startDatestring · date-timeRequired

Starting date for the search (inclusive). Must conform to ISO format.

endDatestring · date-timeRequired

End date for the search (inclusive). Must conform to ISO format.

startHourinteger · int32Required

Starting hour of the search interval. 0 if unfiltered.

endHourinteger · int32Required

Ending hour of the search interval. 23 if unfiltered.

timezonestringOptional

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.

Default: UTC
channelUUIDsstring[]Optional

ALL channelUuids to filter. If empty, all are used instead.

tagsNamestring[]Optional

ALL tags name to filter. If empty, no tag filter will be applied.

previousStartDatestring · date-timeOptional
previousEndDatestring · date-timeOptional
Responses
200
Ok
application/json
400
Bad Request
*/*
401
Unauthorized
*/*
403
Forbidden
*/*
404
Not Found
*/*
409
Conflict
*/*
422
Unprocessable Entity
*/*
500
Internal Server Error
*/*
post
POST /org/{orgUUID}/env/{envUUID}/bot/{botUUID}/dashboard/stacking/flows HTTP/1.1
Host: 
Content-Type: application/json
Accept: */*
Content-Length: 257

{
  "startDate": "2025-05-09T12:14:45.315Z",
  "endDate": "2025-05-09T12:14:45.315Z",
  "startHour": 1,
  "endHour": 1,
  "timezone": "text",
  "channelUUIDs": [
    "text"
  ],
  "tagsName": [
    "text"
  ],
  "previousStartDate": "2025-05-09T12:14:45.315Z",
  "previousEndDate": "2025-05-09T12:14:45.315Z"
}
{
  "resource": "ANALYTIC_INTENTS",
  "channelList": [
    {
      "name": "text",
      "topicBreakdown": [
        {
          "name": "text",
          "channelValue": 1,
          "totalValue": 1
        }
      ]
    }
  ]
}

Fetches data for a stacked Graph. In this instance, Top 10 abandoned flows.

post
Path parameters
orgUUIDstringRequired

A valid uuid of an organization

envUUIDstringRequired

A valid uuid of an environment

botUUIDstringRequired

The UUID of the bot whose entities you are searching

Body

Parameters used to filter the data of user conversations and messages.

startDatestring · date-timeRequired

Starting date for the search (inclusive). Must conform to ISO format.

endDatestring · date-timeRequired

End date for the search (inclusive). Must conform to ISO format.

startHourinteger · int32Required

Starting hour of the search interval. 0 if unfiltered.

endHourinteger · int32Required

Ending hour of the search interval. 23 if unfiltered.

timezonestringOptional

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.

Default: UTC
channelUUIDsstring[]Optional

ALL channelUuids to filter. If empty, all are used instead.

tagsNamestring[]Optional

ALL tags name to filter. If empty, no tag filter will be applied.

previousStartDatestring · date-timeOptional
previousEndDatestring · date-timeOptional
Responses
200
Ok
application/json
400
Bad Request
*/*
401
Unauthorized
*/*
403
Forbidden
*/*
404
Not Found
*/*
409
Conflict
*/*
422
Unprocessable Entity
*/*
500
Internal Server Error
*/*
post
POST /org/{orgUUID}/env/{envUUID}/bot/{botUUID}/dashboard/stacking/abandonments HTTP/1.1
Host: 
Content-Type: application/json
Accept: */*
Content-Length: 257

{
  "startDate": "2025-05-09T12:14:45.315Z",
  "endDate": "2025-05-09T12:14:45.315Z",
  "startHour": 1,
  "endHour": 1,
  "timezone": "text",
  "channelUUIDs": [
    "text"
  ],
  "tagsName": [
    "text"
  ],
  "previousStartDate": "2025-05-09T12:14:45.315Z",
  "previousEndDate": "2025-05-09T12:14:45.315Z"
}
{
  "resource": "ANALYTIC_INTENTS",
  "channelList": [
    {
      "name": "text",
      "topicBreakdown": [
        {
          "name": "text",
          "channelValue": 1,
          "totalValue": 1
        }
      ]
    }
  ]
}

Searches and paginates through conversations started by our users, according to the current filters.

post
Path parameters
orgUUIDstringRequired

A valid uuid of an organization.

envUUIDstringRequired

A valid uuid of an environment.

botUUIDstringRequired

The UUID of the bot whose conversations you are searching.

Body

Parameters used to filter the data of user conversations and messages.

startDatestring · date-timeRequired

Starting date for the search (inclusive). Must conform to ISO format.

endDatestring · date-timeRequired

End date for the search (inclusive). Must conform to ISO format.

startHourinteger · int32Required

Starting hour of the search interval. 0 if unfiltered.

endHourinteger · int32Required

Ending hour of the search interval. 23 if unfiltered.

timezonestringOptional

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.

Default: UTC
channelUUIDsstring[]Optional

ALL channelUuids to filter. If empty, all are used instead.

tagsNamestring[]Optional

ALL tags name to filter. If empty, no tag filter will be applied.

searchBystringOptional

Type of search filter being applied on this query. Possible fields are: [SESSION_CODE, BUSINESS_KEY, FLOW]

searchTermstringOptional

Term being searched according to the searchBy filter.

pageinteger · int32Optional

Current page, starting at 1

sizeinteger · int32Optional

Size of the page

orderBystringOptional

Criteria to order result, defaulted to conversationStartedAt. Possible fields include satisfaction, userMessages, flowsTravelled, conversationStartedAt and duration.

directionstringOptional

Order direction(ASC/DESC), defaulted to DESC

nonTagsbooleanOptional

Used for when we want to filter user messages or conversations that have not been through tags.

previousStartDatestring · date-timeOptional
previousEndDatestring · date-timeOptional
Responses
200
Ok
application/json
400
Bad Request
*/*
401
Unauthorized
*/*
403
Forbidden
*/*
404
Not Found
*/*
409
Conflict
*/*
422
Unprocessable Entity
*/*
500
Internal Server Error
*/*
post
POST /org/{orgUUID}/env/{envUUID}/bot/{botUUID}/conversations/list HTTP/1.1
Host: 
Content-Type: application/json
Accept: */*
Content-Length: 388

{
  "startDate": "2025-05-09T12:14:45.315Z",
  "endDate": "2025-05-09T12:14:45.315Z",
  "startHour": 1,
  "endHour": 1,
  "timezone": "text",
  "channelUUIDs": [
    "text"
  ],
  "tagsName": [
    "text"
  ],
  "searchBy": "text",
  "searchTerm": "text",
  "page": 1,
  "size": 1,
  "orderBy": "text",
  "direction": "text",
  "funnelTags": [
    [
      "text"
    ]
  ],
  "nonTags": true,
  "previousStartDate": "2025-05-09T12:14:45.315Z",
  "previousEndDate": "2025-05-09T12:14:45.315Z"
}
{
  "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
}

Requests the creation of a report in the Reports section, according to sent parameters.

post
Path parameters
orgUUIDstringRequired

A valid uuid of an organization

envUUIDstringRequired

A valid uuid of an environment

botUUIDstringRequired

The UUID of the bot whose conversations you are searching

Body

Body containing the properties to use in this report

startDatestring · date-timeRequired

Starting date for the search (inclusive). Must conform to ISO format.

endDatestring · date-timeRequired

End date for the search (inclusive). Must conform to ISO format.

startHourinteger · int32Required

Starting hour of the search interval. 0 if unfiltered.

endHourinteger · int32Required

Ending hour of the search interval. 23 if unfiltered.

timezonestringOptional

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.

Default: UTC
channelUuidsstring[]Optional

A list of all channelUuids in the report, comma separated.

tagsNamestring[]Optional

A list of all tagsName in the report, comma separated.

sampleSizeinteger · int32Optional

Capping ammount of items to be used in the report.

reportTypestring · enumOptional

The report sorting type

Possible values:
filterFieldstringOptional

Optional filter field name being queried at the page currently.

filterTermstringOptional

Optional filter field value being queried at the page currently.

previousStartDatestring · date-timeOptional
previousEndDatestring · date-timeOptional
Responses
200
Ok
400
Bad Request
*/*
401
Unauthorized
*/*
403
Forbidden
*/*
404
Not Found
*/*
409
Conflict
*/*
422
Unprocessable Entity
*/*
500
Internal Server Error
*/*
post
POST /org/{orgUUID}/env/{envUUID}/bot/{botUUID}/conversations/request_report HTTP/1.1
Host: 
Content-Type: application/json
Accept: */*
Content-Length: 359

{
  "startDate": "2025-05-09T12:14:45.315Z",
  "endDate": "2025-05-09T12:14:45.315Z",
  "startHour": 1,
  "endHour": 1,
  "timezone": "text",
  "channelUuids": [
    "text"
  ],
  "tagsName": [
    "text"
  ],
  "sampleSize": 1,
  "reportType": "RANDOM",
  "filterField": "text",
  "filterTerm": "text",
  "funnelTags": [
    [
      "text"
    ]
  ],
  "previousStartDate": "2025-05-09T12:14:45.315Z",
  "previousEndDate": "2025-05-09T12:14:45.315Z"
}

No content

Previews the available report sample size, returning the estimate ammount of items that will be present in a report.

post
Path parameters
orgUUIDstringRequired

A valid uuid of an organization

envUUIDstringRequired

A valid uuid of an environment

botUUIDstringRequired

The UUID of the bot whose conversations you are searching

Body

Body containing the properties to use in this report

startDatestring · date-timeOptional

Starting date of the report range, including itself, in ISO-8601 format (yyyy-MM-dd'T'HH:mm:ss.SSS'Z')

endDatestring · date-timeOptional

Ending date of the report range, including itself, in ISO-8601 format (yyyy-MM-dd'T'HH:mm:ss.SSS'Z')

startHourinteger · int32Optional

Starting hour of the report range, from 0 to 23. Hour sent is included in the report.

endHourinteger · int32Optional

Ending hour of the report range, from 0 to 23. Hour sent is included in the report.

channelUuidsstringOptional

A list of all channelUuids in the report, comma separated.

sampleSizeinteger · int32Optional

Capping ammount of items to be used in the report.

confidenceLevelinteger · int32Optional

Minimal confidence level in the report results, simulating response to a configuration in the parameters screen.

errorMargininteger · int32Optional

An error margin into the confidence level, allowing for variance.

filterFieldstringOptional

Optional filter field name being queried at the page currently.

filterTermstringOptional

Optional filter field value being queried at the page currently.

Responses
200
Ok
application/json
400
Bad Request
*/*
401
Unauthorized
*/*
403
Forbidden
*/*
404
Not Found
*/*
409
Conflict
*/*
422
Unprocessable Entity
*/*
500
Internal Server Error
*/*
post
POST /org/{orgUUID}/env/{envUUID}/bot/{botUUID}/conversations/request_sample HTTP/1.1
Host: 
Content-Type: application/json
Accept: */*
Content-Length: 217

{
  "startDate": "2025-05-09T12:14:45.315Z",
  "endDate": "2025-05-09T12:14:45.315Z",
  "startHour": 1,
  "endHour": 1,
  "channelUuids": "text",
  "sampleSize": 1,
  "confidenceLevel": 1,
  "errorMargin": 1,
  "filterField": "text",
  "filterTerm": "text"
}
{
  "sampleSize": 1
}

Searches and paginates through messages sent by our users, according to the current filters.

post
Path parameters
orgUUIDstringRequired

A valid uuid of an organization.

envUUIDstringRequired

A valid uuid of an environment.

botUUIDstringRequired

The UUID of the bot whose messages you are searching.

Body

Parameters used to filter the data of user conversations and messages.

startDatestring · date-timeRequired

Starting date for the search (inclusive). Must conform to ISO format.

endDatestring · date-timeRequired

End date for the search (inclusive). Must conform to ISO format.

startHourinteger · int32Required

Starting hour of the search interval. 0 if unfiltered.

endHourinteger · int32Required

Ending hour of the search interval. 23 if unfiltered.

timezonestringOptional

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.

Default: UTC
channelUUIDsstring[]Optional

ALL channelUuids to filter. If empty, all are used instead.

tagsNamestring[]Optional

ALL tags name to filter. If empty, no tag filter will be applied.

searchBystringOptional

Type of search filter being applied on this query. Possible fields are: [SESSION_CODE, BUSINESS_KEY, FLOW]

searchTermstringOptional

Term being searched according to the searchBy filter.

pageinteger · int32Optional

Current page, starting at 1

sizeinteger · int32Optional

Size of the page

orderBystringOptional

Criteria to order result, defaulted to conversationStartedAt. Possible fields include satisfaction, userMessages, flowsTravelled, conversationStartedAt and duration.

directionstringOptional

Order direction(ASC/DESC), defaulted to DESC

nonTagsbooleanOptional

Used for when we want to filter user messages or conversations that have not been through tags.

nlpResponsesstringOptional

A comma-separated String containing ALL nlpResponseFilters to filter. Those may be one of: [FOUND, NONE, ALL].

previousStartDatestring · date-timeOptional
previousEndDatestring · date-timeOptional
Responses
200
Ok
application/json
400
Bad Request
*/*
401
Unauthorized
*/*
403
Forbidden
*/*
404
Not Found
*/*
409
Conflict
*/*
422
Unprocessable Entity
*/*
500
Internal Server Error
*/*
post
POST /org/{orgUUID}/env/{envUUID}/bot/{botUUID}/messages/list HTTP/1.1
Host: 
Content-Type: application/json
Accept: */*
Content-Length: 410

{
  "startDate": "2025-05-09T12:14:45.315Z",
  "endDate": "2025-05-09T12:14:45.315Z",
  "startHour": 1,
  "endHour": 1,
  "timezone": "text",
  "channelUUIDs": [
    "text"
  ],
  "tagsName": [
    "text"
  ],
  "searchBy": "text",
  "searchTerm": "text",
  "page": 1,
  "size": 1,
  "orderBy": "text",
  "direction": "text",
  "funnelTags": [
    [
      "text"
    ]
  ],
  "nonTags": true,
  "nlpResponses": "text",
  "previousStartDate": "2025-05-09T12:14:45.315Z",
  "previousEndDate": "2025-05-09T12:14:45.315Z"
}
{
  "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
}

Requests the creation of a report in the Reports section, according to sent parameters.

post
Path parameters
orgUUIDstringRequired

A valid uuid of an organization

envUUIDstringRequired

A valid uuid of an environment

botUUIDstringRequired

The UUID of the bot whose conversations you are searching

Body

Body containing the properties to use in this report

startDatestring · date-timeRequired

Starting date for the search (inclusive). Must conform to ISO format.

endDatestring · date-timeRequired

End date for the search (inclusive). Must conform to ISO format.

startHourinteger · int32Required

Starting hour of the search interval. 0 if unfiltered.

endHourinteger · int32Required

Ending hour of the search interval. 23 if unfiltered.

timezonestringOptional

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.

Default: UTC
channelUuidsstring[]Optional

A list of all channelUuids in the report, comma separated.

tagsNamestring[]Optional

A list of all tagsName in the report, comma separated.

sampleSizeinteger · int32Optional

Capping ammount of items to be used in the report.

reportTypestring · enumOptional

The report sorting type

Possible values:
filterFieldstringOptional

Optional filter field name being queried at the page currently.

filterTermstringOptional

Optional filter field value being queried at the page currently.

previousStartDatestring · date-timeOptional
previousEndDatestring · date-timeOptional
Responses
200
Ok
400
Bad Request
*/*
401
Unauthorized
*/*
403
Forbidden
*/*
404
Not Found
*/*
409
Conflict
*/*
422
Unprocessable Entity
*/*
500
Internal Server Error
*/*
post
POST /org/{orgUUID}/env/{envUUID}/bot/{botUUID}/messages/request_report HTTP/1.1
Host: 
Content-Type: application/json
Accept: */*
Content-Length: 359

{
  "startDate": "2025-05-09T12:14:45.315Z",
  "endDate": "2025-05-09T12:14:45.315Z",
  "startHour": 1,
  "endHour": 1,
  "timezone": "text",
  "channelUuids": [
    "text"
  ],
  "tagsName": [
    "text"
  ],
  "sampleSize": 1,
  "reportType": "RANDOM",
  "filterField": "text",
  "filterTerm": "text",
  "funnelTags": [
    [
      "text"
    ]
  ],
  "previousStartDate": "2025-05-09T12:14:45.315Z",
  "previousEndDate": "2025-05-09T12:14:45.315Z"
}

No content

Previews the available report sample size, returning the estimate ammount of items that will be present in a report.

post
Path parameters
orgUUIDstringRequired

A valid uuid of an organization

envUUIDstringRequired

A valid uuid of an environment

botUUIDstringRequired

The UUID of the bot whose conversations you are searching

Body

Body containing the properties to use in this report

startDatestring · date-timeOptional

Starting date of the report range, including itself, in ISO-8601 format (yyyy-MM-dd'T'HH:mm:ss.SSS'Z')

endDatestring · date-timeOptional

Ending date of the report range, including itself, in ISO-8601 format (yyyy-MM-dd'T'HH:mm:ss.SSS'Z')

startHourinteger · int32Optional

Starting hour of the report range, from 0 to 23. Hour sent is included in the report.

endHourinteger · int32Optional

Ending hour of the report range, from 0 to 23. Hour sent is included in the report.

channelUuidsstringOptional

A list of all channelUuids in the report, comma separated.

sampleSizeinteger · int32Optional

Capping ammount of items to be used in the report.

confidenceLevelinteger · int32Optional

Minimal confidence level in the report results, simulating response to a configuration in the parameters screen.

errorMargininteger · int32Optional

An error margin into the confidence level, allowing for variance.

filterFieldstringOptional

Optional filter field name being queried at the page currently.

filterTermstringOptional

Optional filter field value being queried at the page currently.

Responses
200
Ok
application/json
400
Bad Request
*/*
401
Unauthorized
*/*
403
Forbidden
*/*
404
Not Found
*/*
409
Conflict
*/*
422
Unprocessable Entity
*/*
500
Internal Server Error
*/*
post
POST /org/{orgUUID}/env/{envUUID}/bot/{botUUID}/messages/request_sample HTTP/1.1
Host: 
Content-Type: application/json
Accept: */*
Content-Length: 217

{
  "startDate": "2025-05-09T12:14:45.315Z",
  "endDate": "2025-05-09T12:14:45.315Z",
  "startHour": 1,
  "endHour": 1,
  "channelUuids": "text",
  "sampleSize": 1,
  "confidenceLevel": 1,
  "errorMargin": 1,
  "filterField": "text",
  "filterTerm": "text"
}
{
  "sampleSize": 1
}