POST
/
api
/
external
/
get-interactions
Get Interactions
curl --request POST \
  --url https://backend.nebuly.com/api/external/get-interactions \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '{
  "time_range": {
    "start": "<string>",
    "end": "<string>"
  },
  "filters": [
    {
      "kind": "<string>",
      "tag": "<string>",
      "values": [
        "<string>"
      ]
    }
  ],
  "limit": 123,
  "offset": 123
}'
{
  "total": 123,
  "offset": 123,
  "limit": 123,
  "data": [
    {
      "id": "<string>",
      "input_text": "<string>",
      "output_text": "<string>",
      "user_query": "<string>",
      "end_user": "<string>",
      "timestamp": "<string>"
    }
  ]
}
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.
filters
object[]
required
Filters you can use to get data based only on the interactions you are interested in.
limit
integer
required
Parameter needed for pagination. It indicates the number of rows per page.
offset
integer
required
Parameter needed for pagination. It indicates the offset to be applied to the first rows returned.

Response

total
integer
Needed for pagination. The total number of rows available.
offset
integer
Needed for pagination. It indicates the offset to be applied to the first rows returned.
limit
integer
Needed for pagination. It indicates the number of rows per page.
data
object[]
The data per interaction.