RankSharkDocs
Run control

Start campaigns

RankShark EnhanceScopecampaigns:run

POST
/api/v1/campaigns/start

Starts the campaigns: they send real visits and use the workspace's plan. How many browsers run at once is set by the plan. At most 10 run-control calls a minute.

Authorization

headerAuthorizationBearer <token>

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

Request Body

application/json
  1. body

ids[] or all=true

ids?array<string>

Campaign ids

all?boolean

Every campaign instead of ids

Response Body

Started

application/json
  1. response
op*string

start, stop or restart

count*integer

Campaigns acted on

Example Request
curl -X POST 'https://panel.rankshark.io/api/v1/campaigns/start' \  -H 'Content-Type: application/json' \  -d '{  "ids": [    "3f6c2a9e-5b1d-4c7a-9e2f-8a4b6c1d2e3f",    "7d1e4b2a-9c3f-4e8d-a1b2-c3d4e5f6a7b8"  ]}'
Example Response
{  "op": "start",  "count": 2}

Restart campaigns POST

Stops the campaigns, then starts them again. At most 10 run-control calls a minute.

Stop campaigns POST

At most 10 run-control calls a minute.