Sign in

v1

latestOpenAPI 3.0.0Apache 2.0 License2026-07-14107861793.8 KB

Retrieves summary statistics for a path of intents that users take over sessions with your bot. The following fields are required:

  • startDateTime and endDateTime – Define a time range for which you want to retrieve results.

  • intentPath – Define an order of intents for which you want to retrieve metrics. Separate intents in the path with a forward slash. For example, populate the intentPath field with /BookCar/BookHotel to see details about how many times users invoked the BookCar and BookHotel intents in that order.

Use the optional filters field to filter the results.

post/bots/{botId}/analytics/intentpaths

Path parameters

botIdstring required

The identifier for the bot for which you want to retrieve intent path metrics.

Request body

startDateTimestring date-time required

The date and time that marks the beginning of the range of time for which you want to see intent path metrics.

endDateTimestring date-time required

The date and time that marks the end of the range of time for which you want to see intent path metrics.

intentPathstring required
<p>The intent path for which you want to retrieve metrics. Use a forward slash to separate intents in the path. For example:</p> <ul> <li> <p>/BookCar</p> </li> <li> <p>/BookCar/BookHotel</p> </li> <li> <p>/BookHotel/BookCar</p> </li> </ul>

Response

Success