Get the search overview
GET
Clicks, impressions, CTR and average position in the window and per time bucket; with a comparison window, its totals under previous (null when it has no synced data). Days are Google's, in Pacific Time; 404 when the site has no link.
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?stringOK
application/json- response
data*meta*curl -X GET 'https://pilotfox.app/api/v1/sites/string/search-console/overview'Example Response200
{ "data": { "totals": { "clicks": 0, "impressions": 0, "ctr": 0, "position": 0 }, "previous": { "clicks": 0, "impressions": 0, "ctr": 0, "position": 0 }, "series": [ { "clicks": 0, "impressions": 0, "ctr": 0, "position": 0, "date": "string", "provisional": true, "synced": true } ] }, "meta": { "window": { "from": "string", "to": "string", "tz": "America/Los_Angeles", "bucket": "day" }, "compare": { "from": "string", "to": "string" }, "totalCount": 0, "previousAvailable": true, "cache": "hit" }}