> ## Documentation Index
> Fetch the complete documentation index at: https://docs.cludo.com/llms.txt
> Use this file to discover all available pages before exploring further.

# Submit Feedback

> Submit user feedback for search results including ratings and comments.



## OpenAPI

````yaml /openapi/feedback.json post /api/v4/{customerId}/{engineId}/feedback
openapi: 3.1.0
info:
  title: Cludo Feedback API
  version: 4.0.0
  description: >-
    Endpoint for submitting user feedback on website, search results and
    Experiences.
servers:
  - url: https://api.cludo.com
    description: EU region (Customer IDs below 10,000,000)
  - url: https://api-us1.cludo.com
    description: US region (Customer IDs 10,000,000 and above)
security:
  - SiteKey: []
paths:
  /api/v4/{customerId}/{engineId}/feedback:
    post:
      summary: Submit Feedback
      description: >-
        Submit user feedback for search results. Use this endpoint to collect
        ratings, reasons, and comments from users about their search experience.
      operationId: submitFeedback
      parameters:
        - $ref: '#/components/parameters/customerId'
        - $ref: '#/components/parameters/engineId'
      requestBody:
        required: true
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/FeedbackPostRequest'
      responses:
        '200':
          description: Feedback submitted successfully.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/FeedbackSuccessResponse'
        '400':
          $ref: '#/components/responses/BadRequest'
        '500':
          $ref: '#/components/responses/InternalServerError'
      security:
        - {}
        - SiteKey: []
        - BasicAuth: []
components:
  parameters:
    customerId:
      name: customerId
      in: path
      required: true
      description: Your Cludo customer ID.
      schema:
        type: integer
    engineId:
      name: engineId
      in: path
      required: true
      description: The search engine ID to submit feedback for.
      schema:
        type: integer
  schemas:
    FeedbackPostRequest:
      type: object
      description: Request body for submitting user feedback on search results.
      properties:
        url:
          type: string
          description: The URL of the page where the feedback was submitted.
        feedbackId:
          type: string
          format: uuid
          description: A unique string used as the ID of the feedback submission.
        rating:
          $ref: '#/components/schemas/RatingType'
        reason:
          type: string
          description: >-
            The reason selected by the user for their rating. This could be a
            predefined option from your feedback form.
        comment:
          type: string
          description: Free-form comment provided by the user as part of the feedback.
        sessionId:
          type: string
          description: The user's session ID to correlate feedback with search activity.
        ip:
          type: string
          description: The user's IP address.
        deviceType:
          type: string
          description: >-
            The type of device the feedback was submitted from (e.g. `desktop`,
            `mobile`, or `tablet`).
          example: desktop
        userAgent:
          type: string
          description: The user agent string from the browser.
        browserLanguage:
          type: string
          description: The language setting of the user's browser.
        screenResolution:
          type: string
          description: The pixel resolution of the visitor's screen (e.g. `1920x1080`).
        applicationName:
          type: string
          description: The name of the application submitting the feedback.
        applicationVersion:
          type: string
          description: The version of the application submitting the feedback.
    FeedbackSuccessResponse:
      type: object
      description: Success response for feedback submission.
      properties:
        value:
          type: object
          properties:
            eventId:
              type: string
              description: Server-generated event identifier for the feedback submission.
            feedbackId:
              type: string
              description: Unique identifier for the recorded feedback entry.
      example:
        value:
          eventId: <exampleID>
          feedbackId: <exampleID>
    RatingType:
      type: string
      enum:
        - positive
        - negative
      description: The type of rating provided by the user.
    ErrorResponse:
      type: object
      description: Error response returned when a request fails.
      properties:
        message:
          type: string
          description: A message describing what went wrong.
    ServerError:
      type: object
      description: Returned when an unexpected server error occurs.
      properties:
        status:
          type: string
          description: HTTP status name.
        code:
          type: integer
          description: HTTP status code.
        messages:
          type: array
          items:
            type: string
          description: Error details, usually including a support reference id.
  responses:
    BadRequest:
      description: >-
        The request is invalid. This typically occurs due to missing required
        fields, incorrect parameter values, or malformed request body.
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/ErrorResponse'
          example:
            message: >-
              The request could not be processed. Check the request body and
              required parameters.
    InternalServerError:
      description: >-
        An unexpected server error occurred. If this persists, contact
        support@cludo.com.
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/ServerError'
          example:
            status: InternalServerError
            code: 500
            messages:
              - >-
                Error occur. Please contact support with error ID:
                a1b2c3d4-e5f6-7890-abcd-ef1234567890
  securitySchemes:
    SiteKey:
      type: apiKey
      in: header
      name: Authorization
      description: >-
        SiteKey authentication. Pass the full value including the `SiteKey`
        prefix: `SiteKey <base64(customerId:engineId:searchKey)>`. Example:
        `SiteKey dGVzdDoxMjM0NTY3Ojk4NzY1`.
    BasicAuth:
      type: http
      scheme: basic
      description: >-
        Basic authentication. Use your Customer ID as the username and API Key
        as the password. Example header: `Authorization: Basic
        MTIzNDU2NzpteS1hcGkta2V5`.

````