Dashboard
The Dashboard API handles large data for the purpose of customer usage analytics.
Was this helpful?
The Dashboard API handles large data for the purpose of customer usage analytics.
Was this helpful?
A valid uuid of an organization
A valid uuid of an environment
The UUID of the bot whose entities you are searching
A valid uuid of an organization
A valid uuid of an environment
The UUID of the bot whose conversations you are searching
A valid uuid of an organization
A valid uuid of an environment
The UUID of the bot whose conversations you are searching
A valid uuid of an organization
A valid uuid of an environment
The UUID of the bot whose entities you are searching
A comma-separated String containing ALL channelUuids to filter. If empty, all are used instead.
Date this search starts at, including itself, at ISO format.
Date this search ends at, including itself, at ISO format.
Interval being searched starting hour. Value is 0 if unfiltered.
Interval being searched ending hour. Value is 23 if unfiltered.
A valid uuid of an organization
A valid uuid of an environment
The UUID of the bot whose entities you are searching
A comma-separated String containing ALL channelUuids to filter. If empty, all are used instead.
Date this search starts at, including itself, at ISO format.
Date this search ends at, including itself, at ISO format.
Interval being searched starting hour. Value is 0 if unfiltered.
Interval being searched ending hour. Value is 23 if unfiltered.
A valid uuid of an organization
A valid uuid of an environment
The UUID of the bot whose entities you are searching
A comma-separated String containing ALL channelUuids to filter. If empty, all are used instead.
Date this search starts at, including itself, at ISO format.
Date this search ends at, including itself, at ISO format.
Interval being searched starting hour. Value is 0 if unfiltered.
Interval being searched ending hour. Value is 23 if unfiltered.
A valid uuid of an organization
A valid uuid of an environment
The UUID of the bot whose entities you are searching
A comma-separated String containing ALL channelUuids to filter. If empty, all are used instead.
Date this search starts at, including itself, at ISO format.
Date this search ends at, including itself, at ISO format.
Interval being searched starting hour. Value is 0 if unfiltered.
Interval being searched ending hour. Value is 23 if unfiltered.
A valid uuid of an organization
A valid uuid of an environment
The UUID of the bot whose entities you are searching
A comma-separated String containing ALL channelUuids to filter. If empty, all are used instead.
Date this search starts at, including itself, at ISO format.
Date this search ends at, including itself, at ISO format.
Interval being searched starting hour. Value is 0 if unfiltered.
Interval being searched ending hour. Value is 23 if unfiltered.
A valid uuid of an organization
A valid uuid of an environment
The UUID of the bot whose conversations you are searching
Date this search starts at, including itself, at ISO format.
Date this search ends at, including itself, at ISO format.
Interval being searched starting hour. Value is 0 if unfiltered.
Interval being searched ending hour. Value is 23 if unfiltered.
A comma-separated String containing ALL channelUuids to filter. If empty, all are used instead.
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
1
Size of the page
1
Criteria to order result, defaulted to conversationStartedAt. Possible fields include satisfaction, userMessages, flowsTravelled, conversationStartedAt and duration.
Order direction(ASC/DESC), defaulted to DESC
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
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
No body
A valid uuid of an organization
A valid uuid of an environment
The UUID of the bot whose entities you are searching
A comma-separated String containing ALL channelUuids to filter. If empty, all are used instead.
Date this search starts at, including itself, at ISO format.
Date this search ends at, including itself, at ISO format.
Interval being searched starting hour. Value is 0 if unfiltered.
Interval being searched ending hour. Value is 23 if unfiltered.
A valid uuid of an organization
A valid uuid of an environment
The UUID of the bot whose messages you are searching
Date this search starts at, including itself, at ISO format.
Date this search ends at, including itself, at ISO format.
Interval being searched starting hour. Value is 0 if unfiltered.
Interval being searched ending hour. Value is 23 if unfiltered.
A comma-separated String containing ALL channelUuids to filter. If empty, all are used instead.
Type of search filter being applied on this query. Possible fields are: [SESSION_CODE, INTENT, ENTITY, DOCUMENT, QUESTION]
Term being searched according to the searchBy filter.
Current page, starting at 1
1
Size of the page
1
Criteria to order result, defaulted to deliveredAt. Possible fields include confidence and deliveredAt.
Order direction(ASC/DESC), defaulted to DESC
A comma-separated String containing ALL nlpResponseFilters to filter. Those may be one of: [FOUND, NONE, ALL]
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
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.
The report sorting type
Optional filter field name being queried at the page currently.
Optional filter field value being queried at the page currently.
No body
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.
The report sorting type
Optional filter field name being queried at the page currently.
Optional filter field value being queried at the page currently.
No body