---
title: "POST /bots/{botId}/analytics/intentpaths"
method: POST
path: "/bots/{botId}/analytics/intentpaths"
---

# POST /bots/{botId}/analytics/intentpaths

`POST /bots/{botId}/analytics/intentpaths`

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.

## Path parameters

- `botId` string, required

## Request body

- object
  - `startDateTime` string, 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.
  - `endDateTime` string, 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.
  - `intentPath` string, 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>
  - `filters` AnalyticsPathFilter[] — A list of objects, each describes a condition by which you want to filter the results.
    - `name` 'BotAliasId' | 'BotVersion' | 'LocaleId' | 'Modality' | 'Channel', required — <p>The category by which to filter the intent paths. The descriptions for each option are as follows:</p> <ul> <li> <p> <code>BotAlias</code> – The name of the bot alias.</p> </li> <li> <p> <code>BotVersion</code> – The version of the bot.</p> </li> <li> <p> <code>LocaleId</code> – The locale of the bot.</p> </li> <li> <p> <code>Modality</code> – The modality of the session with the bot (audio, DTMF, or text).</p> </li> <li> <p> <code>Channel</code> – The channel that the bot is integrated with.</p> </li> </ul>
    - `operator` 'EQ' | 'GT' | 'LT', required — <p>The operation by which to filter the category. The following operations are possible:</p> <ul> <li> <p> <code>CO</code> – Contains</p> </li> <li> <p> <code>EQ</code> – Equals</p> </li> <li> <p> <code>GT</code> – Greater than</p> </li> <li> <p> <code>LT</code> – Less than</p> </li> </ul> <p>The operators that each filter supports are listed below:</p> <ul> <li> <p> <code>BotAlias</code> – <code>EQ</code>.</p> </li> <li> <p> <code>BotVersion</code> – <code>EQ</code>.</p> </li> <li> <p> <code>LocaleId</code> – <code>EQ</code>.</p> </li> <li> <p> <code>Modality</code> – <code>EQ</code>.</p> </li> <li> <p> <code>Channel</code> – <code>EQ</code>.</p> </li> </ul>
    - `values` AnalyticsFilterValue[], required — An array containing the values of the category by which to apply the operator to filter the results. You can provide multiple values if the operator is <code>EQ</code> or <code>CO</code>. If you provide multiple values, you filter for results that equal/contain any of the values. For example, if the <code>name</code>, <code>operator</code>, and <code>values</code> fields are <code>Modality</code>, <code>EQ</code>, and <code>[Speech, Text]</code>, the operation filters for results where the modality was either <code>Speech</code> or <code>Text</code>.

## Response `200`

Success

- ListIntentPathsResponse
  - `nodeSummaries` AnalyticsIntentNodeSummary[] — A list of objects, each of which contains information about a node in the intent path for which you requested metrics.
    - `intentName` string — The name of the intent at the end of the requested path.
    - `intentPath` string — The path.
    - `intentCount` integer — The total number of sessions that follow the given path to the given intent.
    - `intentLevel` integer — The number of intents up to and including the requested path.
    - `nodeType` 'Inner' | 'Exit' — Specifies whether the node is the end of a path (<code>Exit</code>) or not (<code>Inner</code>).

## Other responses

- `480` — ThrottlingException
- `481` — ValidationException
- `482` — PreconditionFailedException
- `483` — ServiceQuotaExceededException
- `484` — InternalServerException

---

[API](https://skmtc.net/aws/apis/lexv2-models.md) · [All operations](https://skmtc.net/aws/apis/lexv2-models/llms.txt) · [OpenAPI document](https://skmtc-service-staging.skmtc.workers.dev/v1/apis/aws/lexv2-models/versions/6997ba482d72/schema)