Analytics apiEvent

Log Event

Copy page

POST
/events
AuthorizationBearer <token>

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

In: header

Note: The maximum size of the request body is 2 MB.

id?string
Length1 <= length
typestring
messageIdstring
createdAt?string | null

A timestamp in ISO 8601 format with timezone information. If not provided, the current time will be used.

Formatdate-time
projectId?string | null
integrationId?string | null
properties?object | null

A customizable collection of custom properties or attributes.

Empty Object

userProperties?object | 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.

entityTypestring
Value in"message"
id?string
Length1 <= length
typestring
conversationIdstring
createdAt?string | null

A timestamp in ISO 8601 format with timezone information. If not provided, the current time will be used.

Formatdate-time
projectId?string | null
integrationId?string | null
properties?object | null

A customizable collection of custom properties or attributes.

Empty Object

userProperties?object | 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.

entityTypestring
Value in"conversation"
id?string
Length1 <= length
typestring
searchQuerystring
createdAt?string | null

A timestamp in ISO 8601 format with timezone information. If not provided, the current time will be used.

Formatdate-time
projectId?string | null
integrationId?string | null
properties?object | null

A customizable collection of custom properties or attributes.

Empty Object

userProperties?object | 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.

entityTypestring
Value in"search"

Response Body

curl -X POST "https://api.analytics.inkeep.com/events" \
  -H "Content-Type: application/json" \
  -d '{
    "type": "string",
    "messageId": "string",
    "entityType": "message"
  }'
{
  "id": "string",
  "type": "string",
  "messageId": "string",
  "createdAt": "string",
  "projectId": "string",
  "integrationId": "string",
  "properties": {},
  "userProperties": {
    "id": "string",
    "identificationType": "COOKIED",
    "userId": "string",
    "supportAgentName": "string",
    "userType": "string"
  },
  "entityType": "message"
}
{
  "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"
  }
}