Submit Feedback
Authorization
Authorization
RequiredBearer <token>The API key for an API integration. For more details, see authentication documentation
In: header
Request Body
application/json
RequiredNote: The maximum size of the request body is 2 MB.
id
stringtype
Requiredstring"positive" | "negative"
messageId
RequiredstringcreatedAt
string | null | nullA timestamp in ISO 8601 format with timezone information. If not provided, the current time will be used.
"date-time"
reasons
array<object> | null | nullproperties
object | null | nullA customizable collection of custom properties or attributes.
userProperties
object | null | nullA 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
TypeScript Definitions
Use the response body type in TypeScript.
id
Requiredstringtype
Requiredstring"positive" | "negative"
messageId
RequiredstringcreatedAt
Requiredstringreasons
array<object> | null | nullproperties
object | null | nullA customizable collection of custom properties or attributes.
userProperties
object | null | nullA 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.
Bad Request
TypeScript Definitions
Use the response body type in TypeScript.
title
RequiredstringA short, human-readable summary of the problem type.
status
RequirednumberThe HTTP status code.
400
detail
RequiredstringA detailed explanation specific to this occurrence of the problem, providing context and specifics about what went wrong.
instance
stringA URI reference that identifies the specific occurrence of the problem.
requestId
stringA unique identifier for the request, useful for troubleshooting.
code
RequiredstringA short code indicating the error code returned.
"bad_request"
error
RequiredobjectLegacy error format for backward compatibility.
Unauthorized
TypeScript Definitions
Use the response body type in TypeScript.
title
RequiredstringA short, human-readable summary of the problem type.
status
RequirednumberThe HTTP status code.
401
detail
RequiredstringA detailed explanation specific to this occurrence of the problem, providing context and specifics about what went wrong.
instance
stringA URI reference that identifies the specific occurrence of the problem.
requestId
stringA unique identifier for the request, useful for troubleshooting.
code
RequiredstringA short code indicating the error code returned.
"unauthorized"
error
RequiredobjectLegacy error format for backward compatibility.
Forbidden
TypeScript Definitions
Use the response body type in TypeScript.
title
RequiredstringA short, human-readable summary of the problem type.
status
RequirednumberThe HTTP status code.
403
detail
RequiredstringA detailed explanation specific to this occurrence of the problem, providing context and specifics about what went wrong.
instance
stringA URI reference that identifies the specific occurrence of the problem.
requestId
stringA unique identifier for the request, useful for troubleshooting.
code
RequiredstringA short code indicating the error code returned.
"forbidden"
error
RequiredobjectLegacy error format for backward compatibility.
Unprocessable Entity
TypeScript Definitions
Use the response body type in TypeScript.
title
RequiredstringA short, human-readable summary of the problem type.
status
RequirednumberThe HTTP status code.
422
detail
RequiredstringA detailed explanation specific to this occurrence of the problem, providing context and specifics about what went wrong.
instance
stringA URI reference that identifies the specific occurrence of the problem.
requestId
stringA unique identifier for the request, useful for troubleshooting.
code
RequiredstringA short code indicating the error code returned.
"unprocessable_entity"
error
RequiredobjectLegacy error format for backward compatibility.
Internal Server Error
TypeScript Definitions
Use the response body type in TypeScript.
title
RequiredstringA short, human-readable summary of the problem type.
status
RequirednumberThe HTTP status code.
500
detail
RequiredstringA detailed explanation specific to this occurrence of the problem, providing context and specifics about what went wrong.
instance
stringA URI reference that identifies the specific occurrence of the problem.
requestId
stringA unique identifier for the request, useful for troubleshooting.
code
RequiredstringA short code indicating the error code returned.
"internal_server_error"
error
RequiredobjectLegacy error format for backward compatibility.
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"
}
}'
const body = JSON.stringify({
"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"
}
})
fetch("https://api.analytics.inkeep.com/feedback", {
headers: {
"Authorization": "Bearer <token>"
},
body
})
package main
import (
"fmt"
"net/http"
"io/ioutil"
"strings"
)
func main() {
url := "https://api.analytics.inkeep.com/feedback"
body := strings.NewReader(`{
"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"
}
}`)
req, _ := http.NewRequest("POST", url, body)
req.Header.Add("Authorization", "Bearer <token>")
req.Header.Add("Content-Type", "application/json")
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"
body = {
"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"
}
}
response = requests.request("POST", url, json = body, headers = {
"Authorization": "Bearer <token>",
"Content-Type": "application/json"
})
print(response.text)
{
"id": "string",
"type": "positive",
"messageId": "string",
"createdAt": "string",
"reasons": [
{
"label": "string",
"details": "string"
}
],
"properties": {},
"userProperties": {
"id": "string",
"identificationType": "COOKIED",
"userId": "string",
"supportAgentName": "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": "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"
}
}