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/org/{orgUUID}/env/{envUUID}/bot/{botUUID}/dashboard/summary

Path parameters

orgUUID*string

A valid uuid of an organization

envUUID*string

A valid uuid of an environment

botUUID*string

The UUID of the bot whose entities you are searching

Response

200403500

Ok

Body

application/json

hasDataboolean

Channel's uuid

firstDataSetstring (date-time)

The timestamp of the first data set in this bot, in ISO-8601 format (yyyy-MM-dd'T'HH:mm:ss.SSS'Z')

Request

JavaScriptCurlPython

const response = await fetch('/org/{orgUUID}/env/{envUUID}/bot/{botUUID}/dashboard/summary', {
    method: 'GET',
    headers: {},
});
const data = await response.json();

Response

200403500

{
  "hasData": false,
  "firstDataSet": "2024-11-21T09:06:22.883Z"
}

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

GET/org/{orgUUID}/env/{envUUID}/bot/{botUUID}/messages/report_configurations

Path parameters

orgUUID*string

A valid uuid of an organization

envUUID*string

A valid uuid of an environment

botUUID*string

The UUID of the bot whose conversations you are searching

Response

200403500

Ok

Body

application/json

maxSampleinteger (int32)

Maximum value to be allowed to sample in the front end for this resource.

availableExportTypesarray of string

List of available REPORT_TYPEs to be presented for this resource

Request

JavaScriptCurlPython

const response = await fetch('/org/{orgUUID}/env/{envUUID}/bot/{botUUID}/messages/report_configurations', {
    method: 'GET',
    headers: {},
});
const data = await response.json();

Response

200403500

{
  "availableExportTypes": [
    "text"
  ]
}

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

GET/org/{orgUUID}/env/{envUUID}/bot/{botUUID}/conversations/report_configurations

Path parameters

orgUUID*string

A valid uuid of an organization

envUUID*string

A valid uuid of an environment

botUUID*string

The UUID of the bot whose conversations you are searching

Response

200403500

Ok

Body

application/json

maxSampleinteger (int32)

Maximum value to be allowed to sample in the front end for this resource.

availableExportTypesarray of string

List of available REPORT_TYPEs to be presented for this resource

Request

JavaScriptCurlPython

const response = await fetch('/org/{orgUUID}/env/{envUUID}/bot/{botUUID}/conversations/report_configurations', {
    method: 'GET',
    headers: {},
});
const data = await response.json();

Response

200403500

