gsc

Set a site's Search Console brand terms

Set a site's brand terms, the words that make a Search Console query branded (filter.brand: branded or non_branded on gsc_series_get, gsc_table_get and the export). Replaces the whole list; an empty list clears the brand. Set only what your human asked for. A change is a new version of the brand, so every gsc_table_get cursor read under the old terms expires. Paid (brand): on a site that is not paid for, BILLING_REQUIRED.

patch/v1/sites/{site}/search/brand

Request

  • Base URL: https://frontshelf.io/api
  • URL: https://frontshelf.io/api/v1/sites/{site}/search/brand
  • 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

termsstring[] required

The brand terms, at most 100: a query containing any of them is branded. Trimmed and de-duplicated; an empty list clears the brand.

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

Set a site's Search Console brand terms

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.

termsstring[] required

The terms as you sent them.

Changes

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