OpenAI Ads - Parameters
The query parameters available to a OpenAI Ads connector.
These are the parameters a OpenAI Ads connector's query accepts. The recommended template sets the ones it needs; the rest are only reachable by editing the connector in the Advanced Editor.
Most accounts never touch these. The page exists so that when a connector does need adjusting, what is adjustable is written down. The columns it can return are listed separately on OpenAI Ads - Supported Columns.
Parameters
Fields
list of text
empty
Dimensions and metrics to retrieve, using OpenAI's canonical dotted field names (e.g. campaign.id, impressions).
AggregationLevel
text
"ad"
Row grouping: ad_account, campaign, ad_group, or ad.
TimeGranularity
text
"daily"
Time bucketing: hourly, daily, monthly, or none.
Segments
list of text
Not yet supported - OpenAiAdsDownloader rejects any non-empty value. The API flattens entity metric field names differently when segments are active (e.g. "ad.impressions" becomes "ad_impressions" instead of "impressions"), confirmed against the live API, and this connector doesn't yet account for that.
Filters
text
Raw JSON filter array, passed through verbatim to OpenAI's filters[] parameter.
Sort
text
Raw sort spec, passed through verbatim to OpenAI's sort[] parameter.
IncludeConversions
true or false
If true, also calls POST /conversions/insights and merges conversions/click_through_conversions/view_through_conversions onto the output rows by date + entity ID. There is no per-field selection - all three are always requested together.
A connector edited in the Advanced Editor stops receiving template updates. Roivenue ships improvements by updating the shared template a connector is built from, and only connectors still configured by that template pick those updates up. Once a connector is switched to advanced mode, its query and transformations belong to you.
Was this helpful?