Skip to main content
Version: v3

Get reporting data

GET 

/ad-publishing/facebook/reporting

Retrieve aggregated Facebook ad reporting metrics for a location. grouped holds one row per groupBy period, or a single row covering the whole range when groupBy is omitted, and totals aggregates across them. Both objects only carry the metrics named in fields. Be aware that ratio metrics (cpm, ctr, frequency) are summed rather than weighted in totals, and that cost_per_conversion and cost_per_result are placeholders that always read 0 — their real values live under costPerConversion and costPerResult.

Request

Version stringrequired

API Version

Available optionsv3
locationId stringrequired

Location identifier

fields string[]required

Reporting fields. Pass as comma-separated values on the wire (e.g. ?fields=impressions,clicks).

Available optionsimpressionsclicksspendcpccost_per_conversionconversionsresultscost_per_resultcpmreachfrequencyctr
groupBy string

Time grouping interval

Available optionsdayweekmonth
startDate stringrequired

Report start date (YYYY-MM-DD)

endDate stringrequired

Report end date (YYYY-MM-DD)

type stringrequired

Integration source type

Available optionsAD_MANAGERINTEGRATION
application/json

Per-period rows and their aggregate totals

Schema
    groupedobject[]required

    One row per period when groupBy is given, otherwise a single row covering the whole range.

    totalsobjectrequired

    Aggregates across every row in grouped