Account Groups4

Account Settings9

Accounts16

Ad Accounts47

Ad Audiences7

Ad Campaigns50

Ad Creatives17

Ad Insights11

Ad Library1

Ad Targeting5

Analytics25

API Keys4

Blogs10

Broadcasts10

Business Agent55

Calls3

Comment Automations6

Comments15

Connect57

Connected Apps2

Contacts7

Conversions14

Custom Fields6

Discord24

GMB Attributes3

GMB Food Menus2

GMB Location Details2

GMB Media3

GMB Place Actions4

GMB Reviews5

GMB Services2

GMB Verifications4

iMessage17

Inbox Analytics7

Instagram5

Invites1

Lead Gen8

LinkedIn Mentions1

Logs1

Media1

Mentions2

Messages16

Messaging Ads3

Phone Numbers30

Posts10

Product Catalogs19

Products3

Profiles5

Queue6

Reach and Frequency4

Reddit Search2

Reviews3

Sequences10

Slack1

SMS22

Tools1

Tracking Tags10

Twitter Engagement8

Usage6

Users2

Validate4

Verify3

Voice18

Webhooks7

WhatsApp46

WhatsApp Calling16

WhatsApp Flows15

WhatsApp Phone Numbers16

WhatsApp Sandbox3

WhatsApp Templates1

Workflows14

Webhooks

Webhook Events55

Ad Campaigns

List campaigns

Returns campaigns as virtual aggregations over ad documents grouped by platform campaign ID. Metrics (spend, impressions, clicks, etc.) are summed across all ads in each campaign. Campaign status is derived from child ad statuses (active > pending_review > paused > error > completed > cancelled > rejected). Google campaign budgets include amountMicros, explicitlyShared, resourceName and deliveryMethod after the next successful sync. This endpoint does not fetch Google live.

get/v1/ads/campaigns

Query parameters

includeEmptyboolean

Meta only. Campaign reads aggregate over ad documents, so a campaign with ZERO ads is normally invisible here, the state the two-step create (campaign, then ads via existingCampaignId) leaves behind whenever Meta rejects the ad step. Set true to list those too, with adCount: 0 and zeroed metrics. Requires accountId and adAccountId, since an empty campaign has no ad row to resolve a token or ad account from.

pageinteger

Page number (1-based)

limitinteger

source'zernio' | 'all'

all (default) returns both Zernio-created ads and those discovered from the platform's ad manager. Matches the web UI's default view. Pass zernio to restrict to isExternal=false only. Status is NOT filtered by default; use the status param for that.

Filter by derived campaign status (post-aggregation)

adAccountIdstring

Platform ad account ID (e.g. act_123 for Meta)

pageIdstring

Meta only: Facebook Page ID. Campaigns have no Page of their own, so this keeps campaigns having at least one ad backed by this Page, with adCount and metrics computed over those ads only. Mirrors the same filter on /v1/ads and /v1/ads/tree.

accountIdstring

Account ID

profileIdstring

Profile ID

fromDatestring date

Start of metrics date range (YYYY-MM-DD, inclusive). Defaults to 90 days ago when both date params are omitted.

toDatestring date

End of metrics date range (YYYY-MM-DD, inclusive). Defaults to today. Max 730-day range.

hasDeliveryboolean

Return only campaigns that delivered between fromDate and toDate: spend above zero, or impressions served at zero spend. Unlike status, which reads a campaign's CURRENT state, this filters on what happened inside the window. Filters the campaign set itself, so pagination.total counts only matching campaigns. Mirrors the same filter on /v1/ads/tree.

minSpendnumber

Return only campaigns whose spend between fromDate and toDate reaches this amount, in each campaign's OWN currency (the currency field on the campaign). Implies hasDelivery; minSpend=0 applies no filter. Mirrors the same filter on /v1/ads/tree.

Response

Paginated campaigns

Example response

{
  "campaigns": [
    {
      "metrics": {
        "actions": {
          "link_click": 160,
          "post_engagement": 300,
          "offsite_conversion.fb_pixel_purchase": 42
        },
        "actionValues": {
          "offsite_conversion.fb_pixel_purchase": 2456.78,
          "offsite_conversion.fb_pixel_add_to_cart": 980.5
        },
        "costPerAction": {
          "link_click": 0.1052,
          "offsite_conversion.fb_pixel_purchase": 4.0114
        }
      }
    }
  ]
}

