Base URL
Authentication
Generate an API key in the dashboard (API Keys, Custom plan). Send it with every request:- Header (recommended):
X-API-Key: <your_api_key> - Query (optional):
?api_key=<your_api_key>
Endpoints Overview
| Icon | Endpoint | Purpose |
|---|---|---|
| 📈 | POST /reports/brands | Brand visibility metrics by date range |
| 🎯 | POST /reports/queries | Query runs with visibility and sentiment |
| 💬 | POST /reports/mentions | Brand mentions with source and sentiment |
Response Format
Responses are JSON. Errors includeerror and optional message:
Rate Limits
Rate limits may apply. A429 response means you’re over the limit — slow down and retry later.