Dashboard
The Dashboard API handles large data for the purpose of customer usage analytics.
Last updated
Was this helpful?
The Dashboard API handles large data for the purpose of customer usage analytics.
Last updated
Was this helpful?
API SUBPATH: eva-dashboard
The Dashboard API is made to retrieve data in a format proper to either supply an excel file or plot a graph. Every one of them follow similar request rules.
All Date formats are standard ISO Datetime:
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.
/org/{orgUUID}/env/{envUUID}/bot/{botUUID}/dashboard/summary
A valid uuid of an organization
A valid uuid of an environment
The UUID of the bot whose entities you are searching
/org/{orgUUID}/env/{envUUID}/bot/{botUUID}/conversations/report_configurations
A valid uuid of an organization
A valid uuid of an environment
The UUID of the bot whose conversations you are searching
/org/{orgUUID}/env/{envUUID}/bot/{botUUID}/messages/report_configurations
A valid uuid of an organization
A valid uuid of an environment
The UUID of the bot whose conversations you are searching
/org/{orgUUID}/env/{envUUID}/bot/{botUUID}/dashboard/conversations
A valid uuid of an organization
A valid uuid of an environment
The UUID of the bot whose entities you are searching
Starting date for the search (inclusive). Must conform to ISO format.
End date for the search (inclusive). Must conform to ISO format.
Starting hour of the search interval. 0 if unfiltered.
Ending hour of the search interval. 23 if unfiltered.
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.
ALL channelUuids to filter. If empty, all are used instead.
ALL tags name to filter. If empty, no tag filter will be applied.
/org/{orgUUID}/env/{envUUID}/bot/{botUUID}/dashboard/messages
A valid uuid of an organization
A valid uuid of an environment
The UUID of the bot whose entities you are searching
Starting date for the search (inclusive). Must conform to ISO format.
End date for the search (inclusive). Must conform to ISO format.
Starting hour of the search interval. 0 if unfiltered.
Ending hour of the search interval. 23 if unfiltered.
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.
ALL channelUuids to filter. If empty, all are used instead.
ALL tags name to filter. If empty, no tag filter will be applied.
/org/{orgUUID}/env/{envUUID}/bot/{botUUID}/dashboard/users
A valid uuid of an organization
A valid uuid of an environment
The UUID of the bot whose entities you are searching
Starting date for the search (inclusive). Must conform to ISO format.
End date for the search (inclusive). Must conform to ISO format.
Starting hour of the search interval. 0 if unfiltered.
Ending hour of the search interval. 23 if unfiltered.
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.
ALL channelUuids to filter. If empty, all are used instead.
ALL tags name to filter. If empty, no tag filter will be applied.
/org/{orgUUID}/env/{envUUID}/bot/{botUUID}/dashboard/accuracy
A valid uuid of an organization
A valid uuid of an environment
The UUID of the bot whose entities you are searching
Starting date for the search (inclusive). Must conform to ISO format.
End date for the search (inclusive). Must conform to ISO format.
Starting hour of the search interval. 0 if unfiltered.
Ending hour of the search interval. 23 if unfiltered.
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.
ALL channelUuids to filter. If empty, all are used instead.
ALL tags name to filter. If empty, no tag filter will be applied.
/org/{orgUUID}/env/{envUUID}/bot/{botUUID}/dashboard/stacking/intents
A valid uuid of an organization
A valid uuid of an environment
The UUID of the bot whose entities you are searching
Starting date for the search (inclusive). Must conform to ISO format.
End date for the search (inclusive). Must conform to ISO format.
Starting hour of the search interval. 0 if unfiltered.
Ending hour of the search interval. 23 if unfiltered.
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.
ALL channelUuids to filter. If empty, all are used instead.
ALL tags name to filter. If empty, no tag filter will be applied.
/org/{orgUUID}/env/{envUUID}/bot/{botUUID}/dashboard/stacking/flows
A valid uuid of an organization
A valid uuid of an environment
The UUID of the bot whose entities you are searching
Starting date for the search (inclusive). Must conform to ISO format.
End date for the search (inclusive). Must conform to ISO format.
Starting hour of the search interval. 0 if unfiltered.
Ending hour of the search interval. 23 if unfiltered.
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.
ALL channelUuids to filter. If empty, all are used instead.
ALL tags name to filter. If empty, no tag filter will be applied.
/org/{orgUUID}/env/{envUUID}/bot/{botUUID}/dashboard/stacking/abandonments
A valid uuid of an organization
A valid uuid of an environment
The UUID of the bot whose entities you are searching
Starting date for the search (inclusive). Must conform to ISO format.
End date for the search (inclusive). Must conform to ISO format.
Starting hour of the search interval. 0 if unfiltered.
Ending hour of the search interval. 23 if unfiltered.
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.
ALL channelUuids to filter. If empty, all are used instead.
ALL tags name to filter. If empty, no tag filter will be applied.
/org/{orgUUID}/env/{envUUID}/bot/{botUUID}/conversations/list
A valid uuid of an organization.
A valid uuid of an environment.
The UUID of the bot whose conversations you are searching.
Starting date for the search (inclusive). Must conform to ISO format.
End date for the search (inclusive). Must conform to ISO format.
Starting hour of the search interval. 0 if unfiltered.
Ending hour of the search interval. 23 if unfiltered.
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.
Type of search filter being applied on this query. Possible fields are: [SESSION_CODE, BUSINESS_KEY, FLOW]
Term being searched according to the searchBy filter.
Current page, starting at 1
Size of the page
Criteria to order result, defaulted to conversationStartedAt. Possible fields include satisfaction, userMessages, flowsTravelled, conversationStartedAt and duration.
Order direction(ASC/DESC), defaulted to DESC
Used for when we want to filter user messages or conversations that have not been through tags.
ALL channelUuids to filter. If empty, all are used instead.
ALL tags name to filter. If empty, no tag filter will be applied.
Conditional field to filter conversations by funnel tags
/org/{orgUUID}/env/{envUUID}/bot/{botUUID}/conversations/request_report
A valid uuid of an organization
A valid uuid of an environment
The UUID of the bot whose conversations you are searching
Starting date for the search (inclusive). Must conform to ISO format.
End date for the search (inclusive). Must conform to ISO format.
Starting hour of the search interval. 0 if unfiltered.
Ending hour of the search interval. 23 if unfiltered.
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.
Capping ammount of items to be used in the report.
The report sorting type
RANDOM
, SEQUENTIAL
, HIGHEST_SCORE
, LOWEST_SCORE
Optional filter field name being queried at the page currently.
Optional filter field value being queried at the page currently.
A list of all channelUuids in the report, comma separated.
A list of all tagsName in the report, comma separated.
Optional field to filter conversations by funnel tags, you will need to pass the step tag and also those of the previous steps
No body
/org/{orgUUID}/env/{envUUID}/bot/{botUUID}/conversations/details
A valid uuid of an organization
A valid uuid of an environment
The UUID of the bot whose conversations you are searching
Session Code of the conversation
/org/{orgUUID}/env/{envUUID}/bot/{botUUID}/conversations/details/request_report
A valid uuid of an organization
A valid uuid of an environment
The UUID of the bot whose conversations you are searching
Session Code of the conversation
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.
No body
/org/{orgUUID}/env/{envUUID}/bot/{botUUID}/conversations/request_sample
A valid uuid of an organization
A valid uuid of an environment
The UUID of the bot whose conversations you are searching
Starting date of the report range, including itself, in ISO-8601 format (yyyy-MM-dd'T'HH:mm:ss.SSS'Z')
Ending date of the report range, including itself, in ISO-8601 format (yyyy-MM-dd'T'HH:mm:ss.SSS'Z')
Starting hour of the report range, from 0 to 23. Hour sent is included in the report.
Ending hour of the report range, from 0 to 23. Hour sent is included in the report.
A list of all channelUuids in the report, comma separated.
Capping ammount of items to be used in the report.
Minimal confidence level in the report results, simulating response to a configuration in the parameters screen.
An error margin into the confidence level, allowing for variance.
Optional filter field name being queried at the page currently.
Optional filter field value being queried at the page currently.
/org/{orgUUID}/env/{envUUID}/bot/{botUUID}/messages/list
A valid uuid of an organization.
A valid uuid of an environment.
The UUID of the bot whose messages you are searching.
Starting date for the search (inclusive). Must conform to ISO format.
End date for the search (inclusive). Must conform to ISO format.
Starting hour of the search interval. 0 if unfiltered.
Ending hour of the search interval. 23 if unfiltered.
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.
Type of search filter being applied on this query. Possible fields are: [SESSION_CODE, BUSINESS_KEY, FLOW]
Term being searched according to the searchBy filter.
Current page, starting at 1
Size of the page
Criteria to order result, defaulted to conversationStartedAt. Possible fields include satisfaction, userMessages, flowsTravelled, conversationStartedAt and duration.
Order direction(ASC/DESC), defaulted to DESC
Used for when we want to filter user messages or conversations that have not been through tags.
A comma-separated String containing ALL nlpResponseFilters to filter. Those may be one of: [FOUND, NONE, ALL].
ALL channelUuids to filter. If empty, all are used instead.
ALL tags name to filter. If empty, no tag filter will be applied.
Conditional field to filter conversations by funnel tags
/org/{orgUUID}/env/{envUUID}/bot/{botUUID}/messages/request_report
A valid uuid of an organization
A valid uuid of an environment
The UUID of the bot whose conversations you are searching
Starting date for the search (inclusive). Must conform to ISO format.
End date for the search (inclusive). Must conform to ISO format.
Starting hour of the search interval. 0 if unfiltered.
Ending hour of the search interval. 23 if unfiltered.
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.
Capping ammount of items to be used in the report.
The report sorting type
RANDOM
, SEQUENTIAL
, HIGHEST_SCORE
, LOWEST_SCORE
Optional filter field name being queried at the page currently.
Optional filter field value being queried at the page currently.
A list of all channelUuids in the report, comma separated.
A list of all tagsName in the report, comma separated.
Optional field to filter conversations by funnel tags, you will need to pass the step tag and also those of the previous steps
No body
/org/{orgUUID}/env/{envUUID}/bot/{botUUID}/messages/request_sample
A valid uuid of an organization
A valid uuid of an environment
The UUID of the bot whose conversations you are searching
Starting date of the report range, including itself, in ISO-8601 format (yyyy-MM-dd'T'HH:mm:ss.SSS'Z')
Ending date of the report range, including itself, in ISO-8601 format (yyyy-MM-dd'T'HH:mm:ss.SSS'Z')
Starting hour of the report range, from 0 to 23. Hour sent is included in the report.
Ending hour of the report range, from 0 to 23. Hour sent is included in the report.
A list of all channelUuids in the report, comma separated.
Capping ammount of items to be used in the report.
Minimal confidence level in the report results, simulating response to a configuration in the parameters screen.
An error margin into the confidence level, allowing for variance.
Optional filter field name being queried at the page currently.
Optional filter field value being queried at the page currently.
/org/{orgUUID}/env/{envUUID}/bot/{botUUID}/reports/list
A valid uuid of an organization
A valid uuid of an environment
The UUID of the bot whose messages you are searching
Current page, starting at 1
1
Size of the page
1