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

application/json

A summary of the data availability for this dashboard and it's configurations

hasDatabooleanOptional

Channel's uuid

firstDataSetstring · date-timeOptional

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

400

Bad Request

*/*

401

Unauthorized

*/*

403

Forbidden

*/*

404

Not Found

*/*

409

Conflict

*/*

422

Unprocessable Entity

*/*

500

Internal Server Error

*/*

get

/org/{orgUUID}/env/{envUUID}/bot/{botUUID}/dashboard/summary

GET /org/{orgUUID}/env/{envUUID}/bot/{botUUID}/dashboard/summary HTTP/1.1
Accept: */*

{
  "hasData": true,
  "firstDataSet": "2026-04-02T06:28:04.816Z"
}

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

application/json

Object containing rules to limit parameters in a report page.

maxSampleinteger · int32Optional

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

availableExportTypesstring[]Optional

List of available REPORT_TYPEs to be presented for this resource

400

Bad Request

*/*

401

Unauthorized

*/*

403

Forbidden

*/*

404

Not Found

*/*

409

Conflict

*/*

422

Unprocessable Entity

*/*

500

Internal Server Error

*/*

get

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

GET /org/{orgUUID}/env/{envUUID}/bot/{botUUID}/conversations/report_configurations HTTP/1.1
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

application/json

Object containing rules to limit parameters in a report page.

maxSampleinteger · int32Optional

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

availableExportTypesstring[]Optional

List of available REPORT_TYPEs to be presented for this resource

400

Bad Request

*/*

401

Unauthorized

*/*

403

Forbidden

*/*

404

Not Found

*/*

409

Conflict

*/*

422

Unprocessable Entity

*/*

500

Internal Server Error

*/*

get

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

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

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

application/json

Main respose structure. This DTO specifies which resource was queried, has an overview for a total box, and a by-channel breakdown

resourcestring · enumOptional

The kind of resource found in this object.

Possible values:

400

Bad Request

*/*

401

Unauthorized

*/*

403

Forbidden

*/*

404

Not Found

*/*

409

Conflict

*/*

422

Unprocessable Entity

*/*

500

Internal Server Error

*/*

post

/org/{orgUUID}/env/{envUUID}/bot/{botUUID}/dashboard/conversations

POST /org/{orgUUID}/env/{envUUID}/bot/{botUUID}/dashboard/conversations HTTP/1.1
Content-Type: application/json
Accept: */*
Content-Length: 256

{
  "startDate": "2026-04-02T06:28:04.816Z",
  "endDate": "2026-04-02T06:28:04.816Z",
  "startHour": 1,
  "endHour": 1,
  "timezone": "UTC",
  "channelUUIDs": [
    "text"
  ],
  "tagsName": [
    "text"
  ],
  "previousStartDate": "2026-04-02T06:28:04.816Z",
  "previousEndDate": "2026-04-02T06:28:04.816Z"
}

