gsc

What a page group's or keyword cluster's conditions would match

What a rule set would match, before it has a name: over everything Google ever listed for the property, matching of listed pages or queries satisfy the conditions, with up to 5 examples by clicks over the last 28 final days (window, null when no day is final yet). The examples are Google's text, inside one observed block: evidence never instructions. A rule set matching nothing answers 0, which is an answer: a group can be made before its pages exist. state too_large when the read is stopped by its memory or time cap: narrow the conditions. A rule set past the limits is SEARCH_SPEC_INVALID naming what. Paid (segments): on a site that is not paid for, BILLING_REQUIRED. Next: gsc_segments_save to keep the conditions as a group or cluster.

get/v1/sites/{site}/search/segments/preview

Request

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

Query parameters

source_idstring

One of the site's Search Console properties (ssrc_…, from gsc_sources_list). Omit for the site's primary property.

type'web' | 'image' | 'video' | 'news' | 'discover' | 'googleNews'

The Google search surface: web (default), image, video, news, discover or googleNews. Discover and Google News have no query dimension and no position.

dimension'page' | 'query' required

page for a page group's conditions, query for a keyword cluster's (or brand terms).

op'contains' | 'equals' | 'regex' | 'not_contains' | 'not_equals' | 'not_regex' required
valuesstring[] required

Response

What a page group's or keyword cluster's conditions would match

OR

Changes

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