PilotFoxDocs
REST APIAPI referenceSearch Console

Link a Search Console property

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

Links the site to a property of an organization connection and queues the import of its last backfillDays days (90 by default, 486 at most). Linking the same property again keeps its data and only widens the history; another property replaces it. Only for callers with access to every site of the organization (403); 400 for a property the Google account cannot read, 409 when the connection needs reconnecting.

Requires site:update 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: site:update

Path Parameters

siteId*string

Request Body

application/json
  1. body
connectionId*string
Match^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$
Formatuuid
property*string
Length1 <= length <= 2048
backfillDays?integer
Range1 <= value <= 486
Default90

Response Body

OK

application/json
  1. response
data*
Example Request
curl -X PUT 'https://pilotfox.app/api/v1/sites/string/search-console' \  -H 'Content-Type: application/json' \  -d '{  "connectionId": "84b500d7-71c8-4b1f-adf4-f1eb0000973d",  "property": "string"}'
Example Response200
{  "data": {    "queued": true  }}