Integrations & API
REST API
Pull aeotime data into dashboards and scripts with the read-only REST API: authentication, endpoints, parameters and examples.
Updated
On this page
The REST API returns the same data you see in the app as JSON. It's read-only and scoped to one workspace.
Authentication
- Open API & MCP in the app sidebar (owners and admins).
- Click Create key, name it, and copy it — the key is shown once.
- Send it with every request:
curl https://api.aeotime.com/v1/public/projects \
-H "Authorization: Bearer aeo_YOUR_KEY"
X-API-Key: aeo_YOUR_KEY works too. Revoke a key any time from the same page; requests with it fail immediately.
Endpoints
| Endpoint | Returns |
|---|---|
GET /v1/public/projects |
Projects in the workspace |
GET /v1/public/projects/{id}/overview |
Visibility, share of voice, position, citation rate, sentiment, per engine, vs previous period |
GET /v1/public/projects/{id}/prompts |
Per-prompt performance |
GET /v1/public/projects/{id}/competitors |
Share of voice by brand and engine |
GET /v1/public/projects/{id}/citations |
Cited domains with counts |
GET /v1/public/projects/{id}/gaps |
Prompts where competitors appear and you don't |
GET /v1/public/projects/{id}/actions |
Action plan with status and impact |
GET /v1/public/projects/{id}/segments |
Visibility by market and persona |
GET /v1/public/projects/{id}/crawlers |
AI crawler activity |
GET /v1/public/projects/{id}/answers |
Latest raw answers |
Parameters
days— look-back window, 1 to 365 (default 30; crawlers up to 90)engine— one ofchatgpt,perplexity,gemini,claude,ai_overview,ai_mode,grok,deepseekanswersalso takesprompt_idandlimit(1–50)
curl "https://api.aeotime.com/v1/public/projects/PROJECT_ID/overview?days=30&engine=chatgpt" \
-H "Authorization: Bearer aeo_YOUR_KEY"
Errors
| Status | Meaning |
|---|---|
| 401 | Missing, invalid or revoked key |
| 402 | The workspace has no active subscription |
| 404 | The project doesn't exist in this workspace |
| 422 | Invalid parameter, such as an unknown engine |
Using it with Looker Studio and spreadsheets
Most BI tools can read JSON from a URL with a header. Call the endpoints on a schedule and store the results, or use Export CSV in the app for one-off analysis. Weekly tracking means daily polling adds nothing — once a day is plenty.
Questions
Is the API included in my plan?
Yes. The REST API and MCP server are included in every paid plan and during the trial.
Can the API change data?
No. The API is read-only. Prompts, competitors and settings are managed in the app.
Still stuck? We answer within one business day.
Contact support