API Reference
REST API endpoints for server-side integration, event ingestion, and layout retrieval.
Base URL
bash
For self-hosted deployments, use your own API endpoint.
Authentication
The API supports multiple authentication methods depending on the use case:
SDK Requests (Client-side)
Requests from the SDK are authenticated via domain whitelist. Add your domains in the dashboard settings.
Server-to-Server
Use API keys for server-to-server communication:
bash
Warning
Keep API keys secret. Never expose them in client-side code or public repositories.
Endpoints
Error Handling
All errors return a consistent JSON structure:
json
HTTP Status Codes
200Success400Bad Request401Unauthorized403Forbidden404Not Found429Rate Limited500Server ErrorRate Limits
API requests are rate limited per App ID:
Events API
1,000 requests/minute
Layout API
500 requests/minute
Need higher limits?
Contact us for enterprise rate limits tailored to your traffic.