{
  "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/org/{orgUUID}/env/{envUUID}/bot/{botUUID}/dashboard/conversations

Path parameters

orgUUID*string

A valid uuid of an organization

envUUID*string

A valid uuid of an environment

botUUID*string

The UUID of the bot whose entities you are searching

Query parameters

Response

200403500

Ok

Body

application/json

resourceAnalyticType (enum)

The kind of resource found in this object.

ANALYTIC_CONVERSATIONANALYTIC_MESSAGESANALYTIC_USERS

periodOverviewPeriodOverviewDTO (object)

An aggregation of all usage data within a period of time, this is meant for the 'total' box in a dashboard.

channelAnalyticsarray of ChannelAnalyticsDTO (object)

A by-channel data breakdown.

Request

JavaScriptCurlPython

const response = await fetch('/org/{orgUUID}/env/{envUUID}/bot/{botUUID}/dashboard/conversations?startDate=text&endDate=text', {
    method: 'GET',
    headers: {},
});
const data = await response.json();

Response

200403500

{
  "resource": "ANALYTIC_CONVERSATION",
  "periodOverview": {
    "hasRelativeData": false,
    "relativeIncrease": 0,
    "hasIncreased": false,
    "relativeStartDate": "2024-11-21T09:06:22.883Z",
    "relativeEndDate": "2024-11-21T09:06:22.883Z"
  },
  "channelAnalytics": [
    {
      "channelType": "text",
      "channelName": "text",
      "hours": [
        {
          "date": "2024-11-21T09:06:22.883Z"
        }
      ],
      "days": [
        {
          "date": "2024-11-21T09:06:22.883Z"
        }
      ],
      "weeks": [
        {
          "monthDate": "2024-11-21T09:06:22.883Z"
        }
      ],
      "months": [
        {
          "date": "2024-11-21T09:06:22.883Z"
        }
      ]
    }
  ]
}

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

GET/org/{orgUUID}/env/{envUUID}/bot/{botUUID}/dashboard/messages

Path parameters

orgUUID*string

A valid uuid of an organization

envUUID*string

A valid uuid of an environment

botUUID*string

The UUID of the bot whose entities you are searching

Query parameters

Response

200403500

Ok

Body

application/json

resourceAnalyticType (enum)

The kind of resource found in this object.

ANALYTIC_CONVERSATIONANALYTIC_MESSAGESANALYTIC_USERS

periodOverviewPeriodOverviewDTO (object)

An aggregation of all usage data within a period of time, this is meant for the 'total' box in a dashboard.

trafficAnalyticsDTOTrafficAnalyticsDTO (object)

A generic, traffic describing structure, containing a time-frame breakdown and it's average value.

Request

JavaScriptCurlPython

const response = await fetch('/org/{orgUUID}/env/{envUUID}/bot/{botUUID}/dashboard/messages?startDate=text&endDate=text', {
    method: 'GET',
    headers: {},
});
const data = await response.json();

Response

200403500

{
  "resource": "ANALYTIC_CONVERSATION",
  "periodOverview": {
    "hasRelativeData": false,
    "relativeIncrease": 0,
    "hasIncreased": false,
    "relativeStartDate": "2024-11-21T09:06:22.883Z",
    "relativeEndDate": "2024-11-21T09:06:22.883Z"
  },
  "trafficAnalyticsDTO": {
    "hours": [
      {
        "date": "2024-11-21T09:06:22.883Z"
      }
    ],
    "days": [
      {
        "date": "2024-11-21T09:06:22.883Z"
      }
    ],
    "weeks": [
      {
        "monthDate": "2024-11-21T09:06:22.883Z"
      }
    ],
    "months": [
      {
        "date": "2024-11-21T09:06:22.883Z"
      }
    ],
    "averageHoursValue": 0,
    "averageDaysValue": 0,
    "averageWeeksValue": 0,
    "averageMonthsValue": 0
  }
}

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

GET/org/{orgUUID}/env/{envUUID}/bot/{botUUID}/dashboard/users

Path parameters

orgUUID*string

A valid uuid of an organization

envUUID*string

A valid uuid of an environment

botUUID*string

The UUID of the bot whose entities you are searching

Query parameters

Response

200403500

Ok

Body

application/json

resourceAnalyticType (enum)

The kind of resource found in this object.

ANALYTIC_CONVERSATIONANALYTIC_MESSAGESANALYTIC_USERS

periodOverviewPeriodOverviewDTO (object)

An aggregation of all usage data within a period of time, this is meant for the 'total' box in a dashboard.

trafficAnalyticsDTOTrafficAnalyticsDTO (object)

A generic, traffic describing structure, containing a time-frame breakdown and it's average value.

Request

JavaScriptCurlPython

const response = await fetch('/org/{orgUUID}/env/{envUUID}/bot/{botUUID}/dashboard/users?startDate=text&endDate=text', {
    method: 'GET',
    headers: {},
});
const data = await response.json();

Response

200403500

{
  "resource": "ANALYTIC_CONVERSATION",
  "periodOverview": {
    "hasRelativeData": false,
    "relativeIncrease": 0,
    "hasIncreased": false,
    "relativeStartDate": "2024-11-21T09:06:22.883Z",
    "relativeEndDate": "2024-11-21T09:06:22.883Z"
  },
  "trafficAnalyticsDTO": {
    "hours": [
      {
        "date": "2024-11-21T09:06:22.883Z"
      }
    ],
    "days": [
      {
        "date": "2024-11-21T09:06:22.883Z"
      }
    ],
    "weeks": [
      {
        "monthDate": "2024-11-21T09:06:22.883Z"
      }
    ],
    "months": [
      {
        "date": "2024-11-21T09:06:22.883Z"
      }
    ],
    "averageHoursValue": 0,
    "averageDaysValue": 0,
    "averageWeeksValue": 0,
    "averageMonthsValue": 0
  }
}

Acquires the accuracy for analytics into this bot, considering the range of dates and specified channels.

GET/org/{orgUUID}/env/{envUUID}/bot/{botUUID}/dashboard/accuracy

Path parameters

orgUUID*string

A valid uuid of an organization

envUUID*string

A valid uuid of an environment

botUUID*string

The UUID of the bot whose entities you are searching

Query parameters

Response

200403500

Ok

Body

application/json

rateCurrentnumber (float)

This period's accuracy.

ratePreviousnumber (float)

The previous same-sized period's accuracy.

hasIncreasedboolean

True, if the current rate is higher than the previous'.

relativeIncreasenumber (float)

A % increase range when comparing the previous period.

relativeStartDatestring (date-time)

Start date of the compared period of time, in ISO-8601 format (yyyy-MM-dd'T'HH:mm:ss.SSS'Z')

relativeEndDatestring (date-time)

Final date of the compared period of time, in ISO-8601 format (yyyy-MM-dd'T'HH:mm:ss.SSS'Z')

Request

JavaScriptCurlPython

const response = await fetch('/org/{orgUUID}/env/{envUUID}/bot/{botUUID}/dashboard/accuracy?startDate=text&endDate=text', {
    method: 'GET',
    headers: {},
});
const data = await response.json();

Response

200403500

{
  "rateCurrent": 0,
  "ratePrevious": 0,
  "hasIncreased": false,
  "relativeIncrease": 0,
  "relativeStartDate": "2024-11-21T09:06:22.883Z",
  "relativeEndDate": "2024-11-21T09:06:22.883Z"
}

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

GET/org/{orgUUID}/env/{envUUID}/bot/{botUUID}/dashboard/stacking/intents

Path parameters

orgUUID*string

A valid uuid of an organization

envUUID*string

A valid uuid of an environment

botUUID*string

The UUID of the bot whose entities you are searching

Query parameters

Response

200403500

Ok

Body

application/json

resourceenum

Name of the queried resource.

ANALYTIC_INTENTSANALYTIC_FLOWSANALYTIC_FLOWS_ABANDONMENTS

channelListarray of StackingChannelDTO (object)

A list of channels represented in this graph.

Request

JavaScriptCurlPython

const response = await fetch('/org/{orgUUID}/env/{envUUID}/bot/{botUUID}/dashboard/stacking/intents?startDate=text&endDate=text', {
    method: 'GET',
    headers: {},
});
const data = await response.json();

Response

200403500

{
  "resource": "ANALYTIC_INTENTS",
  "channelList": [
    {
      "name": "text",
      "topicBreakdown": [
        {
          "name": "text"
        }
      ]
    }
  ]
}

Conversations

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

GET/org/{orgUUID}/env/{envUUID}/bot/{botUUID}/conversations/list

Path parameters

orgUUID*string

A valid uuid of an organization

envUUID*string

A valid uuid of an environment

botUUID*string

The UUID of the bot whose conversations you are searching

Query parameters

Response

200403500

Ok

Body

application/json

totalPagesinteger (int32)

totalElementsinteger (int64)

pageablePageableObject (object)

numberOfElementsinteger (int32)

firstboolean

lastboolean

sortSort (object)

sizeinteger (int32)

contentarray of ConversationListDTO (object)

numberinteger (int32)

emptyboolean

Request

JavaScriptCurlPython

const response = await fetch('/org/{orgUUID}/env/{envUUID}/bot/{botUUID}/conversations/list?startDate=text&endDate=text', {
    method: 'GET',
    headers: {},
});
const data = await response.json();

Response

200403500

{
  "pageable": {
    "paged": false,
    "unpaged": false,
    "sort": {
      "sorted": false,
      "unsorted": false,
      "empty": false
    }
  },
  "first": false,
  "last": false,
  "sort": {
    "sorted": false,
    "unsorted": false,
    "empty": false
  },
  "content": [
    {
      "sessionCode": "text",
      "businessKey": "text",
      "userMessage": "text",
      "flowsTravelledNames": [
        "text"
      ],
      "conversationStartedAt": "text",
      "channel": {
        "uuid": "text",
        "botUuid": "text",
        "name": "text",
        "description": "text",
        "channelType": {
          "name": "text",
          "image": "text",
          "channelClassification": {
            "name": "text"
          }
        }
      },
      "tags": [
        "text"
      ]
    }
  ],
  "empty": false
}

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

POST/org/{orgUUID}/env/{envUUID}/bot/{botUUID}/conversations/request_report

Path parameters

orgUUID*string

A valid uuid of an organization

envUUID*string

A valid uuid of an environment

botUUID*string

The UUID of the bot whose conversations you are searching

Body

application/json

startDatestring (date-time)

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

endDatestring (date-time)

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

startHourinteger (int32)

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

endHourinteger (int32)

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

channelUuidsstring

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

sampleSizeinteger (int32)

Capping ammount of items to be used in the report.

reportTypeReportType (enum)

The report sorting type

RANDOMSEQUENTIALHIGHEST_SCORELOWEST_SCORE

filterFieldstring

Optional filter field name being queried at the page currently.

filterTermstring

Optional filter field value being queried at the page currently.

Response

200403500

Ok

Request

JavaScriptCurlPython

const response = await fetch('/org/{orgUUID}/env/{envUUID}/bot/{botUUID}/conversations/request_report', {
    method: 'POST',
    headers: {
      "Content-Type": "application/json"
    },
    body: JSON.stringify({}),
});
const data = await response.json();

Acquires all messages executed within a specified conversation.

GET/org/{orgUUID}/env/{envUUID}/bot/{botUUID}/conversations/details

Path parameters

orgUUID*string

A valid uuid of an organization

envUUID*string

A valid uuid of an environment

botUUID*string

The UUID of the bot whose conversations you are searching

Query parameters

Response

200403500

Ok

Body

application/json

sessionCodestring

Session code of this conversation in ISO

startedAtstring

Date said conversation started

channelChannelDataDTO (object)

Data returned of a channel

messagesarray of MessageBreakdownDTO (object)

A list of messages, in order of arrival.

Request

JavaScriptCurlPython

const response = await fetch('/org/{orgUUID}/env/{envUUID}/bot/{botUUID}/conversations/details?sessionCode=text', {
    method: 'GET',
    headers: {},
});
const data = await response.json();

Response

200403500

{
  "sessionCode": "text",
  "startedAt": "text",
  "channel": {
    "uuid": "text",
    "botUuid": "text",
    "name": "text",
    "description": "text",
    "channelType": {
      "name": "text",
      "image": "text",
      "channelClassification": {
        "name": "text"
      }
    }
  },
  "messages": [
    {
      "messageId": "text",
      "content": "text",
      "isNe": false,
      "intent": "text",
      "type": "CAROUSEL",
      "buttons": [
        {
          "name": "text",
          "value": "text",
          "action": "text"
        }
      ],
      "entities": [
        "text"
      ],
      "nlpResponses": [
        {
          "responseType": "INTENT",
          "responseName": "text"
        }
      ],
      "hasButton": false,
      "createdAt": "text"
    }
  ]
}

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

POST/org/{orgUUID}/env/{envUUID}/bot/{botUUID}/conversations/details/request_report

Path parameters

orgUUID*string

A valid uuid of an organization

envUUID*string

A valid uuid of an environment

botUUID*string

The UUID of the bot whose conversations you are searching

Query parameters

Response

200403500

Ok

Request

JavaScriptCurlPython

const response = await fetch('/org/{orgUUID}/env/{envUUID}/bot/{botUUID}/conversations/details/request_report?sessionCode=text', {
    method: 'POST',
    headers: {},
});
const data = await response.json();

Messages

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

GET/org/{orgUUID}/env/{envUUID}/bot/{botUUID}/dashboard/stacking/flows

Path parameters

orgUUID*string

A valid uuid of an organization

envUUID*string

A valid uuid of an environment

botUUID*string

The UUID of the bot whose entities you are searching

Query parameters

Response

200403500

Ok

Body

application/json

resourceenum

Name of the queried resource.

ANALYTIC_INTENTSANALYTIC_FLOWSANALYTIC_FLOWS_ABANDONMENTS

channelListarray of StackingChannelDTO (object)

A list of channels represented in this graph.

Request

JavaScriptCurlPython

const response = await fetch('/org/{orgUUID}/env/{envUUID}/bot/{botUUID}/dashboard/stacking/flows?startDate=text&endDate=text', {
    method: 'GET',
    headers: {},
});
const data = await response.json();

Response

200403500

{
  "resource": "ANALYTIC_INTENTS",
  "channelList": [
    {
      "name": "text",
      "topicBreakdown": [
        {
          "name": "text"
        }
      ]
    }
  ]
}

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

GET/org/{orgUUID}/env/{envUUID}/bot/{botUUID}/messages/list

Path parameters

orgUUID*string

A valid uuid of an organization

envUUID*string

A valid uuid of an environment

botUUID*string

The UUID of the bot whose messages you are searching

Query parameters

Response

200403500

Ok

Body

application/json

totalPagesinteger (int32)

totalElementsinteger (int64)

pageablePageableObject (object)

numberOfElementsinteger (int32)

firstboolean

lastboolean

sortSort (object)

sizeinteger (int32)

contentarray of MessageListDTO (object)

numberinteger (int32)

emptyboolean

Request

JavaScriptCurlPython

const response = await fetch('/org/{orgUUID}/env/{envUUID}/bot/{botUUID}/messages/list?startDate=text&endDate=text', {
    method: 'GET',
    headers: {},
});
const data = await response.json();

Response

200403500

{
  "pageable": {
    "paged": false,
    "unpaged": false,
    "sort": {
      "sorted": false,
      "unsorted": false,
      "empty": false
    }
  },
  "first": false,
  "last": false,
  "sort": {
    "sorted": false,
    "unsorted": false,
    "empty": false
  },
  "content": [
    {
      "messageId": "text",
      "messageText": "text",
      "sessionCode": "text",
      "businessKey": "text",
      "minimumConfidenceAchieved": false,
      "nlpResponses": [
        {
          "responseType": "INTENT",
          "responseName": "text"
        }
      ],
      "answerNames": [
        "text"
      ],
      "answerTexts": [
        "text"
      ],
      "answerButtons": [
        "text"
      ],
      "deliveredAt": "text",
      "channel": {
        "uuid": "text",
        "botUuid": "text",
        "name": "text",
        "description": "text",
        "channelType": {
          "name": "text",
          "image": "text",
          "channelClassification": {
            "name": "text"
          }
        }
      },
      "tags": [
        "text"
      ]
    }
  ],
  "empty": false
}

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

POST/org/{orgUUID}/env/{envUUID}/bot/{botUUID}/messages/request_report

Path parameters

orgUUID*string

A valid uuid of an organization

envUUID*string

A valid uuid of an environment

botUUID*string

The UUID of the bot whose conversations you are searching

Body

application/json

startDatestring (date-time)

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

endDatestring (date-time)

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

startHourinteger (int32)

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

endHourinteger (int32)

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

channelUuidsstring

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

sampleSizeinteger (int32)

Capping ammount of items to be used in the report.

reportTypeReportType (enum)

The report sorting type

RANDOMSEQUENTIALHIGHEST_SCORELOWEST_SCORE

filterFieldstring

Optional filter field name being queried at the page currently.

filterTermstring

Optional filter field value being queried at the page currently.

Response

200403500

Ok

Request

JavaScriptCurlPython

const response = await fetch('/org/{orgUUID}/env/{envUUID}/bot/{botUUID}/messages/request_report', {
    method: 'POST',
    headers: {
      "Content-Type": "application/json"
    },
    body: JSON.stringify({}),
});
const data = await response.json();

Reports

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

GET/org/{orgUUID}/env/{envUUID}/bot/{botUUID}/reports/list

Path parameters

orgUUID*string

A valid uuid of an organization

envUUID*string

A valid uuid of an environment

botUUID*string

The UUID of the bot whose messages you are searching

Query parameters

Response

200403500

Ok

Body

application/json

totalPagesinteger (int32)

totalElementsinteger (int64)

pageablePageableObject (object)

numberOfElementsinteger (int32)

firstboolean

lastboolean

sortSort (object)

sizeinteger (int32)

contentarray of ReportItemDTO (object)

numberinteger (int32)

emptyboolean

Request

JavaScriptCurlPython

const response = await fetch('/org/{orgUUID}/env/{envUUID}/bot/{botUUID}/reports/list', {
    method: 'GET',
    headers: {},
});
const data = await response.json();

Response

200403500

{
  "pageable": {
    "paged": false,
    "unpaged": false,
    "sort": {
      "sorted": false,
      "unsorted": false,
      "empty": false
    }
  },
  "first": false,
  "last": false,
  "sort": {
    "sorted": false,
    "unsorted": false,
    "empty": false
  },
  "content": [
    {
      "fileName": "text",
      "createdAt": "text",
      "fileUrl": "text",
      "reportType": "GROUPED_MESSAGES"
    }
  ],
  "empty": false
}