OpenAI Ads / ChatGPT Ads Connector Reference

15 metrics45 dimensions

The OpenAI Ads / ChatGPT Ads connector exposes 60 fields (15 metrics, 45 dimensions). Every field ID below can be passed to the Windsor.ai API in the fields parameter.


Available actions


Enable Campaign Activate a paused OpenAI Ads campaign so it can deliver again. Reversible via pause_campaign.

Activate a paused OpenAI Ads campaign so it can deliver again. Reversible via pause_campaign.

Parameters
campaign_idstringRequired
Pause Campaign Pause an active OpenAI Ads campaign so it stops delivering. Reversible via enable_campaign.

Pause an active OpenAI Ads campaign so it stops delivering. Reversible via enable_campaign.

Parameters
campaign_idstringRequired
Set Campaign Budget Set the spend limit of an OpenAI Ads campaign. The amount is in the account currency major unit (e.g. 50 means 50.00, not micros) and must be at least 1.00. The campaign's existing budget type is preserved: a daily spend limit stays daily and a lifetime spend limit stays lifetime.

Set the spend limit of an OpenAI Ads campaign. The amount is in the account currency major unit (e.g. 50 means 50.00, not micros) and must be at least 1.00. The campaign's existing budget type is preserved: a daily spend limit stays daily and a lifetime spend limit stays lifetime.

Parameters
campaign_idstringRequiredamountnumberRequired
Enable Ad Group Activate a paused OpenAI Ads ad group so it can deliver again. Reversible via pause_ad_group.

Activate a paused OpenAI Ads ad group so it can deliver again. Reversible via pause_ad_group.

Parameters
ad_group_idstringRequired
Pause Ad Group Pause an active OpenAI Ads ad group so it stops delivering. Reversible via enable_ad_group.

Pause an active OpenAI Ads ad group so it stops delivering. Reversible via enable_ad_group.

Parameters
ad_group_idstringRequired

OpenAI Ads / ChatGPT Ads Fields

OpenAI Ads / ChatGPT Ads Insights fields

The Insights report of the OpenAI Ads / ChatGPT Ads connector includes 40 fields.

IDTypeNameDescription
TEXTAdThe name of the ad.
ad_account_budget_dailyNUMERICAd Account Daily Spend LimitThe daily spend limit set on the ad account.
ad_account_budget_lifetimeNUMERICAd Account Lifetime Spend LimitThe lifetime spend limit set on the ad account.
ad_account_idTEXTAd Account IDThe OpenAI ad account identifier.
ad_account_nameTEXTAd Account NameThe name of the OpenAI ad account.
ad_account_urlTEXTAd Account URLThe website URL of the OpenAI ad account.
ad_copyTEXTAd CopyThe body copy of the ad.
ad_groupTEXTAd GroupThe name of the ad group.
ad_group_descriptionTEXTAd Group DescriptionThe description of the ad group.
ad_group_idTEXTAd Group IDThe unique identifier of the ad group.
ad_group_statusTEXTAd Group StatusThe delivery status of the ad group.
ad_idTEXTAd IDThe unique identifier of the ad.
TEXTAd LinkThe landing page URL of the ad.
ad_review_statusTEXTAd Review StatusThe review status of the ad.
ad_statusTEXTAd StatusThe delivery status of the ad.
ad_titleTEXTAd TitleThe headline title of the ad.
campaignTEXTCampaignThe name of the campaign.
campaign_budget_dailyNUMERICCampaign Daily Spend LimitThe daily spend limit set on the campaign.
campaign_budget_lifetimeNUMERICCampaign Lifetime Spend LimitThe lifetime spend limit set on the campaign.
campaign_descriptionTEXTCampaign DescriptionThe description of the campaign.
campaign_end_timeTIMESTAMPCampaign End TimeThe scheduled end time of the campaign.
campaign_idTEXTCampaign IDThe unique identifier of the campaign.
campaign_start_timeTIMESTAMPCampaign Start TimeThe scheduled start time of the campaign.
campaign_statusTEXTCampaign StatusThe delivery status of the campaign.
clicksNUMERICClicksThe number of times the ad was clicked.
conversionsNUMERICConversionsClick-through conversions for the configured conversion events.
countryCOUNTRYCountryThe country the ad was served in.
cpaNUMERICCPAAverage cost per action (spend divided by conversions).
cpcNUMERICCPCAverage cost per click (spend divided by clicks).
cpmNUMERICCPMCost per thousand impressions.
ctrPERCENTCTRClick-through rate (clicks divided by impressions).
dateDATEDateThe date of the report metrics.
deviceTEXTDeviceThe device type the ad was served on.
impressionsNUMERICImpressionsThe number of times the ad was shown.
order_created_attributed_salesNUMERICAttributed SalesValue of attributed order_created events in the account currency.
order_created_attributed_sales_currencyTEXTAttributed Sales CurrencyCurrency of the attributed sales value.
order_created_roasNUMERICAttributed Sales ROASReturn on ad spend (attributed sales divided by spend).
platformTEXTPlatformThe platform the ad was served on.
post_click_cvrPERCENTPost-Click Conversion RateConversions divided by clicks, reported as a ratio.
spendNUMERICSpendThe amount of money spent on the ad.

OpenAI Ads / ChatGPT Ads other fields

The OpenAI Ads / ChatGPT Ads connector has 20 fields that do not belong to a named report, or belong to a report with only one or two fields.

IDTypeNameDescriptionReport
account_idTEXTAccount IDAccount ID in Windsor.ai.Accounts
account_nameTEXTAccount NameAccount name in Windsor.ai.Accounts
data_fetched_atTIMESTAMPData fetched atUTC timestamp (second precision) of when the connector request that pulled the row started. Freshly pulled rows show this request's start time; cache hits keep the start time of the request that filled the cache. Selecting this field disables aggregation, so rows are returned individually (each keeping its own fetch time) instead of being summed.
datasourceTEXTData SourceThe name of the Windsor connector returning the row
day_of_monthTEXTDay of monthDay of the month
monthTEXTMonthNumber of the month
nowTIMESTAMPNowCurrent timestamp
sourceTEXTSourceThe name of the Windsor connector returning the row
todayDATETodayToday's date
weekTEXTWeekWeek (Sun-Sat).
week_dayTEXTDay of week and day numberWeekday number and name combined (Sun-Sat).Numbered from 0 Sunday to 6 Saturday.
week_day_isoTEXTDay of week and day number, ISOWeekday number and name combined, ISO format (Mon-Sun).Numbered from 1 Monday to 7
week_isoTEXTWeek ISOWeek, ISO format (Mon-Sun).
yearTEXTYearYear
year_monthTEXTYearmonthYear and month, e.g. 2024|3
year_month_nameTEXTYear month nameYear and month with the month name written out, e.g. "Jan 2025".
year_of_weekTEXTYear of weekThe year that contains first day of the week (Sun-Sat).
year_of_week_isoTEXTYear of week, ISOThe year that contains first day of the ISO week (Mon-Sun).
year_weekTEXTYear weekYear and week for US weeks (Sun-Sat), e.g. 2024|15
year_week_isoTEXTYear week ISOYear and week for ISO weeks (Mon-Sun), e.g. 2024|20