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

application/json

*/*

*/*

*/*

*/*

*/*

*/*

*/*

cURL

JavaScript

Python

HTTP

cURL

curl -L \
  --url '/org/{orgUUID}/env/{envUUID}/bot/{botUUID}/dashboard/summary'

200

400

401

403

404

409

422

500

200

{
  "hasData": true,
  "firstDataSet": "2025-03-28T10:00:49.856Z"
}

Ok

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

application/json

*/*

*/*

*/*

*/*

*/*

*/*

*/*

cURL

JavaScript

Python

HTTP

cURL

curl -L \
  --url '/org/{orgUUID}/env/{envUUID}/bot/{botUUID}/conversations/report_configurations'

200

400

401

403

404

409

422

500

200

{
  "maxSample": 1,
  "availableExportTypes": [
    "text"
  ]
}

Ok

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

application/json

*/*

*/*

*/*

*/*

*/*

*/*

*/*

cURL

JavaScript

Python

HTTP

cURL

curl -L \
  --url '/org/{orgUUID}/env/{envUUID}/bot/{botUUID}/messages/report_configurations'

200

400

401

403

404

409

422

500

200

{
  "maxSample": 1,
  "availableExportTypes": [
    "text"
  ]
}

Ok

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

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.

timezonestring · default: "UTC"optional

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.

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

application/json

*/*

*/*

*/*

*/*

*/*

*/*

*/*

cURL

JavaScript

Python

HTTP

cURL

curl -L \
  --request POST \
  --url '/org/{orgUUID}/env/{envUUID}/bot/{botUUID}/dashboard/conversations' \
  --header 'Content-Type: application/json' \
  --data '{
    "startDate": "2025-03-28T10:00:49.856Z",
    "endDate": "2025-03-28T10:00:49.856Z",
    "startHour": 1,
    "endHour": 1,
    "timezone": "text",
    "channelUUIDs": [
      "text"
    ],
    "tagsName": [
      "text"
    ],
    "previousStartDate": "2025-03-28T10:00:49.856Z",
    "previousEndDate": "2025-03-28T10:00:49.856Z"
  }'

200

400

401

403

404

409

422

500

200

{
  "resource": "ANALYTIC_CONVERSATION",
  "periodOverview": {
    "totalAmount": 1,
    "hasRelativeData": true,
    "relativeIncrease": 1,
    "hasIncreased": true,
    "relativeStartDate": "2025-03-28T10:00:49.856Z",
    "relativeEndDate": "2025-03-28T10:00:49.856Z"
  },
  "channelAnalytics": [
    {
      "channelType": "text",
      "channelName": "text",
      "hours": [
        {
          "date": "2025-03-28T10:00:49.856Z",
          "value": 1
        }
      ],
      "days": [
        {
          "date": "2025-03-28T10:00:49.856Z",
          "value": 1
        }
      ],
      "weeks": [
        {
          "monthDate": "2025-03-28T10:00:49.856Z",
          "weekNumber": 1,
          "value": 1
        }
      ],
      "months": [
        {
          "date": "2025-03-28T10:00:49.856Z",
          "value": 1
        }
      ]
    }
  ]
}

Ok

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

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.

timezonestring · default: "UTC"optional

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.

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

application/json

*/*

*/*

*/*

*/*

*/*

*/*

