v1

latestOpenAPI 3.0.12026-07-22204678550.0 KB

Analytics

/2026-01/statistics/report

This Statistics endpoint provides ad set related data. It is an upgrade of our previous Statistics endpoint, and includes new metrics and customization capabilities. <br/><br/> This endpoint supports data retrieval for up to two years in the past.

post/2026-01/statistics/report

Request body

adSetIdsstring[] nullable

Optional list of ad set IDs to filter on. The ad sets must already exist. If empty, all ad sets will be fetched.

adSetNamesstring[] nullable

Optional list of ad set names to filter on. If empty, all ad sets will be fetched.

adSetStatusstring[] nullable

Optional list of ad set statuses to filter on. If empty, all ad sets will be fetched.

advertiserIdsstring required

List of advertiser IDs to report on, provided as a single comma-separated string (e.g., "123,456,789"). The advertisers must already exist. If empty, all advertisers will be used.

currencystring required

The currency used for the report. ISO 4217 code (three-letter capitals).

dimensionsstring[] required

List of dimensions for the report. At least one dimension should be provided. <br/><br/> When an ID dimension is requested (e.g., AdsetId), the corresponding name dimension (e.g., Adset) is automatically included, and vice versa. This applies to the following pairs: AdsetId/Adset, AdId/Ad, AdvertiserId/Advertiser, CampaignId/Campaign, CategoryId/Category, CouponId/Coupon, MarketingObjectiveId/MarketingObjective, ChannelId/Channel.

endDatestring date-time required

End date of the report. Date component of ISO 8601 format, any time or timezone component is ignored.

format'csv' | 'excel' | 'xml' | 'json'

Optional file format of the generated report.

metricsstring[] required

List of metrics for the report. Provide at least one metric to return performance data; otherwise, the response will include only dimension-related information.

startDatestring date-time required

Start date of the report. Date component of ISO 8601 format, any time or timezone component is ignored. Must be ≤ endDate.

timezonestring nullable

Optional timezone used for the report. Timezone Database format (Tz).

Response

Success

string binary required