gsc

Choose a site's primary Search Console property

Make one of a site's Search Console properties the primary: the one its dashboard and every gsc read uses unless source_id names another (a Domain property and a URL-prefix property count pages differently). Choosing the primary again changes nothing. Answers the property as gsc_sources_list lists it. A property that is not attached to the site is NOT_FOUND. Not billing-gated.

patch/v1/sites/{site}/search/primary-source

Request

  • Base URL: https://frontshelf.io/api
  • URL: https://frontshelf.io/api/v1/sites/{site}/search/primary-source
  • Auth: HTTP bearer

Path parameters

sitestring required

Site ID (site_…), origin (https://example.com), or bare domain, resolved server-side; the response carries the canonical ID.

Request body

source_idstring required

One of the site's properties (ssrc_…, from gsc_sources_list).

dry_runboolean

true: check the call and say what it would do, without doing it.

confirmboolean

true: go ahead with a change that asks for confirmation.

Response

Choose a site's primary Search Console property

summarystring required

The answer in one or two sentences, with the numbers it rests on.

warningsstring[] required

What limits this answer (a cap, a read that was cut short). Empty when nothing does.

site_idstring required

The site's canonical id.

source_idstring required

The property's id (ssrc_…), the source_id the other gsc reads take.

propertystring required

The property as Google names it (https://example.com/ or sc-domain:example.com).

kind'domain' | 'url_prefix' required
scopestring required

Which pages the property counts, in one sentence.

rolestring required

primary (what the reads use by default) or alternate.

accessstring required

available, reauth or lost.

statusstring required
first_look_atstring nullable required

When the sync marked its first look; null while unmarked, which says nothing about figures.

Changes

No recorded changes to this operation across all 1 revision of this API.