Campaigns

List campaigns owned by the user

Paginated. Joins through uploads. Requires scope campaigns:read.

get/api/v1/campaigns

Request

Base URL: https://getscaleforge.com
URL: https://getscaleforge.com/api/v1/campaigns
Auth: HTTP bearer

Query parameters

statusstring

Filter by campaign-job status

pageinteger

per_pageinteger

Response

Success

Example response

{
  "data": [
    {
      "id": 5501,
      "campaign_name": "SweepstakesOffer_US_BD4.40",
      "adset_name": "Adset_01",
      "ad_name": "Ad_creative_301",
      "bid_amount": 4.4,
      "status": "completed",
      "meta_status": "ACTIVE",
      "meta_campaign_id": "23851234567890123",
      "meta_adset_id": "23851234567890124",
      "meta_ad_id": "23851234567890125",
      "bid_strategy": "LOWEST_COST_WITH_BID_CAP",
      "daily_budget": 100
    }
  ],
  "meta": {
    "page": 1,
    "per_page": 25,
    "total_count": 137,
    "total_pages": 6
  }
}

Changes

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