Apple Search Ads Connector Reference

21 metrics47 dimensions
https://connectors.windsor.ai/apple_search_ads?api_key=[your API key]&date_preset=last_7d&fields=date,campaign,clicks,installs,spend,impressions&_renderer=csv
The Apple Search Ads connector lets you pull Apple Search ads data on a campaign level. If you specify the fields date_from and date_to it will filter for a absolute date range (example: &date_from=2021-10-01&date_to=2021-10-10 instead of &date_preset=last_7d would return data from October 1st to October 10th 2021 instead of the last 7 days).

The Apple Search Ads connector exposes 68 fields (21 metrics, 47 dimensions). Every field ID below can be passed to the Windsor.ai API in the fields parameter.


Apple Search Ads Fields

The Apple Search Ads connector includes 68 fields.

Apple Search Ads fields (account_id to new_downloads)

IDTypeNameDescriptionReport
account_idTEXTAccount IDThe Account IDANY
account_nameTEXTAccount NameThe Account NameANY
ad_group_display_statusTEXTAd Group Display StatusThe state of the operation.AD_GROUP
ad_group_idTEXTAd Group IdThe unique identifier for the ad group the search term belongs to.AD_GROUP
ad_group_nameTEXTAd Group NameThe name of the ad group, which is unique within the campaign. Responses don't include deleted ad groups.AD_GROUP
ad_group_serving_state_reasonsTEXTAd Group Serving State ReasonsA list of reasons that displays when an ad group isn't running.AD_GROUP
ad_group_serving_statusTEXTAd Group Serving StatusThe status of whether the ad group is serving.AD_GROUP
ad_group_statusTEXTAd Group StatusThe status of the ad group.AD_GROUP
appTEXTAppThe App NameCAMPAIGN
automated_keywords_opt_inBOOLEANAutomated Keywords Opt InThe parameter for enabling and disabling Search Match. If true, the system automatically adds optimized keywords in addition to those you explicitly add to the ad group.AD_GROUP
campaignTEXTCampaignThe Campaign NameCAMPAIGN
campaign_idTEXTCampaign IDThe Campaign IDCAMPAIGN
cityCITYCityThe city (locality) the metrics are broken down by.CAMPAIGN
clicksNUMERICClicksThe Number of ClicksANY
conversion_ratePERCENTConversion RateThe Conversion RateANY
countries_or_regionsREGIONCountry or RegionA group of countries and regions.CAMPAIGN
countryCOUNTRYCountryThe country the metrics are broken down by.CAMPAIGN
cpaNUMERICCost Per AcquisitionThe Average Cost Per AcquisitionANY
cpa_goalNUMERICCPA GoalThe cost-per-acquisition goal.AD_GROUP
cpmNUMERICCost Per Thousand ImpressionsThe Average Cost Per Thousand ImpressionsANY
cptNUMERICCost Per TapThe Average Cost Per TapANY
currencyTEXTCurrencyCampaign currencyCAMPAIGN
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
dateDATEDateThe DateANY
day_of_monthTEXTDay of monthDay of the month
default_bid_amountNUMERICDefault Bid AmountThe default maximum cost per tap or impression bid for the ad group. AD_GROUP
deletedBOOLEANDeletedAn indicator of whether the search term is soft-deleted.SEARCH_TERM
device_classTEXTDevice ClassDevice Class: iphone or ipadANY
end_timeTIMESTAMPEnd TimeThe scheduled end date and time for the ad group.AD_GROUP
impressionsNUMERICImpressionsThe Number of ImpressionsANY
installsNUMERICInstallsThe Number of installsANY
keywordTEXTKeywordThe targeting or negative keywords.KEYWORD
keyword_display_statusTEXTKeyword Display StatusThe state of the keyword display operation.KEYWORD
keyword_idTEXTKeyword IdThe unique identifier for a keyword that belongs to an ad group.KEYWORD
lat_off_installsNUMERICLat off installs(Deprecated) The Lat Off InstallsANY
lat_on_installsNUMERICLat on installs(Deprecated) The Lat On InstallsANY
match_typeTEXTMatch TypeAn automated keyword and bidding strategy. See Ad Groups for Search Match use cases.KEYWORD
monthTEXTMonthNumber of the month
new_downloadsNUMERICNew DownloadsThe Number of New DownloadsANY

Apple Search Ads fields (now to year_week_iso)

IDTypeNameDescriptionReport
nowTIMESTAMPNowCurrent timestamp
number_of_installsNUMERICNumber of InstallsThe Number of installsANY
org_idNUMERICOrg IdThe identifier of the organization that owns the campaign. Your orgId is the same as your account in the Apple Search Ads UI.AD_GROUP
re_downloadsNUMERICRe DownloadsThe Number of Re DownloadsANY
regionREGIONRegionThe administrative area (e.g. state or province) the metrics are broken down by.CAMPAIGN
search_term_match_typeTEXTSearch Term Match TypeAn automated keyword and bidding strategy. See Ad Groups for Search Match use cases.SEARCH_TERM
search_term_sourceTEXTSearch Term SourceThe source of the keyword to use as a search term.SEARCH_TERM
search_term_textTEXTSearch Term TextThe search terms to use for app searches.SEARCH_TERM
sourceTEXTSourceThe name of the Windsor connector returning the row
spendNUMERICSpendThe Media SpendANY
start_timeTIMESTAMPStart TimeThe scheduled start date and time for the ad group.AD_GROUP
tap_installsNUMERICNumber of Tap InstallsThe Number of tap installsANY
tapsNUMERICTapsThe Number of TapsANY
todayDATETodayToday's date
totalcostNUMERICTotal CostThe Media SpendANY
ttrPERCENTTap Through RateThe Tap Through RateANY
view_installsNUMERICNumber of View InstallsThe Number of view installsANY
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