Skip to main content
POST
/
api
/
v4
/
{customerId}
/
{engineId}
/
feedback
Submit Feedback
curl --request POST \
  --url https://api.cludo.com/api/v4/{customerId}/{engineId}/feedback \
  --header 'Authorization: <api-key>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "url": "<string>",
  "feedbackId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "reason": "<string>",
  "comment": "<string>",
  "sessionId": "<string>",
  "ip": "<string>",
  "deviceType": "<unknown>",
  "userAgent": "<string>",
  "browserLanguage": "<string>",
  "screenResolution": "<string>",
  "applicationName": "<string>",
  "applicationVersion": "<string>"
}
'
{
  "value": {
    "eventId": "<exampleID>",
    "feedbackId": "<exampleID>"
  }
}

Documentation Index

Fetch the complete documentation index at: https://signe.cludo.com/llms.txt

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

Authorizations

​
Authorization
string
header
required

SiteKey authentication. Pass the full value including the SiteKey prefix: SiteKey <base64(customerId:engineId:searchKey)>. Example: SiteKey dGVzdDoxMjM0NTY3Ojk4NzY1.

Path Parameters

​
customerId
integer
required

Your Cludo customer ID.

​
engineId
integer
required

The search engine ID to submit feedback for.

Body

application/json

Request body for submitting user feedback on search results.

​
url
string

The URL of the page where the feedback was submitted.

​
feedbackId
string<uuid>

A unique string used as the ID of the feedback submission.

​
rating
enum<string>

The type of rating provided by the user.

Available options:
positive,
negative
​
reason
string

The reason selected by the user for their rating. This could be a predefined option from your feedback form.

​
comment
string

Free-form comment provided by the user as part of the feedback.

​
sessionId
string

The user's session ID to correlate feedback with search activity.

​
ip
string

The user's IP address.

​
deviceType
any
​
userAgent
string

The user agent string from the browser.

​
browserLanguage
string

The language setting of the user's browser.

​
screenResolution
string

The pixel resolution of the visitor's screen (e.g. 1920x1080).

​
applicationName
string

The name of the application submitting the feedback.

​
applicationVersion
string

The version of the application submitting the feedback.

Response

Feedback submitted successfully.

Success response for feedback submission.

​
value
object