Changes

Changed in 10 of the 56 revisions of this API.4435

Sep 25, 20262c04683ce69412See the full diff
- ○
  added the optional property / to the response with the status
  response-optional-property-added
- ○
  added the optional property / to the response with the status
  response-optional-property-added
- ○
  added the optional property / to the response with the status
  response-optional-property-added
- ○
  added the optional property / to the response with the status
  response-optional-property-added
- ○
  added the optional property / to the response with the status
  response-optional-property-added
- ○
  added the optional property / to the response with the status
  response-optional-property-added
- ○
  added the optional property / to the response with the status
  response-optional-property-added
- ○
  added the optional property / to the response with the status
  response-optional-property-added
- ○
  added the optional property / to the response with the status
  response-optional-property-added
- ○
  added the optional property / to the response with the status
  response-optional-property-added
- ○
  added the optional property / to the response with the status
  response-optional-property-added
- ○
  added the optional property / to the response with the status
  response-optional-property-added
This revision also has 2 changes that name no endpoint, such as unreferenced schemas being removed. See the revision's changelog
Sep 16, 20263e6ddf2a99ea3See the full diff
- ○
  added the optional property / to the response with the status
  response-optional-property-added
- ○
  added the optional property / to the response with the status
  response-optional-property-added
- ○
  added the optional property / to the response with the status
  response-optional-property-added
Sep 15, 20260dba7d004d756See the full diff
- ○
  added the optional property / to the response with the status
  response-optional-property-added
- ○
  added the optional property / to the response with the status
  response-optional-property-added
- ○
  added the optional property / to the response with the status
  response-optional-property-added
- ○
  added the optional property / to the response with the status
  response-optional-property-added
- ○
  added the optional property / to the response with the status
  response-optional-property-added
- ○
  added the optional property / to the response with the status
  response-optional-property-added
Sep 10, 2026e70ed06e71502See the full diff
- ○
  added the non-success response with the status
  response-non-success-status-added
- ○
  added the non-success response with the status
  response-non-success-status-added
Sep 9, 2026222e3a38a382242See the full diff
- ▲
  the // response's property type changed from object null to no type for status
  response-property-type-changed
- ▲
  the // response's property type changed from object null to no type for status
  response-property-type-changed
- ●
  removed the optional property /// from the response with the status
  response-optional-property-removed
- ●
  removed the optional property /// from the response with the status
  response-optional-property-removed
- ●
  removed the optional property /// from the response with the status
  response-optional-property-removed
- ●
  removed the optional property /// from the response with the status
  response-optional-property-removed
- ○
  added subschema #2 to the // response property anyOf list for the response status
  response-property-any-of-added
- ○
  added subschema #2 to the // response property anyOf list for the response status
  response-property-any-of-added
Sep 8, 2026d7a8fa118ef01See the full diff
- ○
  added the optional property /// to the response with the status
  response-optional-property-added
Aug 26, 2026b5344d376e5e1See the full diff
- ▲
  response property campaigns/items/optimizationGoal list-of-types was widened by adding types array to media type application/json of response 200
  response-property-list-of-types-widened
Aug 25, 2026ac5fffe58a631See the full diff
- ▲
  the // response's property type changed from string null to string array for status
  response-property-type-changed
Aug 13, 2026e0cd920708582See the full diff
- ○
  added the new optional query request parameter hasDelivery
  new-optional-request-parameter
- ○
  added the new optional query request parameter minSpend
  new-optional-request-parameter
Aug 12, 20265bcceb4c15ba7See the full diff
- ○
  added the optional property /// to the response with the status
  response-optional-property-added
- ○
  added the optional property /// to the response with the status
  response-optional-property-added
- ○
  added the optional property /// to the response with the status
  response-optional-property-added
- ○
  added the optional property /// to the response with the status
  response-optional-property-added
- ○
  added the optional property /// to the response with the status
  response-optional-property-added
- ○
  added the optional property /// to the response with the status
  response-optional-property-added
- ○
  added the optional property /// to the response with the status
  response-optional-property-added

Full history