Inkeep light logo
Schedule a callSee it for my content
Analytics apiFeedback

Submit Feedback

POST
/feedback

Authorization

AuthorizationRequiredBearer <token>

The API key for an API integration

In: header

Request Body

application/jsonRequired

Note: The maximum size of the request body is 2 MB.

idstring
typeRequiredstring
Value in: "positive" | "negative"
messageIdRequiredstring
createdAtstring | null

A timestamp in ISO 8601 format with timezone information. If not provided, the current time will be used.

Format: "date-time"
reasonsarray | null
userPropertiesobject | null

A customizable collection of custom properties or attributes. Some properties have first class support for the Inkeep Portal or Widget and are noted in the description.

curl -X POST "https://api.analytics.inkeep.com/feedback" \
  -H "Authorization: Bearer <token>" \
  -H "Content-Type: application/json" \
  -d '{
    "id": "string",
    "type": "positive",
    "messageId": "string",
    "createdAt": "2019-08-24T14:15:22Z",
    "reasons": [
      {
        "label": "string",
        "details": "string"
      }
    ],
    "userProperties": {
      "id": "string",
      "identificationType": "COOKIED",
      "userId": "string",
      "supportAgentName": "string"
    }
  }'

Feedback provided successfully

{
  "id": "string",
  "type": "positive",
  "messageId": "string",
  "createdAt": "string",
  "reasons": [
    {
      "label": "string",
      "details": "string"
    }
  ],
  "userProperties": {
    "id": "string",
    "identificationType": "COOKIED",
    "userId": "string",
    "supportAgentName": "string"
  }
}

Get All FeedbackLog Event