*/*

cURL

JavaScript

Python

HTTP

cURL

curl -L \
  --request POST \
  --url '/org/{orgUUID}/env/{envUUID}/bot/{botUUID}/dashboard/messages' \
  --header 'Content-Type: application/json' \
  --data '{
    "startDate": "2025-03-28T10:00:49.856Z",
    "endDate": "2025-03-28T10:00:49.856Z",
    "startHour": 1,
    "endHour": 1,
    "timezone": "text",
    "channelUUIDs": [
      "text"
    ],
    "tagsName": [
      "text"
    ],
    "previousStartDate": "2025-03-28T10:00:49.856Z",
    "previousEndDate": "2025-03-28T10:00:49.856Z"
  }'

200

400

401

403

404

409

422

500

200

{
  "resource": "ANALYTIC_CONVERSATION",
  "periodOverview": {
    "totalAmount": 1,
    "hasRelativeData": true,
    "relativeIncrease": 1,
    "hasIncreased": true,
    "relativeStartDate": "2025-03-28T10:00:49.856Z",
    "relativeEndDate": "2025-03-28T10:00:49.856Z"
  },
  "trafficAnalyticsDTO": {
    "hours": [
      {
        "date": "2025-03-28T10:00:49.856Z",
        "value": 1
      }
    ],
    "days": [
      {
        "date": "2025-03-28T10:00:49.856Z",
        "value": 1
      }
    ],
    "weeks": [
      {
        "monthDate": "2025-03-28T10:00:49.856Z",
        "weekNumber": 1,
        "value": 1
      }
    ],
    "months": [
      {
        "date": "2025-03-28T10:00:49.856Z",
        "value": 1
      }
    ],
    "averageHoursValue": 1,
    "averageDaysValue": 1,
    "averageWeeksValue": 1,
    "averageMonthsValue": 1
  }
}

Ok

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

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.

timezonestring · default: "UTC"optional

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.

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

application/json

*/*

*/*

*/*

*/*

*/*

*/*

*/*

cURL

JavaScript

Python

HTTP

cURL

curl -L \
  --request POST \
  --url '/org/{orgUUID}/env/{envUUID}/bot/{botUUID}/dashboard/users' \
  --header 'Content-Type: application/json' \
  --data '{
    "startDate": "2025-03-28T10:00:49.856Z",
    "endDate": "2025-03-28T10:00:49.856Z",
    "startHour": 1,
    "endHour": 1,
    "timezone": "text",
    "channelUUIDs": [
      "text"
    ],
    "tagsName": [
      "text"
    ],
    "previousStartDate": "2025-03-28T10:00:49.856Z",
    "previousEndDate": "2025-03-28T10:00:49.856Z"
  }'

200

400

401

403

404

409

422

500

200

{
  "resource": "ANALYTIC_CONVERSATION",
  "periodOverview": {
    "totalAmount": 1,
    "hasRelativeData": true,
    "relativeIncrease": 1,
    "hasIncreased": true,
    "relativeStartDate": "2025-03-28T10:00:49.856Z",
    "relativeEndDate": "2025-03-28T10:00:49.856Z"
  },
  "trafficAnalyticsDTO": {
    "hours": [
      {
        "date": "2025-03-28T10:00:49.856Z",
        "value": 1
      }
    ],
    "days": [
      {
        "date": "2025-03-28T10:00:49.856Z",
        "value": 1
      }
    ],
    "weeks": [
      {
        "monthDate": "2025-03-28T10:00:49.856Z",
        "weekNumber": 1,
        "value": 1
      }
    ],
    "months": [
      {
        "date": "2025-03-28T10:00:49.856Z",
        "value": 1
      }
    ],
    "averageHoursValue": 1,
    "averageDaysValue": 1,
    "averageWeeksValue": 1,
    "averageMonthsValue": 1
  }
}

Ok

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

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.

timezonestring · default: "UTC"optional

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.

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

application/json

*/*

*/*

*/*

*/*

*/*

*/*

*/*

cURL

JavaScript

Python

HTTP

cURL

curl -L \
  --request POST \
  --url '/org/{orgUUID}/env/{envUUID}/bot/{botUUID}/dashboard/accuracy' \
  --header 'Content-Type: application/json' \
  --data '{
    "startDate": "2025-03-28T10:00:49.856Z",
    "endDate": "2025-03-28T10:00:49.856Z",
    "startHour": 1,
    "endHour": 1,
    "timezone": "text",
    "channelUUIDs": [
      "text"
    ],
    "tagsName": [
      "text"
    ],
    "previousStartDate": "2025-03-28T10:00:49.856Z",
    "previousEndDate": "2025-03-28T10:00:49.856Z"
  }'

200

400

401

403

404

409

422

500

200

{
  "rateCurrent": 1,
  "ratePrevious": 1,
  "hasIncreased": true,
  "relativeIncrease": 1,
  "relativeStartDate": "2025-03-28T10:00:49.856Z",
  "relativeEndDate": "2025-03-28T10:00:49.856Z"
}

Ok

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

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.

timezonestring · default: "UTC"optional

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.

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

application/json

*/*

