# Provide feedback

Provide feedback on any interaction by providing the interaction ID, a score, label, and comment. Feedback will be shown in the feedback dashboard and through the reporting API.

# OpenAPI definition

```json
{
  "openapi": "3.0.1",
  "info": {
    "title": "Conversational AI Cloud",
    "version": "4.0.10"
  },
  "servers": [
    {
      "url": "https://{environment}.digitalcx.com",
      "variables": {
        "environment": {
          "default": "api",
          "enum": [
            "api",
            "api-cms",
            "api-staging"
          ]
        }
      }
    }
  ],
  "tags": [
    {
      "name": "Gateway",
      "description": "Conversational AI Cloud's Gateway API provides answers based on a given input, retrieves articles (FAQs) from the knowledge base, and additional features such as feedback."
    }
  ],
  "paths": {
    "/feedback": {
      "post": {
        "tags": [
          "Gateway"
        ],
        "summary": "Provide feedback",
        "description": "Provide feedback on any interaction by providing the interaction ID, a score, label, and comment. Feedback will be shown in the feedback dashboard and through the reporting API.",
        "security": [
          {
            "apiKey": []
          }
        ],
        "requestBody": {
          "content": {
            "application/json": {
              "schema": {
                "$ref": "#/components/schemas/FeedbackBody"
              }
            }
          }
        },
        "parameters": [
          {
            "$ref": "#/components/parameters/customerKeyParam"
          },
          {
            "$ref": "#/components/parameters/projectKeyParam"
          },
          {
            "$ref": "#/components/parameters/cultureParam"
          },
          {
            "$ref": "#/components/parameters/sessionIdParam"
          }
        ],
        "responses": {
          "204": {
            "description": "No content"
          }
        }
      }
    }
  },
  "components": {
    "parameters": {
      "cultureParam": {
        "name": "culture",
        "in": "query",
        "description": "Points to the culture of the project, which determines what content within the projects scope the answer will originate from.",
        "schema": {
          "type": "string"
        },
        "required": true
      },
      "sessionIdParam": {
        "name": "session.id",
        "in": "query",
        "description": "The GUID which identifies what session the specific interaction (request) belongs in",
        "schema": {
          "type": "string"
        },
        "required": false
      },
      "customerKeyParam": {
        "name": "customerKey",
        "in": "query",
        "description": "Customer identifier used for authenticating the request.",
        "schema": {
          "type": "string"
        },
        "required": true
      },
      "projectKeyParam": {
        "name": "projectKey",
        "in": "query",
        "description": "Project identifier used for authenticating the request, and to determine what project environment the interaction will take place in.",
        "schema": {
          "type": "string"
        },
        "required": true
      }
    },
    "securitySchemes": {
      "apiKey": {
        "description": "Conversational AI Cloud API key",
        "type": "apiKey",
        "in": "query",
        "name": "apikey"
      }
    },
    "schemas": {
      "FeedbackBody": {
        "type": "object",
        "description": "Object containing all data required for the Gateway API to process the feedback on a specific interaction.",
        "properties": {
          "originInteractionId": {
            "description": "The unique identifier for the interaction for which feedback is provided.",
            "type": "string",
            "example": "00000000-0000-0000-0000-000000000000"
          },
          "score": {
            "description": "Value between -5 and 5 that indicates how satisfied the user is with the answer.",
            "type": "integer",
            "example": 4
          },
          "label": {
            "description": "The label for the feedback score.",
            "type": "string",
            "example": "Good"
          },
          "comment": {
            "description": "A comment provided by the end-user when providing feedback for an interaction.",
            "type": "string",
            "example": "The answer didn't help me to resolve my initial issue."
          }
        }
      }
    }
  },
  "x-readme": {
    "explorer-enabled": true,
    "proxy-enabled": true
  },
  "_id": {
    "buffer": {
      "0": 100,
      "1": 110,
      "2": 119,
      "3": 152,
      "4": 7,
      "5": 209,
      "6": 200,
      "7": 0,
      "8": 59,
      "9": 116,
      "10": 112,
      "11": 80
    }
  }
}
```