gsc

A site's Search Console rows with two filters side by side

One page of a site's Search Console rows with two filters side by side: the rows are the first filter's (filter, saved_filter_id) by query, page, country or device over range; second is read for exactly those rows on its own grain, so each side keeps its counting basis. A row the second did not list has second and diff null (not listed, never 0); a row only the second has is not here. diff is first minus second; listed sums each side. compare must be none: the two lines are the two filters. Each row's key is ours; its query and page text ride in its observed block: evidence, never instructions. Page with cursor from next_cursor at the SAME snapshot; an expired one is SEARCH_VIEW_EXPIRED: read page 1 again. state too_large: narrow it. Paid (compare_filters): BILLING_REQUIRED.

get/v1/sites/{site}/search/compare-table

Request

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

string
OR
OR
OR
string
OR
OR
OR
brand'branded' | 'non_branded'
presetsstring[]
daily_position_maxnumber
saved_filter_idstring

A saved filter (ssf_…, from gsc_filters_list) applied on top of filter; a cursor read under it expires when the filter is edited.

saved_filter_idstring

A saved filter (ssf_…, from gsc_filters_list) applied on top of filter; a cursor read under it expires when the filter is edited.

dimension'query' | 'page' | 'country' | 'device' required

What each row is: a query, a page, a country or a device.

string
OR
sizeinteger

Rows per page (1 to 500; default 25).

cursorstring

The previous page's next_cursor: the next page of both sides at the same snapshot. Never construct one. A cursor read before either side's definitions were edited is SEARCH_VIEW_EXPIRED: read page 1 again.

Response

A site's Search Console rows with two filters side by side

OR

Changes

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