Get All Feedback

Authorization

AuthorizationRequiredBearer <token>

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

In: header

Query Parameters

limitinteger | null | null

Default: 10Minimum: 0Maximum: 100

offsetinteger | null | null

Default: 0Minimum: 0

Response Body

All feedback retrieved successfully

TypeScript Definitions

Use the response body type in TypeScript.

positiveFeedbackCountRequirednumber

negativeFeedbackCountRequirednumber

positiveFeedbackRequiredarray<object>

negativeFeedbackRequiredarray<object>

Bad Request

TypeScript Definitions

Use the response body type in TypeScript.

titleRequiredstring

A short, human-readable summary of the problem type.

statusRequirednumber

The HTTP status code.

Value in: 400

detailRequiredstring

A detailed explanation specific to this occurrence of the problem, providing context and specifics about what went wrong.

instancestring

A URI reference that identifies the specific occurrence of the problem.

requestIdstring

A unique identifier for the request, useful for troubleshooting.

codeRequiredstring

A short code indicating the error code returned.

Value in: "bad_request"

errorRequiredobject

Legacy error format for backward compatibility.

Unauthorized

TypeScript Definitions

Use the response body type in TypeScript.

titleRequiredstring

A short, human-readable summary of the problem type.

statusRequirednumber

The HTTP status code.

Value in: 401

detailRequiredstring

A detailed explanation specific to this occurrence of the problem, providing context and specifics about what went wrong.

instancestring

A URI reference that identifies the specific occurrence of the problem.

requestIdstring

A unique identifier for the request, useful for troubleshooting.

codeRequiredstring

A short code indicating the error code returned.

Value in: "unauthorized"

errorRequiredobject

Legacy error format for backward compatibility.

Forbidden

TypeScript Definitions

Use the response body type in TypeScript.

titleRequiredstring

A short, human-readable summary of the problem type.

statusRequirednumber

The HTTP status code.

Value in: 403

detailRequiredstring

A detailed explanation specific to this occurrence of the problem, providing context and specifics about what went wrong.

instancestring

A URI reference that identifies the specific occurrence of the problem.

requestIdstring

A unique identifier for the request, useful for troubleshooting.

codeRequiredstring

A short code indicating the error code returned.

Value in: "forbidden"

errorRequiredobject

Legacy error format for backward compatibility.

Not Found

TypeScript Definitions

Use the response body type in TypeScript.

titleRequiredstring

A short, human-readable summary of the problem type.

statusRequirednumber

The HTTP status code.

Value in: 404

detailRequiredstring

A detailed explanation specific to this occurrence of the problem, providing context and specifics about what went wrong.

instancestring

A URI reference that identifies the specific occurrence of the problem.

requestIdstring

A unique identifier for the request, useful for troubleshooting.

codeRequiredstring

A short code indicating the error code returned.

Value in: "not_found"

errorRequiredobject

Legacy error format for backward compatibility.

Unprocessable Entity

TypeScript Definitions

Use the response body type in TypeScript.

titleRequiredstring

A short, human-readable summary of the problem type.

statusRequirednumber

The HTTP status code.

Value in: 422

detailRequiredstring

A detailed explanation specific to this occurrence of the problem, providing context and specifics about what went wrong.

instancestring

A URI reference that identifies the specific occurrence of the problem.

requestIdstring

A unique identifier for the request, useful for troubleshooting.

codeRequiredstring

A short code indicating the error code returned.

Value in: "unprocessable_entity"

errorRequiredobject

Legacy error format for backward compatibility.

Internal Server Error

TypeScript Definitions

Use the response body type in TypeScript.

titleRequiredstring

A short, human-readable summary of the problem type.

statusRequirednumber

The HTTP status code.

Value in: 500

detailRequiredstring

A detailed explanation specific to this occurrence of the problem, providing context and specifics about what went wrong.

instancestring

A URI reference that identifies the specific occurrence of the problem.

requestIdstring

A unique identifier for the request, useful for troubleshooting.

codeRequiredstring

A short code indicating the error code returned.

Value in: "internal_server_error"

errorRequiredobject

Legacy error format for backward compatibility.

curl -X GET "https://api.analytics.inkeep.com/feedback?limit=10&offset=0" \
  -H "Authorization: Bearer <token>"

