PilotFoxDocs
REST APIAPI referenceSearch Console

Get the site's Search Console status

GET
/api/v1/sites/{siteId}/search-console

Whether the site is linked to a Search Console property, its sync progress and errors, and what the caller may do (canManage, canLink).

Requires searchConsole:read on the site (an API key, or a signed-in member's role). Share links: 401.

Authorization

headerx-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

Path Parameters

siteId*string

Response Body

OK

application/json
  1. response
data*
Example Request
curl -X GET 'https://pilotfox.app/api/v1/sites/string/search-console'
Example Response200
{  "data": {    "configured": true,    "canManage": true,    "canLink": true,    "redirectUri": "string",    "orgConnections": 0,    "link": {      "property": "string",      "status": "backfilling",      "connection": {        "id": "string",        "googleEmail": "string",        "status": "active"      },      "backfill": {        "days": 0,        "total": 0,        "done": 0,        "complete": true      },      "lastSyncAt": "string",      "lastSuccessAt": "string",      "lastError": "string",      "lastErrorAt": "string",      "nextSyncAfter": "string",      "linkedAt": "string",      "data": {        "earliest": "string",        "latest": "string",        "lastComplete": "string"      }    }  }}