Skip to content
Start in Cloud

Ingest pageview

POST
/ingest
curl --request POST \
--url https://hitkeep.com/ingest \
--header 'Content-Type: application/json' \
--data '{ "lang": "example", "page_id": "2489E9AD-2EE2-8E00-8EC9-32D5F69181C0", "path": "example", "referrer": "example", "sc_h": 1, "sc_w": 1, "session_id": "2489E9AD-2EE2-8E00-8EC9-32D5F69181C0", "u_cmp": "example", "u_cnt": "example", "u_med": "example", "u_src": "example", "u_trm": "example", "ua": "example", "unique": true, "vp_h": 1, "vp_w": 1 }'

Ingests a pageview hit from the browser tracker. This public endpoint expects the compact hk.js payload and browser Origin request context. Trusted server-side pageviews should use POST /api/ingest/server/pageview instead.

Media type application/json
object
lang
string
page_id
required
string format: uuid
path
required
string
referrer
string
sc_h
integer
sc_w
integer
session_id
required
string format: uuid
u_cmp
string
u_cnt
string
u_med
string
u_src
string
u_trm
string
ua
string
unique
boolean
vp_h
integer
vp_w
integer
Example generated
{
"lang": "example",
"page_id": "2489E9AD-2EE2-8E00-8EC9-32D5F69181C0",
"path": "example",
"referrer": "example",
"sc_h": 1,
"sc_w": 1,
"session_id": "2489E9AD-2EE2-8E00-8EC9-32D5F69181C0",
"u_cmp": "example",
"u_cnt": "example",
"u_med": "example",
"u_src": "example",
"u_trm": "example",
"ua": "example",
"unique": true,
"vp_h": 1,
"vp_w": 1
}

Accepted

Invalid request

Media type application/json
object
message
string
Example generated
{
"message": "example"
}