Skip to content

Public API ​

The Eureka Analytics public API gives you programmatic access to everything you see in the app: reports, funnels, paths, realtime, the Agents & bots analyses, questions in plain English, configuration, server-side events, raw exports and GDPR requests.

bash
curl https://api.eureka-analytics.com/v1/properties \
  -H "Authorization: Bearer $AH_API_KEY"

At a glance ​

Base URLhttps://api.eureka-analytics.com/v1 (self-hosted: https://<your api host>/v1)
FormatJSON in and out, UTF-8
AuthenticationAuthorization: Bearer ahk_live_… organization API keys with scopes. Details
PlansFull API on Pro and Scale. Growth includes read-only keys for the MCP server.
Errorsapplication/problem+json (RFC 9457) with a stable code. Details
Rate limitsPer key: Pro 600 requests/min, Scale 3,000/min, MCP keys 120/min
Versioningv1 in the path. Additive changes only within v1 (new endpoints, new optional fields).
OpenAPIGET /v1/openapi.json, also rendered in the full reference

The actor filter, everywhere ​

Every analytical endpoint accepts the same actor parameter as the app's actor filter:

actorIncludes
all (default)Everything
humans_and_agentsAction agents and humans, no indexing bots
humansHumans
action_agentsAI agents and scripted browsers
indexing_botsCrawlers, AI readers, monitoring
mixed_sessionsSessions where a human and an agent took turns

What you can build ​

  • Dashboards and BI: pull agent and human KPIs into Looker Studio, Power BI, Metabase or a spreadsheet every morning.
  • Alerts: watch the agent funnel and get notified when agents start failing a checkout step.
  • Server-side tracking: send events from your backend or mobile app (POST /properties/{pid}/events).
  • Data warehouse: export raw events daily to your warehouse.
  • AI workflows: use the MCP server to let Claude or another assistant answer questions on your data.

Endpoints ​

AreaEndpoints
Properties and catalogGET /properties, GET /properties/{pid}, GET /catalog, GET /templates, GET /templates/{id}
Reports and templatesPOST /properties/{pid}/reports/run, POST /properties/{pid}/templates/{id}/run, GET /properties/{pid}/summary
Funnels, paths, retentionPOST /properties/{pid}/funnels/run, saved funnels, POST /properties/{pid}/paths/run, POST /properties/{pid}/retention/run
Agents and botsGET /properties/{pid}/realtime, GET /properties/{pid}/elements, POST /properties/{pid}/agents/mixed-sessions, GET /properties/{pid}/bots/pages
AskPOST /properties/{pid}/ask
EventsPOST /properties/{pid}/events
ExportsGET /properties/{pid}/exports/events
ConfigurationGoals, funnels, segments, annotations
PrivacyGET and DELETE /properties/{pid}/subjects/{id}
UsageGET /usage

Agents & humans, every visit counts!