Ingest

Ingest server-side pageview

Accepts one trusted server-side pageview from an API client. Use this endpoint for backend forwarding, CMS plugins, reverse proxy forwarding, edge workers, and historical pageview replay. It does not require browser Origin or Referer headers. HitKeep resolves the site from the submitted URL hostname, requires site.manage_data for that resolved site, and uses visitor_ip for ingest-time exclusions, spam filtering, and country, region, city, provider, and ASN lookup. UTM values and hk_qr QR attribution are read from the query string in url, for example utm_source, utm_campaign, and hk_qr on the visitor-facing URL, not from top-level JSON fields. Stored analytics records contain derived country, region, city, provider, and ASN context. HitKeep does not store the raw visitor IP. This endpoint uses the ingest rate limiter.

post/api/ingest/server/pageview

Request

  • Base URL: https://demo.hitkeep.com
  • URL: https://demo.hitkeep.com/api/ingest/server/pageview
  • Auth: one of:
    • HTTP bearer
    • API key in header X-API-Key

Request body

dntboolean

When true, HitKeep drops the record consistently with browser tracker privacy behavior.

languagestring
page_idstring uuid

Optional page identifier. Generated when omitted.

referrerstring
screen_heightinteger
screen_widthinteger
session_idstring uuid

Optional visitor grouping key. If omitted, this record gets its own standalone session.

timestampstring date-time required

Canonical analytics time in RFC3339 format.

urlstring uri required

Absolute page URL. The hostname resolves the configured HitKeep site. UTM values and hk_qr QR attribution are read from this URL query string.

user_agentstring required

User agent from the original visitor request context.

viewport_heightinteger
viewport_widthinteger
visitor_ipstring ip required

Trusted transient visitor IP context. Used to derive country, region, city, provider, and ASN metadata. HitKeep does not store the raw visitor IP.

Response

Accepted. Empty response body.

Changes

No recorded changes to this operation across all 1 revision of this API.