*/*

*/*

*/*

*/*

*/*

*/*

cURL

JavaScript

Python

HTTP

cURL

curl -L \
  --request POST \
  --url '/org/{orgUUID}/env/{envUUID}/bot/{botUUID}/dashboard/stacking/intents' \
  --header 'Content-Type: application/json' \
  --data '{
    "startDate": "2025-03-28T10:00:49.856Z",
    "endDate": "2025-03-28T10:00:49.856Z",
    "startHour": 1,
    "endHour": 1,
    "timezone": "text",
    "channelUUIDs": [
      "text"
    ],
    "tagsName": [
      "text"
    ],
    "previousStartDate": "2025-03-28T10:00:49.856Z",
    "previousEndDate": "2025-03-28T10:00:49.856Z"
  }'

200

400

401

403

404

409

422

500

200

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

Ok

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

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.

timezonestring · default: "UTC"optional

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.

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

application/json

*/*

*/*

*/*

*/*

*/*

*/*

*/*

cURL

JavaScript

Python

HTTP

cURL

curl -L \
  --request POST \
  --url '/org/{orgUUID}/env/{envUUID}/bot/{botUUID}/dashboard/stacking/flows' \
  --header 'Content-Type: application/json' \
  --data '{
    "startDate": "2025-03-28T10:00:49.856Z",
    "endDate": "2025-03-28T10:00:49.856Z",
    "startHour": 1,
    "endHour": 1,
    "timezone": "text",
    "channelUUIDs": [
      "text"
    ],
    "tagsName": [
      "text"
    ],
    "previousStartDate": "2025-03-28T10:00:49.856Z",
    "previousEndDate": "2025-03-28T10:00:49.856Z"
  }'

200

400

401

403

404

409

422

500

200

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

Ok

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

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.

timezonestring · default: "UTC"optional

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.

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

application/json

*/*

*/*

*/*

*/*

*/*

*/*

*/*

cURL

JavaScript

Python

HTTP

cURL

curl -L \
  --request POST \
  --url '/org/{orgUUID}/env/{envUUID}/bot/{botUUID}/dashboard/stacking/abandonments' \
  --header 'Content-Type: application/json' \
  --data '{
    "startDate": "2025-03-28T10:00:49.856Z",
    "endDate": "2025-03-28T10:00:49.856Z",
    "startHour": 1,
    "endHour": 1,
    "timezone": "text",
    "channelUUIDs": [
      "text"
    ],
    "tagsName": [
      "text"
    ],
    "previousStartDate": "2025-03-28T10:00:49.856Z",
    "previousEndDate": "2025-03-28T10:00:49.856Z"
  }'

200

400

401

403

404

409

422

500

200

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

Ok

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

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.

timezonestring · default: "UTC"optional

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.

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

funnelTagsstring[][]optional

Conditional field to filter conversations by funnel tags

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

application/json

*/*

*/*

*/*

*/*

*/*

*/*

