RankSharkDocs
Campaigns

Delete every campaign and erase their data (irreversible)

RankShark EnhanceScopecampaigns:delete

DELETE
/api/v1/campaigns

Deleting is permanent and cannot be undone: the campaign is stopped and deleted, and its visits, statistics, daily totals, sessions, log lines and report screenshots are erased (dashboard totals no longer include it). To keep a campaign's history, archive it instead. Deletes every campaign that is not archived; requires ?confirm=DELETE_ALL. Scope campaigns:delete; at most 10 a minute.

Authorization

headerAuthorizationBearer <token>

An Enhance API key (rsen_…) or an OAuth 2.1 access token, as "Authorization: Bearer …".

Query Parameters

confirm*"DELETE_ALL"

Must be DELETE_ALL

Value in"DELETE_ALL"

Response Body

Deleted

application/json
  1. response
deleted*string

The id, or "all"

erased?boolean

Its data was erased too

Example Request
curl -X DELETE 'https://panel.rankshark.io/api/v1/campaigns?confirm=DELETE_ALL'
Example Response
{  "deleted": "all",  "erased": true}

Delete a campaign and erase its data (irreversible) DELETE

Deleting is permanent and cannot be undone: the campaign is stopped and deleted, and its visits, statistics, daily totals, sessions, log lines and report screenshots are erased (dashboard totals no longer include it). To keep a campaign's history, archive it instead. Scope campaigns:delete; at most 10 a minute.

Get a campaign GET

Next Page