Collection

Send session recordings or heatmap data

POST/api/record

Stores session replay events or heatmap clicks and scrolls for a website, using a valid tracking cache token to identify the session and visit.

Request body

Name	Type	Description
anyOf	anyOf

Example request

{
  "payload": {
    "events": [
      {}
    ],
    "timestamp": 0,
    "website": "123e4567-e89b-12d3-a456-426614174000"
  },
  "type": {}
}

Responses

200The operation completed successfully.

Name	Type	Description
anyOf	anyOf

200 example

{
  "ok": true
}

400Bad request.

Name	Type	Description
errorrequired	object	Error details returned when the operation fails.

400 example

{
  "error": {
    "code": "bad-request",
    "message": "Bad request.",
    "status": 400
  }
}

403Forbidden.

Name	Type	Description
errorrequired	object	Error details returned when the operation fails.

403 example

{
  "error": {
    "code": "forbidden",
    "message": "Forbidden.",
    "status": 403
  }
}

413Payload too large.

Name	Type	Description
errorrequired	object	Error details returned when the operation fails.

413 example

{
  "error": {
    "code": "payload-too-large",
    "message": "Payload too large.",
    "status": 413
  }
}

500Server error.

Name	Type	Description
errorrequired	object	Error details returned when the operation fails.

500 example

{
  "error": {
    "code": "server-error",
    "message": "Server error.",
    "status": 500
  }
}

Code samples

cURL

curl -X POST 'https://api.example.com/api/record' \
  -H 'Content-Type: application/json' \
  -d '{
  "payload": {
    "events": [
      {}
    ],
    "timestamp": 0,
    "website": "123e4567-e89b-12d3-a456-426614174000"
  },
  "type": {}
}'

PreviousSend a batch of tracking requests NextSend tracking data