*/*

cURL

JavaScript

Python

HTTP

cURL

curl -L \
  --request POST \
  --url '/org/{orgUUID}/env/{envUUID}/bot/{botUUID}/conversations/list' \
  --header 'Content-Type: application/json' \
  --data '{
    "startDate": "2025-03-28T10:00:49.856Z",
    "endDate": "2025-03-28T10:00:49.856Z",
    "startHour": 1,
    "endHour": 1,
    "timezone": "text",
    "channelUUIDs": [
      "text"
    ],
    "tagsName": [
      "text"
    ],
    "searchBy": "text",
    "searchTerm": "text",
    "page": 1,
    "size": 1,
    "orderBy": "text",
    "direction": "text",
    "funnelTags": [
      [
        "text"
      ]
    ],
    "nonTags": true,
    "previousStartDate": "2025-03-28T10:00:49.856Z",
    "previousEndDate": "2025-03-28T10:00:49.856Z"
  }'

200

400

401

403

404

409

422

500

200

{
  "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",
          "image": "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
}

Ok

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

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.

timezonestring · default: "UTC"optional

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.

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

Options: RANDOM, SEQUENTIAL, HIGHEST_SCORE, LOWEST_SCORE

filterFieldstringoptional

Optional filter field name being queried at the page currently.

filterTermstringoptional

Optional filter field value being queried at the page currently.

funnelTagsstring[][]optional

Optional field to filter conversations by funnel tags, you will need to pass the step tag and also those of the previous steps

previousStartDatestring · date-timeoptional

previousEndDatestring · date-timeoptional

Responses

*/*

*/*

*/*

*/*

*/*

*/*

*/*

cURL

JavaScript

Python

HTTP

cURL

curl -L \
  --request POST \
  --url '/org/{orgUUID}/env/{envUUID}/bot/{botUUID}/conversations/request_report' \
  --header 'Content-Type: application/json' \
  --data '{
    "startDate": "2025-03-28T10:00:49.856Z",
    "endDate": "2025-03-28T10:00:49.856Z",
    "startHour": 1,
    "endHour": 1,
    "timezone": "text",
    "channelUuids": [
      "text"
    ],
    "tagsName": [
      "text"
    ],
    "sampleSize": 1,
    "reportType": "RANDOM",
    "filterField": "text",
    "filterTerm": "text",
    "funnelTags": [
      [
        "text"
      ]
    ],
    "previousStartDate": "2025-03-28T10:00:49.856Z",
    "previousEndDate": "2025-03-28T10:00:49.856Z"
  }'

200

400

401

403

404

409

422

500

200

No body

Ok

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

application/json

*/*

*/*

*/*

*/*

*/*

*/*

*/*

cURL

JavaScript

Python

HTTP

cURL

curl -L \
  --url '/org/{orgUUID}/env/{envUUID}/bot/{botUUID}/conversations/details?sessionCode=text'

200

400

401

403

404

409

422

500

200

{
  "sessionCode": "text",
  "startedAt": "text",
  "channel": {
    "uuid": "text",
    "botUuid": "text",
    "name": "text",
    "description": "text",
    "channelType": {
      "id": 1,
      "name": "text",
      "image": "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"
    }
  ]
}

Ok

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

timezonestring · default: "UTC"optional

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.

Responses

*/*

*/*

*/*

*/*

*/*

*/*

*/*

cURL

JavaScript

Python

HTTP

cURL

curl -L \
  --request POST \
  --url '/org/{orgUUID}/env/{envUUID}/bot/{botUUID}/conversations/details/request_report?sessionCode=text'

200

400

401

403

404

409

422

500

200

No body

Ok

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

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

application/json

*/*

*/*

*/*

*/*

*/*

*/*

*/*

cURL

JavaScript

Python

HTTP

cURL

curl -L \
  --request POST \
  --url '/org/{orgUUID}/env/{envUUID}/bot/{botUUID}/conversations/request_sample' \
  --header 'Content-Type: application/json' \
  --data '{
    "startDate": "2025-03-28T10:00:49.856Z",
    "endDate": "2025-03-28T10:00:49.856Z",
    "startHour": 1,
    "endHour": 1,
    "channelUuids": "text",
    "sampleSize": 1,
    "confidenceLevel": 1,
    "errorMargin": 1,
    "filterField": "text",
    "filterTerm": "text"
  }'

200

400

401

403

404

409

422

500

200

{
  "sampleSize": 1
}

Ok

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

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.

timezonestring · default: "UTC"optional

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.

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

funnelTagsstring[][]optional

Conditional field to filter conversations by funnel tags

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

application/json

*/*

