Analytics apiFeedback

Submit Feedback

POST
/feedback
/feedback

The Authorization access token

Authorization

Authorization
Required
Bearer <token>

The API key for an API integration

In: header

Request Body

application/jsonOptional

idstringnull

type
Required
string

Value in: "positive" | "negative"

messageId
Required
string

createdAtstringnull

Pattern: "^\\d{4}-\\d{2}-\\d{2}T\\d{2}:\\d{2}:\\d{2}(\\.\\d{1,3})?([+-]\\d{2}:\\d{2}|Z)$"

reasonsarraynull

userPropertiesobject

A customizable collection of custom properties or attributes.

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": "string",
    "reasons": [
      {
        "label": "string",
        "details": "string"
      }
    ],
    "userProperties": {}
  }'

Feedback provided successfully

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