Get the bot overview
GET
Bot requests against human events in the window, the bot share, what each detection layer flagged, and AI crawler and AI assistant requests.
Requires analytics:read on the site (an API key, or a signed-in member's role). Share links: 401.
header
x-api-key<token>An organization API key (ak_…), with the permissions and the sites it was created with. For servers and scripts: no cookie and no Origin check. Also accepted as Authorization: Bearer ak_… (apiKeyBearer). A request carries one credential: a key sent with a share token or a live session cookie is 400 (details.reason: ambiguous_credentials).
Scope: analytics:read
siteId*stringstart?stringend?stringlast?stringall?"true"Value in
"true"tz?stringbucket?stringValue in
"minute""5m""15m""hour""day""week""month""year"OK
application/json- response
data*meta*curl -X GET 'https://pilotfox.app/api/v1/sites/string/bots/overview'Example Response200
{ "data": { "bot_requests": 0, "human_events": 0, "bot_share": 0, "by_layer": { "ua": 0, "headers": 0, "client": 0, "asn": 0, "rate": 0 }, "ai_crawler_requests": 0, "ai_assistant_requests": 0 }, "meta": { "window": { "from": "string", "to": "string", "tz": "string", "bucket": "minute" }, "compare": { "from": "string", "to": "string" }, "totalCount": -9007199254740991, "nextCursor": "string", "truncated": true, "cache": "hit" }}