Skip to content

Agents and bots endpoints ​

Realtime ​

GET /properties/{pid}/realtime?minutes=30 — the last minutes (30 by default) by actor family, active_now (last 5 minutes), live_agents, the minute-by-minute timeline and top_pages. Scope realtime:read.

Element catalog ​

GET /properties/{pid}/elements?q=cart&hostname=shop.example.com&limit=200 — every clicked element: el_selector, el_name (data-ah-name), el_text, clicks, human_clicks, agent_clicks. q searches the selector, name and text. Use it to pick element steps for funnels.

Mixed sessions ​

POST /properties/{pid}/agents/mixed-sessions

json
{ "date_range": "last_7_days", "navigation_modes": ["mixed"], "limit": 50 }

Returns sessions (by default only mixed ones; add agent or human to navigation_modes), each with its segments: actor, agent name, start, end, pages, clicks, form submissions, purchases and revenue, so you can see who did what in each visit. limit up to 500.

Agent readiness funnel ​

POST /properties/{pid}/agents/friction

json
{ "date_range": "last_28_days" }

Compares action agents and humans along a journey and finds the step where agents can't get through while humans can. All fields are optional:

Field
date_rangePreset or {start, end} (default last_28_days).
steps2 to 12 funnel steps (page, event or element, as in funnels). Omit for the default shopping journey.
funnel_idUse the steps of a saved funnel.
window_secondsMax time between the first and last step (default 3600).
modefurthest (furthest step reached; default for the built-in journey) or ordered (steps in order; default for custom steps).

Returns steps (per step: agents and humans, each with units, rate_from_start, rate_from_previous, drop_off), totals, and blocking_step, or null when no step shows a gap of 15 points or more with at least 20 sessions of each group. The blocking step carries the pass-through rates and gap, lost_agent_sessions, time_on_step, elements (clicks per session by group, synthetic clicks), agent_names, upside (extra_orders, extra_revenue, currency) and suggestions. Scope reports:read; Growth plan or above. How it is computed: Find where agents get stuck.

Pages read by bots ​

GET /properties/{pid}/bots/pages?date_range=last_28_days&sort=ai_reads — pages read by indexing bots and AI readers, with reads by bot, verified and spoofed hits, and the page's human page views for comparison.

Parameter
sortai_reads (default: pages AI assistants read most), search_crawls, human_pageviews
path_prefixOnly pages under a path, for example /guides/
limitDefault 100

Requires server-side bot tracking (Pro and Scale) for crawlers that don't run JavaScript.

Agents & humans, every visit counts!