RankSharkDocs
Campaigns

Delete a campaign and all its scans

RankShark TrackScopetrack:delete

DELETE
/v1/track/campaigns/{id}

Its unfinished scans are cancelled first, like POST /v1/track/scans/{id}/cancel: one cancelled before any point gives its points back. This cannot be undone.

Scope: track:delete.

Authorization

headerAuthorizationBearer <rstk_… API key or OAuth access token>

A Track API key (rstk_…, Settings → API & MCP) or an OAuth access token issued for this API

Path Parameters

id*string

Campaign id (gt_…). A malformed id is 404 not_found.

Match^gt_[A-Za-z0-9]{10,40}$

Response Body

OK

application/json
  1. response
ok*boolean
scansDeleted*integer
Example Request
curl -X DELETE 'https://panel.rankshark.io/v1/track/campaigns/gt_8fK2mQ9xLp3s'
Example Response
{  "ok": true,  "scansDeleted": 36}

Create a campaign POST

Validated against the plan (points per scan, keywords per campaign, campaigns, engines). A grid campaign (mode "grid", the default) needs business and grid: find the business with POST /v1/track/find. A website campaign (mode "website") needs domain, location and country, on engine search, bing_search or ai. runNow: true also starts the first scan and needs track:run. Fields not listed in CampaignInput are ignored. Scope: `track:write`.

Get a campaign GET

Scope: `track:read`.