Send Feedback Actions

POST

event-ingestion

api

events

feedback

Send Feedback Actions

curl --request POST \
  --url https://backend.nebuly.com/event-ingestion/api/v1/events/feedback \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '{
  "action": {
    "slug": "<string>",
    "text": "<string>",
    "value": 123
  },
  "metadata": {
    "input": "<string>",
    "output": "<string>",
    "end_user": "<string>",
    "timestamp": "<string>",
    "anonymize": true
  }
}'

This endpoint allows you to send feedback actions collected from your application’s frontend. In particular, it enables you to link end-user feedback or instances where users copy and paste text generated by the AI system to the corresponding user interaction.

Feedback actions are linked to an interaction using the end_user, input, and output fields you can provide in the metadata. The platform expects the interaction to have already been sent when submitting a feedback action, and the timestamp of the feedback action must be after the timestamp marking the end of the interaction generation.

For users of the european region, the correct endpoint is https://backend.eu.nebuly.com/event-ingestion/api/v1/events/feedback.

action

object

required

The feedback action you are tracking.

Show properties

slug

string

required

This represents the types of feedback actions you are sending to the platform. Accepted values are:

thumbs_up: Indicates that the end user has given a thumbs up. The text field can be used to include any additional comments left by the user.
thumbs_down: Indicates that the end user has given a thumbs down. The text field can be used to include any additional comments left by the user.
copy_input: Indicates that the user has copied the input message. In this case, the text field should contain the portion of the input that was copied.
copy_output: Indicates that the user has copied the output message. In this case, the text field should contain the portion of the output that was copied.
paste: Indicates that the user has pasted some text into the chatbot input box. The text field should contain the pasted text.
rating: Indicates that the user has given a score to the chatbot, from 1 to 5. With this slug, you should use the field value instead of the text field.

text

string

The text given as extra context to the slug. See slug description for further info.

value

number

The score given by the user. It can be an integer between 1 and 5. This field is only used when the slug is “rating”.

metadata

object

required

Metadata is required to accurately associate the feedback action with its corresponding interaction.

Show properties

input

string

The input of the interactions to which the action refers to. If not given the interaction will be determined using the action time-stamp and the end-user id.

output

string

The output of the interactions to which the action refers to. If not given the interaction will be determined using the action time-stamp and the end-user id.

end_user

string

required

The identified used for the end-user.

timestamp

string

required

The timestamp of the action event.

anonymize

bool

Boolean flag. If set to true, PII will be removed from the text field.

Send conversation with interaction traces Send Tags

Send Feedback Actions

curl --request POST \
  --url https://backend.nebuly.com/event-ingestion/api/v1/events/feedback \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '{
  "action": {
    "slug": "<string>",
    "text": "<string>",
    "value": 123
  },
  "metadata": {
    "input": "<string>",
    "output": "<string>",
    "end_user": "<string>",
    "timestamp": "<string>",
    "anonymize": true
  }
}'

Welcome

Tracking

Embedded Pages

AB Testing

Platform users

SDK