Skip to content
HitKeep
Search
Ctrl
K
Cancel
GitHub
Email
Select theme
Dark
Light
Auto
Start Here
Introduction
Installation
Installation
Binary Installation
Docker Compose
Kubernetes
Trusted Proxies
Analytics
Period-over-Period Comparison
Event Analytics
Funnels
Goals
Tracking
Custom Events
IP Exclusions
UTM Parameters
Sharing
Shareable Dashboards
Security
API Clients
Account Recovery
Two-Factor Authentication
Verifying Artifacts
Notifications
Email Reports
Administration
Roles and Permissions
Data Management
Data Retention and Archiving
Data Takeout & Export
Reference
Configuration
Architecture
Security Overview
Tech Stack
Support
Getting Help
Contributing
Localizing the UI
Supporting HitKeep
Comparisons
HitKeep vs Google Analytics (GA4)
HitKeep vs Matomo
HitKeep vs Plausible Analytics
HitKeep vs Umami
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
Verify MFA TOTP
Finish passkey login
Start passkey login
Complete password reset
Create initial admin
Login
Logout
Change password
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
Finish passkey registration
Start passkey registration
Delete passkey
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)
List users
Delete user
Update user role
List site members
Add site member
Remove site member
Sites
Overview
Get favicon
List accessible sites
Create site
Delete site
List site exclusions
Create site exclusion
Delete site exclusion
Get site hits
Export site hits
Update retention policy
List event names
List event property keys
Event property breakdown
Event timeseries
Event audience breakdown
Get site stats
Goals
Overview
List goals
Create goal
Goal timeseries
Delete goal
Funnels
Overview
List funnels
Create funnel
Funnel timeseries
Delete funnel
Funnel stats
Share
Overview
Get shared site
Shared funnels
Shared funnel timeseries
Shared funnel stats
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
Legal
Imprint
GitHub
Email
Select theme
Dark
Light
Auto
☁️
HitKeep Cloud
is coming!
Join the Early Access waitlist →
Instance status
GET
/api/status
Local Development
Setup and version status.
Responses
Section titled “ Responses ”
200
Section titled “200 ”
Status payload
Select media type
application/json
object
needs_setup
boolean
version
string
