Get campaign analytics

Returns performance analytics for a whole campaign in one call: summary metrics, a daily timeline over the requested date range (summed across the campaign's ads), and optional demographic breakdowns. Breakdowns are fetched live from Meta at the campaign level (one call per dimension, no per-ad fan-out), so an agency dashboard gets campaign-level age/gender/etc. without summing thousands of per-ad reads. campaignId is the platform campaign id; pass platform when a campaign id could be ambiguous across platforms. If no date range is provided, defaults to the last 90 days. Date range is capped at 730 days max.

Authorization

AuthorizationBearer <token>

API key authentication - use your Zernio API key as a Bearer token

In: header

Path Parameters

campaignIdstring

Platform campaign id (platformCampaignId).

Query Parameters

platform?string

Disambiguate when the campaign id exists across platforms (e.g. facebook, instagram).

fromDate?string

Start of date range (YYYY-MM-DD). Defaults to 90 days ago.

Formatdate

toDate?string

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

Formatdate

breakdowns?string

Comma-separated breakdown dimensions (Meta only): age, gender, country, publisher_platform, device_platform, region, platform_position, impression_device, video_asset, image_asset, body_asset, title_asset.

Response Body

application/json

import Zernio from '@zernio/node';const zernio = new Zernio({ apiKey: process.env.ZERNIO_API_KEY });const { data } = await zernio.ads.getCampaignAnalytics({  path: {    campaignId: 'campaign_abc123',  },});console.log(data);

{
  "campaign": {
    "id": "string",
    "name": "string",
    "platform": "string",
    "status": "string",
    "currency": "string"
  },
  "analytics": {
    "summary": {
      "spend": 0,
      "impressions": 0,
      "reach": 0,
      "clicks": 0,
      "ctr": 0,
      "cpc": 0,
      "cpm": 0,
      "engagement": 0,
      "conversions": 0,
      "costPerConversion": 0,
      "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
      },
      "purchaseValue": 0,
      "roas": 0,
      "lastSyncedAt": "2019-08-24T14:15:22Z"
    },
    "daily": [
      {
        "spend": 0,
        "impressions": 0,
        "reach": 0,
        "clicks": 0,
        "ctr": 0,
        "cpc": 0,
        "cpm": 0,
        "engagement": 0,
        "conversions": 0,
        "costPerConversion": 0,
        "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
        },
        "purchaseValue": 0,
        "roas": 0,
        "lastSyncedAt": "2019-08-24T14:15:22Z",
        "date": "2019-08-24"
      }
    ],
    "breakdowns": {
      "property1": [
        {}
      ],
      "property2": [
        {}
      ]
    }
  }
}

{
  "error": "Unauthorized"
}

Empty

{
  "error": "Not found"
}

Get campaign analytics

Authorization

AuthorizationBearer <token>

API key authentication - use your Zernio API key as a Bearer token

In: header

Path Parameters

campaignIdstring

Platform campaign id (platformCampaignId).

Query Parameters

platform?string

Disambiguate when the campaign id exists across platforms (e.g. facebook, instagram).

fromDate?string

Start of date range (YYYY-MM-DD). Defaults to 90 days ago.

Formatdate

toDate?string

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

Formatdate

breakdowns?string

Response Body

application/json

import Zernio from '@zernio/node';

const zernio = new Zernio({ apiKey: process.env.ZERNIO_API_KEY });

const { data } = await zernio.ads.getCampaignAnalytics({
  path: {
    campaignId: 'campaign_abc123',
  },
});
console.log(data);

import Zernio from '@zernio/node';const zernio = new Zernio({ apiKey: process.env.ZERNIO_API_KEY });const { data } = await zernio.ads.getCampaignAnalytics({  path: {    campaignId: 'campaign_abc123',  },});console.log(data);

{
  "campaign": {
    "id": "string",
    "name": "string",
    "platform": "string",
    "status": "string",
    "currency": "string"
  },
  "analytics": {
    "summary": {
      "spend": 0,
      "impressions": 0,
      "reach": 0,
      "clicks": 0,
      "ctr": 0,
      "cpc": 0,
      "cpm": 0,
      "engagement": 0,
      "conversions": 0,
      "costPerConversion": 0,
      "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
      },
      "purchaseValue": 0,
      "roas": 0,
      "lastSyncedAt": "2019-08-24T14:15:22Z"
    },
    "daily": [
      {
        "spend": 0,
        "impressions": 0,
        "reach": 0,
        "clicks": 0,
        "ctr": 0,
        "cpc": 0,
        "cpm": 0,
        "engagement": 0,
        "conversions": 0,
        "costPerConversion": 0,
        "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
        },
        "purchaseValue": 0,
        "roas": 0,
        "lastSyncedAt": "2019-08-24T14:15:22Z",
        "date": "2019-08-24"
      }
    ],
    "breakdowns": {
      "property1": [
        {}
      ],
      "property2": [
        {}
      ]
    }
  }
}

{
  "error": "Unauthorized"
}

Empty

{
  "error": "Not found"
}

Get campaign analytics

200application/json

401application/json

403

404application/json

Get campaign analytics

200application/json

401application/json

403

404application/json

application/json

application/json

application/json

application/json

application/json

application/json