gsc

A site's Search Console figures over time

A site's Search Console clicks, impressions, CTR and average position over time, from the data Frontshelf stores: one point per day, week or month over range, the comparison's figures beside each point when compare asks for one, the totals, and coverage (the dates, whether the figures are exact totals or Google's observed top rows, the missing days and why, the provisional and capped days, the snapshot). A missing day is null, never 0: quote the warnings with the figures. second draws a second filter as its own line (paid: compare_filters). A paid feature on a site that is not paid for is BILLING_REQUIRED naming it: hand your human its checkout_url. Next: gsc_table_get for the rows behind a movement.

get/v1/sites/{site}/search/series

Request

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

interval'day' | 'week' | 'month'

One point per day (default; ranges up to 21 days), week (Sunday to Saturday; up to 90 days) or month.

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.

Response

A site's Search Console figures over time

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 the figures are from (ssrc_…).

interval'day' | 'week' | 'month' required

Changes

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