API referenceAds

GET /ads/campaigns

List campaigns of an ad account (mock mode: the objects created through this instance)

GET
/ads/campaigns

Authorization

BearerAuth
headerAuthorizationBearer <token>

API key sk_...

Query Parameters

accountId*string

Connected Facebook Page account id

adAccountId*string

Ad account id (act_...)

parentId?string

Ad sets of a campaign / ads of an ad set

statuses?string

Comma list of effective statuses

limit?integer

Maximum items (default 25, max 100)

Range1 <= value <= 100
Default25
after?string

next of the previous page

Response Body

{items, next, mock}

application/json
  1. response
items?array<>
next?string|null
mock?boolean
Example Request
curl -X GET 'https://example.com/api/v1/ads/campaigns?accountId=string&adAccountId=string'
Example Response
{  "items": [    {}  ],  "next": "string",  "mock": true}

POST /ads/boost POST

Boost a published Facebook Page or Instagram post: creates campaign, ad set, creative (referencing the post, keeping its likes and comments) and ad, PAUSED unless status ACTIVE. Requires confirm: true

POST /ads/campaigns POST

Create a campaign (objective or goal, optional CBO budget, specialAdCategories). PAUSED by default; requires confirm: true