fetch("https://api.analytics.inkeep.com/feedback?limit=10&offset=0", {
  headers: {
    "Authorization": "Bearer <token>"
  }
})

package main

import (
  "fmt"
  "net/http"
  "io/ioutil"
)

func main() {
  url := "https://api.analytics.inkeep.com/feedback?limit=10&offset=0"

  req, _ := http.NewRequest("GET", url, nil)
  req.Header.Add("Authorization", "Bearer <token>")
  res, _ := http.DefaultClient.Do(req)
  defer res.Body.Close()
  body, _ := ioutil.ReadAll(res.Body)

  fmt.Println(res)
  fmt.Println(string(body))
}

import requests

url = "https://api.analytics.inkeep.com/feedback?limit=10&offset=0"

response = requests.request("GET", url, headers = {
  "Authorization": "Bearer <token>"
})

print(response.text)

{
  "positiveFeedbackCount": 0,
  "negativeFeedbackCount": 0,
  "positiveFeedback": [
    {
      "id": "string",
      "type": "positive",
      "messageId": "string",
      "createdAt": "string",
      "reasons": [
        {
          "label": "string",
          "details": "string"
        }
      ],
      "properties": {},
      "userProperties": {
        "id": "string",
        "identificationType": "COOKIED",
        "userId": "string",
        "supportAgentName": "string",
        "userType": "string"
      },
      "conversation": {
        "id": "string",
        "externalId": "string",
        "externalUrl": "string",
        "type": "openai",
        "supportTicketConversationId": "string",
        "createdAt": "string",
        "updatedAt": "string",
        "projectId": "string",
        "integrationId": "string",
        "properties": {},
        "userProperties": {
          "id": "string",
          "identificationType": "COOKIED",
          "userId": "string",
          "supportAgentName": "string",
          "userType": "string"
        },
        "tags": [
          "string"
        ],
        "visibility": "private",
        "messages": [
          {
            "id": "string",
            "type": "openai",
            "externalId": "string",
            "externalUrl": "string",
            "conversationId": "string",
            "createdAt": "string",
            "updatedAt": "string",
            "role": "system",
            "content": "string",
            "name": "string",
            "links": [
              {
                "label": "string",
                "url": "string",
                "title": "string",
                "description": "string",
                "type": "documentation",
                "breadcrumbs": [
                  "string"
                ]
              }
            ],
            "properties": {},
            "userProperties": {
              "id": "string",
              "identificationType": "COOKIED",
              "userId": "string",
              "supportAgentName": "string",
              "userType": "string"
            },
            "tool_calls": [
              {
                "id": "string",
                "type": "function",
                "function": {
                  "name": "string",
                  "arguments": "string"
                }
              }
            ]
          }
        ],
        "messagesOpenAIFormat": [
          {
            "role": "system",
            "name": "string",
            "content": "string",
            "tool_calls": [
              {
                "id": "string",
                "type": "function",
                "function": {
                  "name": "string",
                  "arguments": "string"
                }
              }
            ]
          }
        ]
      },
      "message": {
        "id": "string",
        "type": "openai",
        "externalId": "string",
        "externalUrl": "string",
        "conversationId": "string",
        "createdAt": "string",
        "updatedAt": "string",
        "role": "system",
        "content": "string",
        "name": "string",
        "links": [
          {
            "label": "string",
            "url": "string",
            "title": "string",
            "description": "string",
            "type": "documentation",
            "breadcrumbs": [
              "string"
            ]
          }
        ],
        "properties": {},
        "userProperties": {
          "id": "string",
          "identificationType": "COOKIED",
          "userId": "string",
          "supportAgentName": "string",
          "userType": "string"
        },
        "tool_calls": [
          {
            "id": "string",
            "type": "function",
            "function": {
              "name": "string",
              "arguments": "string"
            }
          }
        ]
      }
    }
  ],
  "negativeFeedback": [
    {
      "id": "string",
      "type": "positive",
      "messageId": "string",
      "createdAt": "string",
      "reasons": [
        {
          "label": "string",
          "details": "string"
        }
      ],
      "properties": {},
      "userProperties": {
        "id": "string",
        "identificationType": "COOKIED",
        "userId": "string",
        "supportAgentName": "string",
        "userType": "string"
      },
      "conversation": {
        "id": "string",
        "externalId": "string",
        "externalUrl": "string",
        "type": "openai",
        "supportTicketConversationId": "string",
        "createdAt": "string",
        "updatedAt": "string",
        "projectId": "string",
        "integrationId": "string",
        "properties": {},
        "userProperties": {
          "id": "string",
          "identificationType": "COOKIED",
          "userId": "string",
          "supportAgentName": "string",
          "userType": "string"
        },
        "tags": [
          "string"
        ],
        "visibility": "private",
        "messages": [
          {
            "id": "string",
            "type": "openai",
            "externalId": "string",
            "externalUrl": "string",
            "conversationId": "string",
            "createdAt": "string",
            "updatedAt": "string",
            "role": "system",
            "content": "string",
            "name": "string",
            "links": [
              {
                "label": "string",
                "url": "string",
                "title": "string",
                "description": "string",
                "type": "documentation",
                "breadcrumbs": [
                  "string"
                ]
              }
            ],
            "properties": {},
            "userProperties": {
              "id": "string",
              "identificationType": "COOKIED",
              "userId": "string",
              "supportAgentName": "string",
              "userType": "string"
            },
            "tool_calls": [
              {
                "id": "string",
                "type": "function",
                "function": {
                  "name": "string",
                  "arguments": "string"
                }
              }
            ]
          }
        ],
        "messagesOpenAIFormat": [
          {
            "role": "system",
            "name": "string",
            "content": "string",
            "tool_calls": [
              {
                "id": "string",
                "type": "function",
                "function": {
                  "name": "string",
                  "arguments": "string"
                }
              }
            ]
          }
        ]
      },
      "message": {
        "id": "string",
        "type": "openai",
        "externalId": "string",
        "externalUrl": "string",
        "conversationId": "string",
        "createdAt": "string",
        "updatedAt": "string",
        "role": "system",
        "content": "string",
        "name": "string",
        "links": [
          {
            "label": "string",
            "url": "string",
            "title": "string",
            "description": "string",
            "type": "documentation",
            "breadcrumbs": [
              "string"
            ]
          }
        ],
        "properties": {},
        "userProperties": {
          "id": "string",
          "identificationType": "COOKIED",
          "userId": "string",
          "supportAgentName": "string",
          "userType": "string"
        },
        "tool_calls": [
          {
            "id": "string",
            "type": "function",
            "function": {
              "name": "string",
              "arguments": "string"
            }
          }
        ]
      }
    }
  ]
}