{
  "resource": "ANALYTIC_CONVERSATION",
  "periodOverview": {
    "totalAmount": 1,
    "hasRelativeData": true,
    "relativeIncrease": 1,
    "hasIncreased": true,
    "relativeStartDate": "2026-04-02T06:28:04.816Z",
    "relativeEndDate": "2026-04-02T06:28:04.816Z"
  },
  "channelAnalytics": [
    {
      "channelType": "text",
      "channelName": "text",
      "hours": [
        {
          "date": "2026-04-02T06:28:04.816Z",
          "value": 1
        }
      ],
      "days": [
        {
          "date": "2026-04-02T06:28:04.816Z",
          "value": 1
        }
      ],
      "weeks": [
        {
          "monthDate": "2026-04-02T06:28:04.816Z",
          "weekNumber": 1,
          "value": 1
        }
      ],
      "months": [
        {
          "date": "2026-04-02T06:28:04.816Z",
          "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

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

application/json

Main respose structure. This DTO specifies which resource was queried, has an overview for a total box, and a generic traffic breakdown

resourcestring · enumOptional

The kind of resource found in this object.

Possible values:

400

Bad Request

*/*

401

Unauthorized

*/*

403

Forbidden

*/*

404

Not Found

*/*

409

Conflict

*/*

422

Unprocessable Entity

*/*

500

Internal Server Error

*/*

post

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

POST /org/{orgUUID}/env/{envUUID}/bot/{botUUID}/dashboard/messages HTTP/1.1
Content-Type: application/json
Accept: */*
Content-Length: 256

{
  "startDate": "2026-04-02T06:28:04.816Z",
  "endDate": "2026-04-02T06:28:04.816Z",
  "startHour": 1,
  "endHour": 1,
  "timezone": "UTC",
  "channelUUIDs": [
    "text"
  ],
  "tagsName": [
    "text"
  ],
  "previousStartDate": "2026-04-02T06:28:04.816Z",
  "previousEndDate": "2026-04-02T06:28:04.816Z"
}

{
  "resource": "ANALYTIC_CONVERSATION",
  "periodOverview": {
    "totalAmount": 1,
    "hasRelativeData": true,
    "relativeIncrease": 1,
    "hasIncreased": true,
    "relativeStartDate": "2026-04-02T06:28:04.816Z",
    "relativeEndDate": "2026-04-02T06:28:04.816Z"
  },
  "trafficAnalyticsDTO": {
    "hours": [
      {
        "date": "2026-04-02T06:28:04.816Z",
        "value": 1
      }
    ],
    "days": [
      {
        "date": "2026-04-02T06:28:04.816Z",
        "value": 1
      }
    ],
    "weeks": [
      {
        "monthDate": "2026-04-02T06:28:04.816Z",
        "weekNumber": 1,
        "value": 1
      }
    ],
    "months": [
      {
        "date": "2026-04-02T06:28:04.816Z",
        "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

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

application/json

Main respose structure. This DTO specifies which resource was queried, has an overview for a total box, and a generic traffic breakdown

resourcestring · enumOptional

The kind of resource found in this object.

Possible values:

400

Bad Request

*/*

401

Unauthorized

*/*

403

Forbidden

*/*

404

Not Found

*/*

409

Conflict

*/*

422

Unprocessable Entity

*/*

500

Internal Server Error

*/*

post

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

POST /org/{orgUUID}/env/{envUUID}/bot/{botUUID}/dashboard/users HTTP/1.1
Content-Type: application/json
Accept: */*
Content-Length: 256

{
  "startDate": "2026-04-02T06:28:04.816Z",
  "endDate": "2026-04-02T06:28:04.816Z",
  "startHour": 1,
  "endHour": 1,
  "timezone": "UTC",
  "channelUUIDs": [
    "text"
  ],
  "tagsName": [
    "text"
  ],
  "previousStartDate": "2026-04-02T06:28:04.816Z",
  "previousEndDate": "2026-04-02T06:28:04.816Z"
}

{
  "resource": "ANALYTIC_CONVERSATION",
  "periodOverview": {
    "totalAmount": 1,
    "hasRelativeData": true,
    "relativeIncrease": 1,
    "hasIncreased": true,
    "relativeStartDate": "2026-04-02T06:28:04.816Z",
    "relativeEndDate": "2026-04-02T06:28:04.816Z"
  },
  "trafficAnalyticsDTO": {
    "hours": [
      {
        "date": "2026-04-02T06:28:04.816Z",
        "value": 1
      }
    ],
    "days": [
      {
        "date": "2026-04-02T06:28:04.816Z",
        "value": 1
      }
    ],
    "weeks": [
      {
        "monthDate": "2026-04-02T06:28:04.816Z",
        "weekNumber": 1,
        "value": 1
      }
    ],
    "months": [
      {
        "date": "2026-04-02T06:28:04.816Z",
        "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

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

application/json

Contains the accuracy of a bot analytics statistics and it's relative increase.

rateCurrentnumberOptional

This period's accuracy.

ratePreviousnumberOptional

The previous same-sized period's accuracy.

hasIncreasedbooleanOptional

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

relativeIncreasenumberOptional

A % increase range when comparing the previous period.

relativeStartDatestring · date-timeOptional

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

relativeEndDatestring · date-timeOptional

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

400

Bad Request

*/*

401

Unauthorized

*/*

403

Forbidden

*/*

404

Not Found

*/*

409

Conflict

*/*

422

Unprocessable Entity

*/*

500

Internal Server Error

*/*

post

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

POST /org/{orgUUID}/env/{envUUID}/bot/{botUUID}/dashboard/accuracy HTTP/1.1
Content-Type: application/json
Accept: */*
Content-Length: 256

{
  "startDate": "2026-04-02T06:28:04.816Z",
  "endDate": "2026-04-02T06:28:04.816Z",
  "startHour": 1,
  "endHour": 1,
  "timezone": "UTC",
  "channelUUIDs": [
    "text"
  ],
  "tagsName": [
    "text"
  ],
  "previousStartDate": "2026-04-02T06:28:04.816Z",
  "previousEndDate": "2026-04-02T06:28:04.816Z"
}

{
  "rateCurrent": 1,
  "ratePrevious": 1,
  "hasIncreased": true,
  "relativeIncrease": 1,
  "relativeStartDate": "2026-04-02T06:28:04.816Z",
  "relativeEndDate": "2026-04-02T06:28:04.816Z"
}

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

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

application/json

Main respose structure. This DTO brings a list of channel and their datasets for a queried topic for a stacked line graph.

resourcestring · enumOptional

Name of the queried resource.

Possible values:

400

Bad Request

*/*

401

Unauthorized

*/*

403

Forbidden

*/*

404

Not Found

*/*

409

Conflict

*/*

422

Unprocessable Entity

*/*

500

Internal Server Error

*/*

post

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

POST /org/{orgUUID}/env/{envUUID}/bot/{botUUID}/dashboard/stacking/intents HTTP/1.1
Content-Type: application/json
Accept: */*
Content-Length: 256

{
  "startDate": "2026-04-02T06:28:04.816Z",
  "endDate": "2026-04-02T06:28:04.816Z",
  "startHour": 1,
  "endHour": 1,
  "timezone": "UTC",
  "channelUUIDs": [
    "text"
  ],
  "tagsName": [
    "text"
  ],
  "previousStartDate": "2026-04-02T06:28:04.816Z",
  "previousEndDate": "2026-04-02T06:28:04.816Z"
}

{
  "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

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

application/json

Main respose structure. This DTO brings a list of channel and their datasets for a queried topic for a stacked line graph.

resourcestring · enumOptional

Name of the queried resource.

Possible values:

400

Bad Request

*/*

401

Unauthorized

*/*

403

Forbidden

*/*

404

Not Found

*/*

409

Conflict

*/*

422

Unprocessable Entity

*/*

500

Internal Server Error

*/*

post

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

POST /org/{orgUUID}/env/{envUUID}/bot/{botUUID}/dashboard/stacking/flows HTTP/1.1
Content-Type: application/json
Accept: */*
Content-Length: 256

{
  "startDate": "2026-04-02T06:28:04.816Z",
  "endDate": "2026-04-02T06:28:04.816Z",
  "startHour": 1,
  "endHour": 1,
  "timezone": "UTC",
  "channelUUIDs": [
    "text"
  ],
  "tagsName": [
    "text"
  ],
  "previousStartDate": "2026-04-02T06:28:04.816Z",
  "previousEndDate": "2026-04-02T06:28:04.816Z"
}

{
  "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

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

application/json

Main respose structure. This DTO brings a list of channel and their datasets for a queried topic for a stacked line graph.

resourcestring · enumOptional

Name of the queried resource.

Possible values:

400

Bad Request

*/*

401

Unauthorized

*/*

403

Forbidden

*/*

404

Not Found

*/*

409

Conflict

*/*

422

Unprocessable Entity

*/*

500

Internal Server Error

*/*

post

/org/{orgUUID}/env/{envUUID}/bot/{botUUID}/dashboard/stacking/abandonments

POST /org/{orgUUID}/env/{envUUID}/bot/{botUUID}/dashboard/stacking/abandonments HTTP/1.1
Content-Type: application/json
Accept: */*
Content-Length: 256

{
  "startDate": "2026-04-02T06:28:04.816Z",
  "endDate": "2026-04-02T06:28:04.816Z",
  "startHour": 1,
  "endHour": 1,
  "timezone": "UTC",
  "channelUUIDs": [
    "text"
  ],
  "tagsName": [
    "text"
  ],
  "previousStartDate": "2026-04-02T06:28:04.816Z",
  "previousEndDate": "2026-04-02T06:28:04.816Z"
}

{
  "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.

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

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

application/json

totalPagesinteger · int32Optional

totalElementsinteger · int64Optional

numberOfElementsinteger · int32Optional

sizeinteger · int32Optional

numberinteger · int32Optional

firstbooleanOptional

lastbooleanOptional

emptybooleanOptional

400

Bad Request

*/*

401

Unauthorized

*/*

403

Forbidden

*/*

404

Not Found

*/*

409

Conflict

*/*

422

Unprocessable Entity

*/*

500

Internal Server Error

*/*

post

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

POST /org/{orgUUID}/env/{envUUID}/bot/{botUUID}/conversations/list HTTP/1.1
Content-Type: application/json
Accept: */*
Content-Length: 387

{
  "startDate": "2026-04-02T06:28:04.816Z",
  "endDate": "2026-04-02T06:28:04.816Z",
  "startHour": 1,
  "endHour": 1,
  "timezone": "UTC",
  "channelUUIDs": [
    "text"
  ],
  "tagsName": [
    "text"
  ],
  "searchBy": "text",
  "searchTerm": "text",
  "page": 1,
  "size": 1,
  "orderBy": "text",
  "direction": "text",
  "funnelTags": [
    [
      "text"
    ]
  ],
  "nonTags": true,
  "previousStartDate": "2026-04-02T06:28:04.816Z",
  "previousEndDate": "2026-04-02T06:28:04.816Z"
}

{
  "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

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

No content

400

Bad Request

*/*

401

Unauthorized

*/*

403

Forbidden

*/*

404

Not Found

*/*

409

Conflict

*/*

422

Unprocessable Entity

*/*

500

Internal Server Error

*/*

post

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

POST /org/{orgUUID}/env/{envUUID}/bot/{botUUID}/conversations/request_report HTTP/1.1
Content-Type: application/json
Accept: */*
Content-Length: 358

{
  "startDate": "2026-04-02T06:28:04.816Z",
  "endDate": "2026-04-02T06:28:04.816Z",
  "startHour": 1,
  "endHour": 1,
  "timezone": "UTC",
  "channelUuids": [
    "text"
  ],
  "tagsName": [
    "text"
  ],
  "sampleSize": 1,
  "reportType": "RANDOM",
  "filterField": "text",
  "filterTerm": "text",
  "funnelTags": [
    [
      "text"
    ]
  ],
  "previousStartDate": "2026-04-02T06:28:04.816Z",
  "previousEndDate": "2026-04-02T06:28:04.816Z"
}

No content

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

application/json

Data structure of a performed message in a Conversation.

sessionCodestringOptional

Session code of this conversation in ISO

startedAtstringOptional

Date said conversation started

400

Bad Request

*/*

401

Unauthorized

*/*

403

Forbidden

*/*

404

Not Found

*/*

409

Conflict

*/*

422

Unprocessable Entity

*/*

500

Internal Server Error

*/*

get

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

GET /org/{orgUUID}/env/{envUUID}/bot/{botUUID}/conversations/details?sessionCode=text HTTP/1.1
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

Default: UTC

Responses

200

No content

400

Bad Request

*/*

401

Unauthorized

*/*

403

Forbidden

*/*

404

Not Found

*/*

409

Conflict

*/*

422

Unprocessable Entity

*/*

500

Internal Server Error

*/*

post

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

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

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

application/json

Object containing an estimate value of a report.

sampleSizeinteger · int32Optional

Estimate ammount of items obtained in the report filters.

400

Bad Request

*/*

401

Unauthorized

*/*

403

Forbidden

*/*

404

Not Found

*/*

409

Conflict

*/*

422

Unprocessable Entity

*/*

500

Internal Server Error

*/*

post

/org/{orgUUID}/env/{envUUID}/bot/{botUUID}/conversations/request_sample

POST /org/{orgUUID}/env/{envUUID}/bot/{botUUID}/conversations/request_sample HTTP/1.1
Content-Type: application/json
Accept: */*
Content-Length: 217

{
  "startDate": "2026-04-02T06:28:04.816Z",
  "endDate": "2026-04-02T06:28:04.816Z",
  "startHour": 1,
  "endHour": 1,
  "channelUuids": "text",
  "sampleSize": 1,
  "confidenceLevel": 1,
  "errorMargin": 1,
  "filterField": "text",
  "filterTerm": "text"
}

{
  "sampleSize": 1
}

Messages

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

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

application/json

totalPagesinteger · int32Optional

totalElementsinteger · int64Optional

numberOfElementsinteger · int32Optional

sizeinteger · int32Optional

numberinteger · int32Optional

firstbooleanOptional

lastbooleanOptional

emptybooleanOptional

400

Bad Request

*/*

401

Unauthorized

*/*

403

Forbidden

*/*

404

Not Found

*/*

409

Conflict

*/*

422

Unprocessable Entity

*/*

500

Internal Server Error

*/*

post

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

POST /org/{orgUUID}/env/{envUUID}/bot/{botUUID}/messages/list HTTP/1.1
Content-Type: application/json
Accept: */*
Content-Length: 409

{
  "startDate": "2026-04-02T06:28:04.816Z",
  "endDate": "2026-04-02T06:28:04.816Z",
  "startHour": 1,
  "endHour": 1,
  "timezone": "UTC",
  "channelUUIDs": [
    "text"
  ],
  "tagsName": [
    "text"
  ],
  "searchBy": "text",
  "searchTerm": "text",
  "page": 1,
  "size": 1,
  "orderBy": "text",
  "direction": "text",
  "funnelTags": [
    [
      "text"
    ]
  ],
  "nonTags": true,
  "nlpResponses": "text",
  "previousStartDate": "2026-04-02T06:28:04.816Z",
  "previousEndDate": "2026-04-02T06:28:04.816Z"
}

{
  "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

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

No content

400

Bad Request

*/*

401

Unauthorized

*/*

403

Forbidden

*/*

404

Not Found

*/*

409

Conflict

*/*

422

Unprocessable Entity

*/*

500

Internal Server Error

*/*

post

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

POST /org/{orgUUID}/env/{envUUID}/bot/{botUUID}/messages/request_report HTTP/1.1
Content-Type: application/json
Accept: */*
Content-Length: 358

{
  "startDate": "2026-04-02T06:28:04.816Z",
  "endDate": "2026-04-02T06:28:04.816Z",
  "startHour": 1,
  "endHour": 1,
  "timezone": "UTC",
  "channelUuids": [
    "text"
  ],
  "tagsName": [
    "text"
  ],
  "sampleSize": 1,
  "reportType": "RANDOM",
  "filterField": "text",
  "filterTerm": "text",
  "funnelTags": [
    [
      "text"
    ]
  ],
  "previousStartDate": "2026-04-02T06:28:04.816Z",
  "previousEndDate": "2026-04-02T06:28:04.816Z"
}

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

application/json

Object containing an estimate value of a report.

sampleSizeinteger · int32Optional

Estimate ammount of items obtained in the report filters.

400

Bad Request

*/*

401

Unauthorized

*/*

403

Forbidden

*/*

404

Not Found

*/*

409

Conflict

*/*

422

Unprocessable Entity

*/*

500

Internal Server Error

*/*

post

/org/{orgUUID}/env/{envUUID}/bot/{botUUID}/messages/request_sample

POST /org/{orgUUID}/env/{envUUID}/bot/{botUUID}/messages/request_sample HTTP/1.1
Content-Type: application/json
Accept: */*
Content-Length: 217

{
  "startDate": "2026-04-02T06:28:04.816Z",
  "endDate": "2026-04-02T06:28:04.816Z",
  "startHour": 1,
  "endHour": 1,
  "channelUuids": "text",
  "sampleSize": 1,
  "confidenceLevel": 1,
  "errorMargin": 1,
  "filterField": "text",
  "filterTerm": "text"
}

{
  "sampleSize": 1
}

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

application/json

totalPagesinteger · int32Optional

totalElementsinteger · int64Optional

numberOfElementsinteger · int32Optional

sizeinteger · int32Optional

numberinteger · int32Optional

firstbooleanOptional

lastbooleanOptional

emptybooleanOptional

400

Bad Request

*/*

401

Unauthorized

*/*

403

Forbidden

*/*

404

Not Found

*/*

409

Conflict

*/*

422

Unprocessable Entity

*/*

500

Internal Server Error

*/*

get

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

GET /org/{orgUUID}/env/{envUUID}/bot/{botUUID}/reports/list?page=1&size=5 HTTP/1.1
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
}

PreviousChannel NextDialog Manager

Last updated 1 year ago

Was this helpful?

hashtagAuxiliary Methods

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

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

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

hashtagData Analytics

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

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

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

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

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

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

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

hashtagConversations

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

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

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

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

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

hashtagMessages

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

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

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

hashtagReports

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

Auxiliary Methods

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

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

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

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.

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

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

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

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

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

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

Conversations

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

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

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

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

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

Messages

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

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

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

Reports

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