Analytics apiFeedbackFeedback

Submit Feedback

POST
/feedback

Authorization

AuthorizationRequiredBearer <token>

The API key for an API integration. For more details, see authentication documentation

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
propertiesobject | null

A customizable collection of custom properties or attributes.

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.

Response Body

Feedback provided successfully

idRequiredstring
typeRequiredstring
Value in: "positive" | "negative"
messageIdRequiredstring
createdAtRequiredstring
reasonsarray | null
propertiesobject | null

A customizable collection of custom properties or attributes.

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.

export interface Response {
  id: string;
  type: "positive" | "negative";
  messageId: string;
  createdAt: string;
  reasons?:
    | {
        label: string;
        details: string;
      }[]
    | null;
  /**
   * A customizable collection of custom properties or attributes.
   */
  properties?: {
    [k: string]: unknown;
  } | 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.
   */
  userProperties?: {
    /**
     * The unique identifier for the user. This value is sent by the inkeep widget.
     */
    id?: string | number | null;
    /**
     * The type of identification for the user. This value is sent by the inkeep widget.
     */
    identificationType?: string | null;
    /**
     * The unique identifier for the user. This value is sent by the Inkeep Support Agent Copilot. This value is used to create the graphs on the Inkeep Portal.
     */
    userId?: string | number | null;
    /**
     * The name of the support agent assigned to the user. This value is sent by the Inkeep Support Agent Copilot. This value is used to create the graphs on the Inkeep Portal.
     */
    supportAgentName?: string | null;
    [k: string]: unknown;
  } | null;
}
 
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"
      }
    ],
    "properties": {},
    "userProperties": {
      "id": "string",
      "identificationType": "COOKIED",
      "userId": "string",
      "supportAgentName": "string"
    }
  }'
{
  "id": "string",
  "type": "positive",
  "messageId": "string",
  "createdAt": "string",
  "reasons": [
    {
      "label": "string",
      "details": "string"
    }
  ],
  "properties": {},
  "userProperties": {
    "id": "string",
    "identificationType": "COOKIED",
    "userId": "string",
    "supportAgentName": "string"
  }
}