campaigns

Run Campaign

Trigger a new run for all campaign geos.

post/api/v1/campaigns/{campaign_id}/run

Request

  • Base URL: https://app.kaminari.ad
  • URL: https://app.kaminari.ad/api/v1/campaigns/{campaign_id}/run
  • Auth: HTTP bearer

Path parameters

campaign_idstring uuid required

Response

Successful Response

idstring uuid required
campaign_idstring uuid required
labelstring required
totalinteger required
completedinteger required
failedinteger required
partialinteger required
cancelledinteger required
source'ui' | 'api' required

Where the run was initiated from.

UI — explicit POST /campaigns/{id}/run from the dashboard. API — auto-created bucket for POST /api/v1/scans requests that carry a campaign_id but no run_id. One API run per (campaign, organization, UTC-day).

created_atstring date-time required

Changes

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