Ingest

Ingest server-side event

Accepts one trusted server-side custom event from an API client. This server-to-server endpoint 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. 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/event

Request

  • Base URL: https://demo.hitkeep.com
  • URL: https://demo.hitkeep.com/api/ingest/server/event
  • 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.

namestring required

Custom event name.

propertiesobject
referrerstring
session_idstring uuid

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

timestampstring date-time required

Canonical analytics time in RFC3339 format.

urlstring uri required

Absolute page or event context URL. The hostname resolves the configured HitKeep site.

user_agentstring required

User agent from the original visitor request context.

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.