Skip to main content
Facebook ReportingVersion: v3New

Get reporting list

GET/ad-publishing/facebook/reporting/list
deprecated

This endpoint has been deprecated and may be replaced or removed in future versions of the API.

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. Deprecated: use GET /ad-publishing/facebook/reporting/rows with header version: v4.

Authorizations

Authorizationstringheaderrequired

Bearer authentication header of the form Bearer <token>, where <token> is your access token.

Scope:adPublishing.readonly
Auth methods:OAuthPrivate Integration
Token type:Sub-Account Token

Request​

Headers

Versionstringrequired

API Version

Available optionsv3
Example:v3

Query Parameters

locationIdstringrequired

Location identifier

Example:fRMewNQIxSyZ5R4nQyit
listTypestringrequired

Reporting list type

Available optionsadsadsetscampaignsnone
Example:campaigns
startDatestringrequired

Report start date (YYYY-MM-DD)

Example:2022-01-11
endDatestringrequired

Report end date (YYYY-MM-DD)

Example:2022-01-31
campaignIdstring

Campaign identifier (required when listType is adsets or ads)

Example:196684453527082
typestringrequired

Integration source type

Available optionsAD_MANAGERINTEGRATION
Example:INTEGRATION

Response

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.

  • Array items
    • oneOf
    _idstringrequired

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

    Example:6888ebcd08b53700119d3c18
    namestringrequired

    Campaign name

    Example:Spring Promo
    objectivestringrequired

    Campaign objective

    Example:OUTCOME_LEADS
    publishingStatusstringrequired

    Publishing status. Archived campaigns are excluded from this list.

    Example:PAUSED
    fbCampaignIdstringrequired

    Meta campaign id. Campaigns without one are excluded.

    Example:120209705920280122
    clicksstringrequired

    Clicks

    Example:16
    cpcstringrequired

    Cost per click

    Example:0.03125
    ctrstringrequired

    Click-through rate as a percentage

    Example:2.413273
    impressionsstringrequired

    Impressions

    Example:663
    spendstringrequired

    Spend

    Example:0.5
    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.

    Example:0.00
    salesstringrequired

    Attributed opportunities

    Example:0
    leadsstringrequired

    Attributed contacts

    Example:0
    averageRevenuestringrequired

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

    Example:0.00
    campaignIdstring

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

    Example:120216900088000122
    campaignNamestring

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

    Example:sales-messaging
    reachstring

    Unique people reached. Insight rows only.

    Example:650
    frequencystring

    Average impressions per person. Insight rows only.

    Example:1.02
    dateStartstring

    Start of the reported window. Insight rows only.

    Example:2025-09-01
    dateStopstring

    End of the reported window. Insight rows only.

    Example:2026-08-19