gsc

A site's client report schedules

A site's report schedules, those that exist: the weekly client email (Google's finished week against the week before and a year earlier, the biggest movers, and with their sections on the week's alerts, notes, index losses and Google Analytics; one button to the client link it names) and the monthly PDF (the finished month's PDF, emailed). Each with active, sections, share_link_id, recipients (email, audience team or client, unsubscribed_at), last_period_end, next_run_at and version (what gsc_schedules_save must name). A period is sent to an address at most once, ever. Free.

get/v1/sites/{site}/search/report-schedules

Request

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

Response

A site's client report schedules

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.

truncatedfalse required

Always false: a site has at most two schedules.

totalinteger required

Changes

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