Send Hit Event

Send a hit event to register a user view or interaction.

POST /event/hit

Send Hit Event

cURL

curl --request POST \
  --url http://localhost:8080/event/hit \
  --header 'Content-Type: application/json' \
  --data '
{
  "b": "<string>",
  "u": "<string>",
  "p": true,
  "q": true,
  "r": "<string>",
  "t": "<string>",
  "d": {}
}
'

400

{
  "error": {
    "code": 400,
    "message": "<string>"
  }
}

Headers

User-Agent · string

Used to infer user browser, OS and device.

Accept-Language · string

Used to infer user language.

Body

application/json

Hit event metadata.

EventLoad

Website hit event.

b · string · required

Beacon ID generated for each user to link multiple events on the same page together.

u · string<uri> · required

Page URL including query parameters.

p · boolean · required

If the user is a unique user or not.

q · boolean · required

If the user has visited this page before or not.

r · string

Referrer URL.

t · string

Timezone of the user.

d · object

Custom event properties.

Show child attributes

d. {key}

Response

204

OK.