gsc

Delete a page group or keyword cluster

Delete one page group or keyword cluster, at the version you read. A saved filter or a dashboard URL that names it is refused from then on, and a note scoped to it keeps testing the conditions it stored; it cannot be undone (your human would have to save it again), so delete only what they asked you to. It asks for confirmation: call it with dry_run: true to see what it would delete, then with confirm: true. A version someone has written since is VERSION_CONFLICT and nothing is deleted. The segment is read through site first (search:read): one that is not there, or another site's, is NOT_FOUND. Not billing-gated.

delete/v1/sites/{site}/search/segments/{segment_id}

Request

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

segment_idstring required

The segment's id (sseg_…), from gsc_segments_list.

Query parameters

expected_versioninteger required

The version you read (gsc_segments_list); a version someone has written since is VERSION_CONFLICT and nothing is deleted.

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

Delete a page group or keyword cluster

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.

segment_idstring required
deletedtrue required

Changes

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