*/*

*/*

*/*

*/*

*/*

*/*

cURL

JavaScript

Python

HTTP

cURL

curl -L \
  --request POST \
  --url '/org/{orgUUID}/env/{envUUID}/bot/{botUUID}/messages/list' \
  --header 'Content-Type: application/json' \
  --data '{
    "startDate": "2025-03-28T10:00:49.856Z",
    "endDate": "2025-03-28T10:00:49.856Z",
    "startHour": 1,
    "endHour": 1,
    "timezone": "text",
    "channelUUIDs": [
      "text"
    ],
    "tagsName": [
      "text"
    ],
    "searchBy": "text",
    "searchTerm": "text",
    "page": 1,
    "size": 1,
    "orderBy": "text",
    "direction": "text",
    "funnelTags": [
      [
        "text"
      ]
    ],
    "nonTags": true,
    "nlpResponses": "text",
    "previousStartDate": "2025-03-28T10:00:49.856Z",
    "previousEndDate": "2025-03-28T10:00:49.856Z"
  }'

200

400

401

403

404

409

422

500

200

{
  "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",
          "image": "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
}

Ok

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

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.

timezonestring · default: "UTC"optional

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.

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

Options: RANDOM, SEQUENTIAL, HIGHEST_SCORE, LOWEST_SCORE

filterFieldstringoptional

Optional filter field name being queried at the page currently.

filterTermstringoptional

Optional filter field value being queried at the page currently.

funnelTagsstring[][]optional

Optional field to filter conversations by funnel tags, you will need to pass the step tag and also those of the previous steps

previousStartDatestring · date-timeoptional

previousEndDatestring · date-timeoptional

Responses

*/*

*/*

*/*

*/*

*/*

*/*

*/*

cURL

JavaScript

Python

HTTP

cURL

curl -L \
  --request POST \
  --url '/org/{orgUUID}/env/{envUUID}/bot/{botUUID}/messages/request_report' \
  --header 'Content-Type: application/json' \
  --data '{
    "startDate": "2025-03-28T10:00:49.856Z",
    "endDate": "2025-03-28T10:00:49.856Z",
    "startHour": 1,
    "endHour": 1,
    "timezone": "text",
    "channelUuids": [
      "text"
    ],
    "tagsName": [
      "text"
    ],
    "sampleSize": 1,
    "reportType": "RANDOM",
    "filterField": "text",
    "filterTerm": "text",
    "funnelTags": [
      [
        "text"
      ]
    ],
    "previousStartDate": "2025-03-28T10:00:49.856Z",
    "previousEndDate": "2025-03-28T10:00:49.856Z"
  }'

200

400

401

403

404

409

422

500

200

No body

Ok

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

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

application/json

*/*

*/*

*/*

*/*

*/*

*/*

*/*

cURL

JavaScript

Python

HTTP

cURL

curl -L \
  --request POST \
  --url '/org/{orgUUID}/env/{envUUID}/bot/{botUUID}/messages/request_sample' \
  --header 'Content-Type: application/json' \
  --data '{
    "startDate": "2025-03-28T10:00:49.856Z",
    "endDate": "2025-03-28T10:00:49.856Z",
    "startHour": 1,
    "endHour": 1,
    "channelUuids": "text",
    "sampleSize": 1,
    "confidenceLevel": 1,
    "errorMargin": 1,
    "filterField": "text",
    "filterTerm": "text"
  }'

200

400

401

403

404

409

422

500

200

{
  "sampleSize": 1
}

Ok

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 · int32 · default: 1required

Current page, starting at 1

Example: 1

sizeinteger · int32 · default: 5required

Size of the page

Example: 1

Responses

application/json

*/*

*/*

*/*

*/*

*/*

*/*

*/*

cURL

JavaScript

Python

HTTP

cURL

curl -L \
  --url '/org/{orgUUID}/env/{envUUID}/bot/{botUUID}/reports/list?page=1&size=1'

200

400

401

403

404

409

422

500

200

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

Ok