Skip to main content
Version: 2023-02-21

Get campaign reporting

GET 
/ad-publishing/facebook/reporting/campaign/:campaignId

Retrieve reporting for one campaign as a flat object, not the { grouped, totals } envelope the account-level report uses. Merges the locally stored campaign, Meta insights for the window, and CDP-attributed contacts. The campaign must be published — one without an fbCampaignId is rejected. Note results.lead (Meta lead actions) and leads (CDP attributed contacts) measure different things and routinely disagree.

Request​

Version stringrequired

API Version

Available options2023-02-21
campaignId stringrequired

Campaign identifier

locationId stringrequired

Location identifier

startDate stringrequired

Report start date (YYYY-MM-DD)

endDate stringrequired

Report end date (YYYY-MM-DD)

application/json

Campaign metadata, Meta insights, and attributed contacts for the window

Schema
    _idstringrequired

    Campaign id in this service. Note _id, not id.

    namestringrequired

    Campaign name

    objectivestringrequired

    Campaign objective

    publishingStatusstringrequired

    Local publishing status

    fbCampaignIdstringrequired

    Meta campaign id. Required — an unpublished campaign is rejected.

    campaignIdstring

    Meta campaign id, repeated from the insights row

    startTimestring

    When the campaign started, in Meta timestamp format with a numeric offset rather than UTC

    stopTimestring

    When the campaign is scheduled to stop. Absent on open-ended campaigns.

    dateStartstring

    First day of the reported window

    dateStopstring

    Last day of the reported window

    clicksstring

    Clicks

    cpcstring

    Cost per click

    ctrstring

    Click-through rate as a percentage

    cpmstring

    Cost per thousand impressions

    impressionsstring

    Impressions

    spendstring

    Spend

    reachstring

    Unique people reached

    frequencystring

    Average impressions per person reached

    conversionsstring

    Lead actions Meta recorded. A string here, unlike the account-level report where the same figure is a number.

    costPerConversionstring

    Spend divided by lead actions

    resultsobject

    Counts per Meta action type. Values are strings, and the types overlap so summing them double-counts.

    costPerResultstring

    Spend divided by the double-counted results total, so usually far smaller than the real cost per lead

    costPerResultBreakdownobject

    Cost per action, per action type, at four decimals

    leadsstring

    Contacts the CDP attributed to this campaign. A different measurement from results.lead, which counts Meta lead actions — expect the two to differ.