POST/ad_accounts/:ad_account_id/reports
Generate a metrics report for up to 3 breakdowns (4 with country and region) based on the fields you provide.
Reports provide detailed insights and analytics on ad performance, audience engagement, and other relevant metrics.
Top combinations aren't currently supported. View these metrics in the Ads Manager.
Considerations
- Metrics default to Coordinated Universal Time (UTC). Change time zone by setting
time_zone_id. - Filters can be added to limit entity types or conversion data. Learn about applying filters.
- Some values are converted in your report. To return the value:
The asterisk (
*) represents any character(s). For example,CONVERSION*TOTAL_VALUEmatches any metrics starting withCONVERSIONand ending withTOTAL_VALUE.- Divide by 100:
CONVERSION*TOTAL_VALUE - Divide by 1 million:
SPEND,CPC,CPV,ECPM,APP_INSTALL*ECPA,APP_INSTALL_SKAN*,APP_INSTALL*REVENUE, andCONVERSION*ECPA
- Divide by 100:
- We recommend including the
ad_idbreakdown. Use joins inGet Adto retrieve IDs. - Metrics may take up to 6 hours to stabilize. Conversion data continues updating as events occur.
- Delivery data goes back by 24 months. Reach and frequency data start June 2024.
Rate Limit
See the rate limits for Reporting
Policy Slug: ads-reporting
- Window: 60 seconds
- Quota: 60 requests
Request
Responses
- 200
- 400
- 401
- 403
- 404
- 429
- 5XX
A report.
Bad request.
No bearer token or a bad bearer token was provided.
Insufficient authentication scopes.
The specified resource was not found.
Too many requests. See Rate Limiting for header details and best practices.
Response Headers
The rate limit policies that apply to this request (IETF "RateLimit header fields for HTTP" draft). Each comma-separated policy is keyed by a public policy name and lists its quota q and window in seconds w.
The current rate limit state for each applicable policy (IETF "RateLimit header fields for HTTP" draft): remaining quota r and seconds until the window resets t. On a 429 the exhausted policy reports r=0.
Server error.