Skip to content
HitKeep
Search
Ctrl
K
Cancel
Start In Cloud
Log in
EU
Cloud EU
cloud.hitkeep.eu
US
Cloud US
cloud.hitkeep.com
GitHub
Email
Select theme
Dark
Light
Auto
Get Started
Introduction
HitKeep Cloud
Installation
Deployment Guides
Binary Installation
Docker Compose
Kubernetes
Trusted Proxies
Configuration
Public Roadmap
Use HitKeep
Analytics & Reporting
AI Chatbot Analytics
AI Visibility Analytics
Period-over-Period Comparison
Ecommerce Analytics
Event Analytics
Funnels
Goals
Shareable Dashboards
Email Reports
Tracking & Attribution
AI Fetch on AWS
Automatic Events
Custom Events
IP Exclusions
Bot and Spam Filtering
UTM Parameters
Access & Administration
API Clients
Account Recovery
Two-Factor Authentication
Verifying Artifacts
Roles and Permissions
Teams and Data Isolation
Backups & Data Lifecycle
Backups and Restore
Disaster Recovery
Data Retention and Archiving
S3 Backups
Data Takeout & Export
Reference & Compliance
Architecture
Security Overview
Tech Stack
Compliance
Overview
GDPR
PECR and ePrivacy
CCPA and CPRA
Digital Sovereignty
Help & Project
Getting Help
Contributing
Localizing the UI
Supporting HitKeep
Comparisons
HitKeep vs Adobe Analytics
HitKeep vs Cloudflare Web Analytics: Full-Featured Self-Hosted Alternative
HitKeep vs Fathom Analytics: Self-Hosted Privacy Analytics You Own
HitKeep vs GoatCounter
HitKeep vs Google Analytics: Privacy-First Self-Hosted Alternative
HitKeep vs Matomo: Simpler Self-Hosted Analytics Without PHP
HitKeep vs Offen: AI Performance Analytics vs Consent-First Fair Analytics
HitKeep vs Pirsch Analytics
HitKeep vs Piwik PRO
HitKeep vs Plausible: Single Binary Self-Hosted Analytics
HitKeep vs PostHog
HitKeep vs Rybbit: Single Binary vs ClickHouse Stack
HitKeep vs Simple Analytics: Self-Hosted Privacy Analytics With More Depth
HitKeep vs Umami: Zero-Dependency Self-Hosted Analytics
HitKeep vs Vince: Single-Binary Analytics in Go
Changelog
Overview
v2.2.1
v2.2.0
v2.1.0
v2.0.1
v2.0.0
v1.8.1
v1.8.0
v1.7.0
v1.6.0
v1.5.4
REST API
Overview
System
Overview
OpenAPI v1 document
List API doc versions
Instance status
Health check
Readiness check
Ingest
Overview
Ingest pageview
Preflight ingest
Ingest custom event
Preflight event ingest
Auth
Overview
Accept invite
Request password reset
Request MFA email sign-in link
Verify MFA email sign-in link
Verify MFA recovery code
Verify MFA TOTP
Finish passkey login
Start passkey login
Complete password reset
Create initial admin
Login
Logout
Change password
Cloud
Overview
Create billing checkout session
Create billing portal session
Create managed cloud account
Stripe webhook
User
Overview
List API clients
Create API client
Update API client
Delete API client
Get avatar
Get current IP
Get user preferences
Update user preferences
Get profile
Update profile
Get user security status
Delete passkey
Finish passkey registration
Start passkey registration
Regenerate recovery codes
Disable TOTP
Start TOTP setup
Verify TOTP setup
Permissions
Overview
Get permission context
Admin
Overview
List global exclusions
Create global exclusion
Delete global exclusion
List all sites
Delete site (admin)
Delete archived team
List users
Delete user
Disable user MFA
Update user role
List site members
Add site member
Remove site member
Sites
Overview
Get favicon
List accessible sites
Create site
Delete site
Export AI chatbot events
Get AI fetch correlation report
Export AI fetch records
Get AI fetch overview
Get AI fetch timeseries
Get ecommerce summary
Get top ecommerce products
Get ecommerce sources
Get ecommerce timeseries
List site exclusions
Create site exclusion
Delete site exclusion
Get site hits
Export site hits
Record AI fetch
Update retention policy
Get site stats
Transfer site to another team
Goals
Overview
List goals
Create goal
Delete goal
Goal timeseries
Funnels
Overview
List funnels
Create funnel
Delete funnel
Funnel stats
Funnel timeseries
Share
Overview
Get shared site
Shared funnels
Shared funnel stats
Shared funnel timeseries
Shared goals
Shared goal timeseries
Shared hits
Export shared hits
Shared site stats
List share links
Create share link
Delete share link
Takeout
Overview
Site takeout
User takeout
Reports
Overview
Get report subscriptions
Update digest subscription
Update site report subscription
Teams
Overview
List teams
Create team
Update team (deprecated)
Update team
List team API clients
Create team API client
Update team API client
Delete team API client
Archive team
List team audit log
List team invites
Revoke team invite
Resend team invite
Leave team
List team members
Invite team member
Remove team member
Transfer team ownership
Set active team
Legal
Privacy Policy (Cloud)
Terms of Service (Cloud)
Imprint
GitHub
Email
Select theme
Dark
Light
Auto
Preflight event ingest
OPTIONS
/ingest/event
CORS preflight for custom event ingest.
Responses
Section titled “ Responses ”
200
Section titled “200 ”
Preflight response
