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

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.

Website hit event.

b
string
required

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

u
string
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.

Response

204
_mintlify/placeholder

OK.