Api
API Overview
Core concepts for calling the Streakfox HTTP and Webhook APIs.
Every API request lives under https://api.streakfox.com. Most endpoints identify the project via siteKey (project ID) and validate the request origin.
Authentication
- Browser: Use the Web SDK or widget script. Requests are gated by
Originand your project's allowed domains. - Server: Use admin tokens only for privileged routes like
/admin/alias.
Rate limits
Each project is limited to 50 requests per second by default. Contact support for higher throughput.
Resources
| Resource | Description |
|---|---|
/v1/e | Record streak events |
/v1/state | Fetch widget state for a user |
/v1/alias | Alias anonymous users via a signed token |
/admin/alias | Alias users with an admin token (server-only) |
Jump into the dedicated pages for request/response references and sample code.