List search queries
GET
Clicks, impressions, CTR and average position per search query in the window, searchable (search) and sortable (sort, order), a page at a time (limit and offset; meta.totalCount); with a comparison window, each row's previous figures too.
Requires searchConsole: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: searchConsole:read
siteId*stringstart?stringend?stringlast?stringall?"true"Value in
"true"bucket?stringValue in
"day""week""month"compare?stringValue in
"previous""year"compare_start?stringcompare_end?stringsearch?stringLength
length <= 200sort?stringDefault
"clicks"Value in
"clicks""impressions""ctr""position""clicks_change""key"order?stringDefault
"desc"Value in
"asc""desc"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/search-console/queries'Example Response200
{ "data": [ { "clicks": 0, "impressions": 0, "ctr": 0, "position": 0, "query": "string", "previous": { "clicks": 0, "impressions": 0, "ctr": 0, "position": 0 } } ], "meta": { "window": { "from": "string", "to": "string", "tz": "America/Los_Angeles", "bucket": "day" }, "compare": { "from": "string", "to": "string" }, "totalCount": 0, "previousAvailable": true, "cache": "hit" }}