Get a bot breakdown
GET
Bot requests and visitors per value of one dimension (dim), with their share of all bot 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"dim*stringValue in
"bot_name""bot_operator""bot_category""asn_org""pathname""country""layer"limit?integerRange
1 <= value <= 1000Default
50offset?integerRange
0 <= value <= 100000Default
0OK
application/json- response
data*array<>meta*curl -X GET 'https://pilotfox.app/api/v1/sites/string/bots/breakdown?dim=bot_name'Example Response200
{ "data": [ { "value": "string", "count": 0, "visitors": 0, "percentage": 0, "category": "string", "user_agent": "string" } ], "meta": { "window": { "from": "string", "to": "string", "tz": "string", "bucket": "minute" }, "compare": { "from": "string", "to": "string" }, "totalCount": -9007199254740991, "nextCursor": "string", "truncated": true, "cache": "hit" }}