Skip to main content
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>",
      "conversation_id": "<string>",
      "timestamp": "<string>",
      "end_timestamp": "<string>",
      "warning_message_v2": "<string>",
      "negative_intent_message_v2": "<string>",
      "cost": 123,
      "latency": 123,
      "text_language": "<string>",
      "verbosity": 123,
      "pii_removed": true,
      "feedback_action_text": "<string>",
      "feedback_action_rating": 123,
      "feedback_actions": [
        "<string>"
      ],
      "sentiment": "<string>",
      "emotions": [
        "<string>"
      ],
      "tags": {},
      "custom_columns": {},
      "custom_aggregates": {},
      "rag_details": {}
    }
  ]
}

Documentation Index

Fetch the complete documentation index at: https://docs.nebuly.com/llms.txt

Use this file to discover all available pages before exploring further.

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.