OpenAI Ads conversions
openai_ads_conversionsRetrieve ChatGPT ads conversion insights to measure click-through and view-through goal conversions and attributed order value by campaign, ad group, ad, or account over a date range.
Instructions
OpenAI Ads (ChatGPT ads) conversion insights (POST /v1/conversions/insights, a read query): goal conversions (click-through and view-through) and attributed order value per campaign, ad group or ad (entity_ids), or for the whole account (group_by_entity false), over whole days in the account timezone. Returns "rows" (null kept), recomputed "totals", "currency" (account_currency), "attribution" and "date_range". No pagination: more than 2000 rows answers too_many_rows (fewer entities, shorter period or fewer event_names). Warning: attributed event details may contain order or user identifiers; only documented aggregate fields are kept.
Input Schema
| Name | Required | Description | Default |
|---|---|---|---|
| end_date | Yes | Last day, YYYY-MM-DD (inclusive) | |
| breakdown | No | Optional breakdown: country or device; empty for none | |
| client_id | No | Client id from clients_list; empty uses the only client (or the environment variables without a registry) | |
| entity_ids | No | Ids of the entities of aggregation_level (1 to 100). Required when group_by_entity is true; must be empty when it is false | |
| start_date | Yes | First day, YYYY-MM-DD (whole days, 365 days at most) | |
| event_names | No | Optional exact event names for the event details (requires include_attributed_events; here at most 20 names of 64 characters among letters, digits, _ . : -, stricter than the API) | |
| group_by_entity | No | True (API default): one row per entity of entity_ids; false: one row for the whole ad account (no entity_ids) | |
| account_timezone | Yes | IANA timezone of the ad account, e.g. Europe/Paris (the timezone column of openai_ads_insights): the API counts whole days in it | |
| time_granularity | No | none: period totals; daily: one row per day | none |
| aggregation_level | Yes | Required row entity: campaign, ad_group or ad | |
| include_zero_rows | No | True (API default): keep rows without conversions | |
| attribution_time_basis | No | ad_event_time (API default) or conversion_time; empty sends nothing | |
| attribution_window_days | No | Click attribution window in days: 7, 14 or 30 | |
| include_attributed_events | No | True: add per-event aggregates (event_name, counts, value); may expose order or user identifiers, so only aggregate fields are kept | |
| view_through_attribution_window_days | No | View-through attribution window in days: 0 or 1 |