Analytics apiFeedback
Get All Feedback
Copy page
AuthorizationBearer <token>
The API key for an API integration. For more details, see authentication documentation
In: header
Query Parameters
limit?integer | null
Default
10Range
0 <= value <= 100offset?integer | null
Default
0Range
0 <= valueResponse Body
curl -X GET "https://api.analytics.inkeep.com/feedback?limit=10&offset=0"{
"positiveFeedbackCount": 0,
"negativeFeedbackCount": 0,
"positiveFeedback": [
{
"id": "string",
"type": "positive",
"messageId": "string",
"createdAt": "string",
"updatedAt": "string",
"reasons": [
{
"label": "string",
"details": "string"
}
],
"details": "string",
"properties": {},
"userProperties": {
"id": "string",
"identificationType": "COOKIED",
"userId": "string",
"supportAgentName": "string",
"supportAgentEmail": "string",
"userType": "string"
},
"sources": [
{
"type": "positive",
"title": "string",
"url": "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",
"supportAgentEmail": "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",
"supportAgentEmail": "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",
"supportAgentEmail": "string",
"userType": "string"
},
"tool_calls": [
{
"id": "string",
"type": "function",
"function": {
"name": "string",
"arguments": "string"
}
}
]
}
}
],
"negativeFeedback": [
{
"id": "string",
"type": "positive",
"messageId": "string",
"createdAt": "string",
"updatedAt": "string",
"reasons": [
{
"label": "string",
"details": "string"
}
],
"details": "string",
"properties": {},
"userProperties": {
"id": "string",
"identificationType": "COOKIED",
"userId": "string",
"supportAgentName": "string",
"supportAgentEmail": "string",
"userType": "string"
},
"sources": [
{
"type": "positive",
"title": "string",
"url": "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",
"supportAgentEmail": "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",
"supportAgentEmail": "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",
"supportAgentEmail": "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"
}
}