Log Event - Inkeep

Authorization

AuthorizationRequiredBearer <token>

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

In: header

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.

bodyRequiredobject | object | object

Response Body

Event logged successfully

TypeScript Definitions

Use the response body type in TypeScript.

responseRequiredobject | object | 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.

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 POST "https://api.analytics.inkeep.com/events" \
  -H "Authorization: Bearer <token>" \
  -H "Content-Type: application/json" \
  -d '{
    "id": "string",
    "type": "string",
    "messageId": "string",
    "createdAt": "2019-08-24T14:15:22Z",
    "projectId": "string",
    "integrationId": "string",
    "properties": {},
    "userProperties": {
      "id": "string",
      "identificationType": "COOKIED",
      "userId": "string",
      "supportAgentName": "string",
      "userType": "string"
    },
    "entityType": "message"
  }'

const body = JSON.stringify({
  "id": "string",
  "type": "string",
  "messageId": "string",
  "createdAt": "2019-08-24T14:15:22Z",
  "projectId": "string",
  "integrationId": "string",
  "properties": {},
  "userProperties": {
    "id": "string",
    "identificationType": "COOKIED",
    "userId": "string",
    "supportAgentName": "string",
    "userType": "string"
  },
  "entityType": "message"
})

fetch("https://api.analytics.inkeep.com/events", {
  headers: {
    "Authorization": "Bearer <token>"
  },
  body
})

package main

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

func main() {
  url := "https://api.analytics.inkeep.com/events"
  body := strings.NewReader(`{
    "id": "string",
    "type": "string",
    "messageId": "string",
    "createdAt": "2019-08-24T14:15:22Z",
    "projectId": "string",
    "integrationId": "string",
    "properties": {},
    "userProperties": {
      "id": "string",
      "identificationType": "COOKIED",
      "userId": "string",
      "supportAgentName": "string",
      "userType": "string"
    },
    "entityType": "message"
  }`)
  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/events"
body = {
  "id": "string",
  "type": "string",
  "messageId": "string",
  "createdAt": "2019-08-24T14:15:22Z",
  "projectId": "string",
  "integrationId": "string",
  "properties": {},
  "userProperties": {
    "id": "string",
    "identificationType": "COOKIED",
    "userId": "string",
    "supportAgentName": "string",
    "userType": "string"
  },
  "entityType": "message"
}
response = requests.request("POST", url, json = body, headers = {
  "Authorization": "Bearer <token>",
  "Content-Type": "application/json"
})

print(response.text)

{
  "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"
  }
}