Dashboard

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

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.

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
get
GET /org/{orgUUID}/env/{envUUID}/bot/{botUUID}/dashboard/summary HTTP/1.1
Host: 
Accept: */*
{
  "hasData": true,
  "firstDataSet": "2025-07-01T01:40:56.538Z"
}

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
get
GET /org/{orgUUID}/env/{envUUID}/bot/{botUUID}/messages/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
get
GET /org/{orgUUID}/env/{envUUID}/bot/{botUUID}/conversations/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.

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

Query parameters
channelUUIDsstringOptional

A comma-separated String containing ALL channelUuids to filter. If empty, all are used instead.

Default: ""
startDatestringRequired

Date this search starts at, including itself, at ISO format.

endDatestringRequired

Date this search ends at, including itself, at ISO format.

startHourinteger · int32Required

Interval being searched starting hour. Value is 0 if unfiltered.

Default: 0
endHourinteger · int32Required

Interval being searched ending hour. Value is 23 if unfiltered.

Default: 23
Responses
200
Ok
application/json
get
GET /org/{orgUUID}/env/{envUUID}/bot/{botUUID}/dashboard/conversations?startDate=text&endDate=text&startHour=0&endHour=23 HTTP/1.1
Host: 
Accept: */*
{
  "resource": "ANALYTIC_CONVERSATION",
  "periodOverview": {
    "totalAmount": 1,
    "hasRelativeData": true,
    "relativeIncrease": 1,
    "hasIncreased": true,
    "relativeStartDate": "2025-07-01T01:40:56.538Z",
    "relativeEndDate": "2025-07-01T01:40:56.538Z"
  },
  "channelAnalytics": [
    {
      "channelType": "text",
      "channelName": "text",
      "hours": [
        {
          "date": "2025-07-01T01:40:56.538Z",
          "value": 1
        }
      ],
      "days": [
        {
          "date": "2025-07-01T01:40:56.538Z",
          "value": 1
        }
      ],
      "weeks": [
        {
          "monthDate": "2025-07-01T01:40:56.538Z",
          "weekNumber": 1,
          "value": 1
        }
      ],
      "months": [
        {
          "date": "2025-07-01T01:40:56.538Z",
          "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.

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

Query parameters
channelUUIDsstringOptional

A comma-separated String containing ALL channelUuids to filter. If empty, all are used instead.

Default: ""
startDatestringRequired

Date this search starts at, including itself, at ISO format.

endDatestringRequired

Date this search ends at, including itself, at ISO format.

startHourinteger · int32Required

Interval being searched starting hour. Value is 0 if unfiltered.

Default: 0
endHourinteger · int32Required

Interval being searched ending hour. Value is 23 if unfiltered.

Default: 23
Responses
200
Ok
application/json
get
GET /org/{orgUUID}/env/{envUUID}/bot/{botUUID}/dashboard/messages?startDate=text&endDate=text&startHour=0&endHour=23 HTTP/1.1
Host: 
Accept: */*
{
  "resource": "ANALYTIC_CONVERSATION",
  "periodOverview": {
    "totalAmount": 1,
    "hasRelativeData": true,
    "relativeIncrease": 1,
    "hasIncreased": true,
    "relativeStartDate": "2025-07-01T01:40:56.538Z",
    "relativeEndDate": "2025-07-01T01:40:56.538Z"
  },
  "trafficAnalyticsDTO": {
    "hours": [
      {
        "date": "2025-07-01T01:40:56.538Z",
        "value": 1
      }
    ],
    "days": [
      {
        "date": "2025-07-01T01:40:56.538Z",
        "value": 1
      }
    ],
    "weeks": [
      {
        "monthDate": "2025-07-01T01:40:56.538Z",
        "weekNumber": 1,
        "value": 1
      }
    ],
    "months": [
      {
        "date": "2025-07-01T01:40:56.538Z",
        "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.

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

Query parameters
channelUUIDsstringOptional

A comma-separated String containing ALL channelUuids to filter. If empty, all are used instead.

Default: ""
startDatestringRequired

Date this search starts at, including itself, at ISO format.

endDatestringRequired

Date this search ends at, including itself, at ISO format.

startHourinteger · int32Required

Interval being searched starting hour. Value is 0 if unfiltered.

Default: 0
endHourinteger · int32Required

Interval being searched ending hour. Value is 23 if unfiltered.

Default: 23
Responses
200
Ok
application/json
get
GET /org/{orgUUID}/env/{envUUID}/bot/{botUUID}/dashboard/users?startDate=text&endDate=text&startHour=0&endHour=23 HTTP/1.1
Host: 
Accept: */*
{
  "resource": "ANALYTIC_CONVERSATION",
  "periodOverview": {
    "totalAmount": 1,
    "hasRelativeData": true,
    "relativeIncrease": 1,
    "hasIncreased": true,
    "relativeStartDate": "2025-07-01T01:40:56.538Z",
    "relativeEndDate": "2025-07-01T01:40:56.538Z"
  },
  "trafficAnalyticsDTO": {
    "hours": [
      {
        "date": "2025-07-01T01:40:56.538Z",
        "value": 1
      }
    ],
    "days": [
      {
        "date": "2025-07-01T01:40:56.538Z",
        "value": 1
      }
    ],
    "weeks": [
      {
        "monthDate": "2025-07-01T01:40:56.538Z",
        "weekNumber": 1,
        "value": 1
      }
    ],
    "months": [
      {
        "date": "2025-07-01T01:40:56.538Z",
        "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.

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

Query parameters
channelUUIDsstringOptional

A comma-separated String containing ALL channelUuids to filter. If empty, all are used instead.

Default: ""
startDatestringRequired

Date this search starts at, including itself, at ISO format.

endDatestringRequired

Date this search ends at, including itself, at ISO format.

startHourinteger · int32Required

Interval being searched starting hour. Value is 0 if unfiltered.

Default: 0
endHourinteger · int32Required

Interval being searched ending hour. Value is 23 if unfiltered.

Default: 23
Responses
200
Ok
application/json
get
GET /org/{orgUUID}/env/{envUUID}/bot/{botUUID}/dashboard/accuracy?startDate=text&endDate=text&startHour=0&endHour=23 HTTP/1.1
Host: 
Accept: */*
{
  "rateCurrent": 1,
  "ratePrevious": 1,
  "hasIncreased": true,
  "relativeIncrease": 1,
  "relativeStartDate": "2025-07-01T01:40:56.538Z",
  "relativeEndDate": "2025-07-01T01:40:56.538Z"
}

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

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

Query parameters
channelUUIDsstringOptional

A comma-separated String containing ALL channelUuids to filter. If empty, all are used instead.

Default: ""
startDatestringRequired

Date this search starts at, including itself, at ISO format.

endDatestringRequired

Date this search ends at, including itself, at ISO format.

startHourinteger · int32Required

Interval being searched starting hour. Value is 0 if unfiltered.

Default: 0
endHourinteger · int32Required

Interval being searched ending hour. Value is 23 if unfiltered.

Default: 23
Responses
200
Ok
application/json
get
GET /org/{orgUUID}/env/{envUUID}/bot/{botUUID}/dashboard/stacking/intents?startDate=text&endDate=text&startHour=0&endHour=23 HTTP/1.1
Host: 
Accept: */*
{
  "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.

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
startDatestringRequired

Date this search starts at, including itself, at ISO format.

endDatestringRequired

Date this search ends at, including itself, at ISO format.

startHourinteger · int32Required

Interval being searched starting hour. Value is 0 if unfiltered.

Default: 0
endHourinteger · int32Required

Interval being searched ending hour. Value is 23 if unfiltered.

Default: 23
channelUUIDsstringOptional

A comma-separated String containing ALL channelUuids to filter. If empty, all are used instead.

Default: ""
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 · int32Required

Current page, starting at 1

Default: 1Example: 1
sizeinteger · int32Required

Size of the page

Default: 5Example: 1
orderBystringOptional

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

Default: conversationStartedAt
directionstringOptional

Order direction(ASC/DESC), defaulted to DESC

Default: DESC
Responses
200
Ok
application/json
get
GET /org/{orgUUID}/env/{envUUID}/bot/{botUUID}/conversations/list?startDate=text&endDate=text&startHour=0&endHour=23&page=1&size=5 HTTP/1.1
Host: 
Accept: */*
{
  "totalPages": 1,
  "totalElements": 1,
  "pageable": {
    "pageNumber": 1,
    "pageSize": 1,
    "paged": true,
    "unpaged": true,
    "sort": {
      "sorted": true,
      "unsorted": true,
      "empty": true
    },
    "offset": 1
  },
  "numberOfElements": 1,
  "first": true,
  "last": true,
  "sort": {
    "sorted": true,
    "unsorted": true,
    "empty": true
  },
  "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",
          "image": "text",
          "channelClassification": {
            "id": 1,
            "name": "text"
          }
        }
      },
      "tags": [
        "text"
      ]
    }
  ],
  "number": 1,
  "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-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.

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.

Responses
200
Ok
post
POST /org/{orgUUID}/env/{envUUID}/bot/{botUUID}/conversations/request_report HTTP/1.1
Host: 
Content-Type: application/json
Accept: */*
Content-Length: 203

{
  "startDate": "2025-07-01T01:40:56.538Z",
  "endDate": "2025-07-01T01:40:56.538Z",
  "startHour": 1,
  "endHour": 1,
  "channelUuids": "text",
  "sampleSize": 1,
  "reportType": "RANDOM",
  "filterField": "text",
  "filterTerm": "text"
}

No content

Acquires all messages executed within a specified 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
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",
      "image": "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

Responses
200
Ok
post
POST /org/{orgUUID}/env/{envUUID}/bot/{botUUID}/conversations/details/request_report?sessionCode=text HTTP/1.1
Host: 
Accept: */*

No content

Messages

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

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

Query parameters
channelUUIDsstringOptional

A comma-separated String containing ALL channelUuids to filter. If empty, all are used instead.

Default: ""
startDatestringRequired

Date this search starts at, including itself, at ISO format.

endDatestringRequired

Date this search ends at, including itself, at ISO format.

startHourinteger · int32Required

Interval being searched starting hour. Value is 0 if unfiltered.

Default: 0
endHourinteger · int32Required

Interval being searched ending hour. Value is 23 if unfiltered.

Default: 23
Responses
200
Ok
application/json
get
GET /org/{orgUUID}/env/{envUUID}/bot/{botUUID}/dashboard/stacking/flows?startDate=text&endDate=text&startHour=0&endHour=23 HTTP/1.1
Host: 
Accept: */*
{
  "resource": "ANALYTIC_INTENTS",
  "channelList": [
    {
      "name": "text",
      "topicBreakdown": [
        {
          "name": "text",
          "channelValue": 1,
          "totalValue": 1
        }
      ]
    }
  ]
}

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
startDatestringRequired

Date this search starts at, including itself, at ISO format.

endDatestringRequired

Date this search ends at, including itself, at ISO format.

startHourinteger · int32Required

Interval being searched starting hour. Value is 0 if unfiltered.

Default: 0
endHourinteger · int32Required

Interval being searched ending hour. Value is 23 if unfiltered.

Default: 23
channelUUIDsstringOptional

A comma-separated String containing ALL channelUuids to filter. If empty, all are used instead.

Default: ""
searchBystringOptional

Type of search filter being applied on this query. Possible fields are: [SESSION_CODE, INTENT, ENTITY, DOCUMENT, QUESTION]

searchTermstringOptional

Term being searched according to the searchBy filter.

pageinteger · int32Required

Current page, starting at 1

Default: 1Example: 1
sizeinteger · int32Required

Size of the page

Default: 5Example: 1
orderBystringOptional

Criteria to order result, defaulted to deliveredAt. Possible fields include confidence and deliveredAt.

Default: deliveredAt
directionstringOptional

Order direction(ASC/DESC), defaulted to DESC

Default: DESC
nlpResponsesstringOptional

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

Default: ALL
Responses
200
Ok
application/json
get
GET /org/{orgUUID}/env/{envUUID}/bot/{botUUID}/messages/list?startDate=text&endDate=text&startHour=0&endHour=23&page=1&size=5 HTTP/1.1
Host: 
Accept: */*
{
  "totalPages": 1,
  "totalElements": 1,
  "pageable": {
    "pageNumber": 1,
    "pageSize": 1,
    "paged": true,
    "unpaged": true,
    "sort": {
      "sorted": true,
      "unsorted": true,
      "empty": true
    },
    "offset": 1
  },
  "numberOfElements": 1,
  "first": true,
  "last": true,
  "sort": {
    "sorted": true,
    "unsorted": true,
    "empty": true
  },
  "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",
          "image": "text",
          "channelClassification": {
            "id": 1,
            "name": "text"
          }
        }
      },
      "tags": [
        "text"
      ]
    }
  ],
  "number": 1,
  "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-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.

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.

Responses
200
Ok
post
POST /org/{orgUUID}/env/{envUUID}/bot/{botUUID}/messages/request_report HTTP/1.1
Host: 
Content-Type: application/json
Accept: */*
Content-Length: 203

{
  "startDate": "2025-07-01T01:40:56.538Z",
  "endDate": "2025-07-01T01:40:56.538Z",
  "startHour": 1,
  "endHour": 1,
  "channelUuids": "text",
  "sampleSize": 1,
  "reportType": "RANDOM",
  "filterField": "text",
  "filterTerm": "text"
}

No content

Reports

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
get
GET /org/{orgUUID}/env/{envUUID}/bot/{botUUID}/reports/list?page=1&size=5 HTTP/1.1
Host: 
Accept: */*
{
  "totalPages": 1,
  "totalElements": 1,
  "pageable": {
    "pageNumber": 1,
    "pageSize": 1,
    "paged": true,
    "unpaged": true,
    "sort": {
      "sorted": true,
      "unsorted": true,
      "empty": true
    },
    "offset": 1
  },
  "numberOfElements": 1,
  "first": true,
  "last": true,
  "sort": {
    "sorted": true,
    "unsorted": true,
    "empty": true
  },
  "size": 1,
  "content": [
    {
      "fileName": "text",
      "createdAt": "text",
      "fileUrl": "text",
      "reportType": "GROUPED_MESSAGES"
    }
  ],
  "number": 1,
  "empty": true
}

Was this helpful?

#144: 4.5 - Gen AI (KAI, Rephrase, Assist) + What's New (Notifications)

Change request updated