Skip to main content
Version: v3

Get reporting list

GET 
/ad-publishing/facebook/reporting/list

Retrieve campaigns, ad sets, or ads with their reporting metrics. listType selects the entity and changes the item shape; adsets and ads additionally require campaignId. Entities Meta has no insights for are still returned, padded with a fixed zero row that carries fewer fields than a real one. Note none is accepted by validation but has no handler and fails with a 409.

Request​

Version stringrequired

API Version

Available optionsv3
locationId stringrequired

Location identifier

listType stringrequired

Reporting list type

Available optionsadsadsetscampaignsnone
startDate stringrequired

Report start date (YYYY-MM-DD)

endDate stringrequired

Report end date (YYYY-MM-DD)

campaignId string

Campaign identifier (required when listType is adsets or ads)

type stringrequired

Integration source type

Available optionsAD_MANAGERINTEGRATION
application/json

The entities and their metrics. The item shape follows listType: campaigns are keyed by _id and carry publishingStatus, ad sets by adSetId with a nested campaign, and ads by adId with adsetId and adsetName. Only the campaigns branch includes locally stored fields; all three append CDP revenue and contact figures.

Schema
  • Array [
    • oneOf
    _idstringrequired

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

    namestringrequired

    Campaign name

    objectivestringrequired

    Campaign objective

    publishingStatusstringrequired

    Publishing status. Archived campaigns are excluded from this list.

    fbCampaignIdstringrequired

    Meta campaign id. Campaigns without one are excluded.

    clicksstringrequired

    Clicks

    cpcstringrequired

    Cost per click

    ctrstringrequired

    Click-through rate as a percentage

    impressionsstringrequired

    Impressions

    spendstringrequired

    Spend

    resultsobjectrequired

    Counts per action type as strings. Padded rows carry only { lead: "0", linkClick: "0" } regardless of which actions the campaign could produce.

    revenuestringrequired

    Attributed revenue from the CDP service. "0" on padded rows, "0.00" when genuinely zero.

    salesstringrequired

    Attributed opportunities

    leadsstringrequired

    Attributed contacts

    averageRevenuestringrequired

    Revenue per opportunity, or "0.00" when there are none

    campaignIdstring

    Meta campaign id, repeated. Present only when Meta returned insights.

    campaignNamestring

    Campaign name as Meta holds it, which can differ from name. Insight rows only.

    reachstring

    Unique people reached. Insight rows only.

    frequencystring

    Average impressions per person. Insight rows only.

    dateStartstring

    Start of the reported window. Insight rows only.

    dateStopstring

    End of the reported window. Insight rows only.

  • ]