RankSharkDocs
Campaigns

Count campaigns by state

RankShark EnhanceScopecampaigns:read

GET
/api/v1/campaigns/overview

Authorization

headerAuthorizationBearer <token>

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

Response Body

OK

application/json
  1. response
total?integer
running?integer
stopped?integer
completed?integer
archived?integer
Example Request
curl -X GET 'https://panel.rankshark.io/api/v1/campaigns/overview'
Example Response
{  "total": 0,  "running": 0,  "stopped": 0,  "completed": 0,  "archived": 0}

Copy a campaign POST

Makes count copies ("<name> (copy)", stopped, counters at zero).

Create a campaign POST

Send {"spec": CampaignSpec} (the input contract, GET /api/v1/schema/spec) or a full campaign document. Validate first with the same body and the MCP tool enhance_validate_campaign, or check a workflow with POST /api/v1/flows/validate. The new campaign is not started: POST /api/v1/campaigns/start.