{
  "title": "Bad Request",
  "status": 400,
  "detail": "Bad Request",
  "instance": "/conversations/123",
  "requestId": "req_1234567890",
  "code": "bad_request",
  "error": {
    "code": "bad_request",
    "message": "Bad Request"
  }
}

{
  "title": "Unauthorized",
  "status": 401,
  "detail": "Unauthorized",
  "instance": "/conversations/123",
  "requestId": "req_1234567890",
  "code": "unauthorized",
  "error": {
    "code": "unauthorized",
    "message": "Unauthorized"
  }
}

{
  "title": "Forbidden",
  "status": 403,
  "detail": "Forbidden",
  "instance": "/conversations/123",
  "requestId": "req_1234567890",
  "code": "forbidden",
  "error": {
    "code": "forbidden",
    "message": "Forbidden"
  }
}

{
  "title": "Not Found",
  "status": 404,
  "detail": "Not Found",
  "instance": "/conversations/123",
  "requestId": "req_1234567890",
  "code": "not_found",
  "error": {
    "code": "not_found",
    "message": "Not Found"
  }
}

{
  "title": "Unprocessable Entity",
  "status": 422,
  "detail": "Unprocessable Entity",
  "instance": "/conversations/123",
  "requestId": "req_1234567890",
  "code": "unprocessable_entity",
  "error": {
    "code": "unprocessable_entity",
    "message": "Unprocessable Entity"
  }
}

{
  "title": "Internal Server Error",
  "status": 500,
  "detail": "Internal Server Error",
  "instance": "/conversations/123",
  "requestId": "req_1234567890",
  "code": "internal_server_error",
  "error": {
    "code": "internal_server_error",
    "message": "Internal Server Error"
  }
}