sortarray
Fields to sort by with direction (_ascending or _descending suffix)
afterstring
Cursor for the next page of results, usually taken from paging.cursors.after in the previous response.
levelstring
Level at which to aggregate the data Must match the type of object referenced by `object_id` (e.g., 'account' for 'act_...' IDs, 'campaign' for campaign IDs, 'adset' for ad set IDs, 'ad' for ad IDs); mismatches return empty or misleading metrics. Allowed values: 'account', 'camp…
limitinteger
Maximum number of insight rows to return for this page. Use paging.cursors.after or paging.cursors.before from the response to request another page.
beforestring
Cursor for the previous page of results, usually taken from paging.cursors.before in the previous response.
fieldsarray
List of metric fields to include in the response. Valid standalone fields include: impressions, clicks, spend, reach, cpc, cpm, ctr, frequency, account_name, account_id, campaign_name, campaign_id, adset_name, adset_id, ad_name, ad_id, objective, buying_type, date_start, date_st…
filteringarray
Filters to apply to the data
object_idObligatoirestring
ID of the object to get insights for (ad account, campaign, ad set, or ad). For ad accounts, the ID must include the act_ prefix (e.g., act_123456789). Campaign, ad set, and ad IDs are numeric only.
breakdownsarray
List of breakdown dimensions to apply to the data, such as publisher_platform, platform_position, impression_device, age, gender, country, region, or device_platform.
time_rangeobject
Custom date range for the insights. If provided, date_preset should be set to null/None to use this custom range instead. Must be a dict with keys `since` and `until` in YYYY-MM-DD format (e.g., {'since': '2024-01-01', 'until': '2024-01-31'}). Never provide both time_range and d…
date_presetstring
Predefined date range for the insights. Defaults to 'last_30d' if neither date_preset nor time_range is specified. Allowed values: 'today', 'yesterday', 'last_7d', 'last_30d', 'this_month', 'last_month', 'this_quarter'. Case-insensitive (e.g., 'LAST_30D' is normalized to 'last_3…
date_range_defaultedboolean
Internal field to track if date_preset was defaulted. Do not set this manually.
