POST
/
api
/
external
/
intents-v2
curl --request POST \
  --url https://backend.nebuly.com/api/external/intents-v2 \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '{
  "time_range": {
    "kind": "<string>",
    "start": "<string>",
    "end": "<string>"
  },
  "topic_id": "<string>",
  "limit": 123,
  "offset": 123,
  "filters": [
    {}
  ],
  "sort_by": "<string>",
  "search": "<string>"
}'

You will get a the detailed list of the intents related to your project. You can filter the overview by using a category id. In order to get the list of the categories see the Get Intent Categories endpoint. You need an API key to authenticate. See here for more information about the API keys.

time_range
object
required

The time range to consider when computing the metrics and analytics to show.

kind
string
required

The value of the time range. It can be one between today, 7_days, this_month, 30_days, 6_months, 12_months, ytd, custom. If custom is given the values pass in the start and end fields will be used as start date and end date if the time range.

start
string
required

The start date for the time-range. Please consider that this parameter is used only when custom is given as kind.

end
string
required

The end date for the time-range. Please consider that this parameter is used only when custom is given as kind.

topic_id
string

Optional topic for which you want to get the intents. You can get the topic from the Get Intent Topic endpoint.

limit
integer
required

Parameter needed for pagination. It indicates the number of intents per page.

offset
integer
required

Parameter needed for pagination. It indicates the offset to be applied to the first intents returned.

filters
list
required

A list of filters. It can be empty. Below you can find a list of the available filters:

{
    "column": "warning_category",
    "values": ["string"]
}
{
    "column": "warning_subcategory",
    "values": ["string"]
}
{
    "column": "topic",
    "values": ["string"]
}
{
    "column": "is_frustrated",
    "values": ["string"]
}
{
    "column": "language",
    "values": ["string"]
}
{
    "column": "data_source",
    "values": ["string"]
}
{
    "column": "user",
    "values": ["string"]
}
{
    "column": "action",
    "values": ["string"]
}
{
    "column": "pii",
    "values": ["yes", "no"]
}
{
    "column": "cohort",
    "values": ["string"]
}
{
    "column": "intent",
    "values": ["string"]
}
sort_by
string
required

Parameter used to sort the intents. They can be sorted by three different values:

  • “intent”: the values are sorted alphabetically.
  • “users”: the values are sorted by number of users.
  • “newest”: the values are sorted by the newest intents.
search
string

Optional parameter used to search for a specific intent.