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)
| ID | Type | Name | Description | Report |
|---|---|---|---|---|
| account_id | TEXT | Account ID | The Account ID | ANY |
| account_name | TEXT | Account Name | The Account Name | ANY |
| ad_group_display_status | TEXT | Ad Group Display Status | The state of the operation. | AD_GROUP |
| ad_group_id | TEXT | Ad Group Id | The unique identifier for the ad group the search term belongs to. | AD_GROUP |
| ad_group_name | TEXT | Ad Group Name | The name of the ad group, which is unique within the campaign. Responses don't include deleted ad groups. | AD_GROUP |
| ad_group_serving_state_reasons | TEXT | Ad Group Serving State Reasons | A list of reasons that displays when an ad group isn't running. | AD_GROUP |
| ad_group_serving_status | TEXT | Ad Group Serving Status | The status of whether the ad group is serving. | AD_GROUP |
| ad_group_status | TEXT | Ad Group Status | The status of the ad group. | AD_GROUP |
| app | TEXT | App | The App Name | CAMPAIGN |
| automated_keywords_opt_in | BOOLEAN | Automated Keywords Opt In | The 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 |
| campaign | TEXT | Campaign | The Campaign Name | CAMPAIGN |
| campaign_id | TEXT | Campaign ID | The Campaign ID | CAMPAIGN |
| city | CITY | City | The city (locality) the metrics are broken down by. | CAMPAIGN |
| clicks | NUMERIC | Clicks | The Number of Clicks | ANY |
| conversion_rate | PERCENT | Conversion Rate | The Conversion Rate | ANY |
| countries_or_regions | REGION | Country or Region | A group of countries and regions. | CAMPAIGN |
| country | COUNTRY | Country | The country the metrics are broken down by. | CAMPAIGN |
| cpa | NUMERIC | Cost Per Acquisition | The Average Cost Per Acquisition | ANY |
| cpa_goal | NUMERIC | CPA Goal | The cost-per-acquisition goal. | AD_GROUP |
| cpm | NUMERIC | Cost Per Thousand Impressions | The Average Cost Per Thousand Impressions | ANY |
| cpt | NUMERIC | Cost Per Tap | The Average Cost Per Tap | ANY |
| currency | TEXT | Currency | Campaign currency | CAMPAIGN |
| data_fetched_at | Data fetched at | UTC 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. | ||
| datasource | TEXT | Data Source | The name of the Windsor connector returning the row | |
| date | DATE | Date | The Date | ANY |
| day_of_month | TEXT | Day of month | Day of the month | |
| default_bid_amount | NUMERIC | Default Bid Amount | The default maximum cost per tap or impression bid for the ad group. | AD_GROUP |
| deleted | BOOLEAN | Deleted | An indicator of whether the search term is soft-deleted. | SEARCH_TERM |
| device_class | TEXT | Device Class | Device Class: iphone or ipad | ANY |
| end_time | End Time | The scheduled end date and time for the ad group. | AD_GROUP | |
| impressions | NUMERIC | Impressions | The Number of Impressions | ANY |
| installs | NUMERIC | Installs | The Number of installs | ANY |
| keyword | TEXT | Keyword | The targeting or negative keywords. | KEYWORD |
| keyword_display_status | TEXT | Keyword Display Status | The state of the keyword display operation. | KEYWORD |
| keyword_id | TEXT | Keyword Id | The unique identifier for a keyword that belongs to an ad group. | KEYWORD |
| lat_off_installs | NUMERIC | Lat off installs | (Deprecated) The Lat Off Installs | ANY |
| lat_on_installs | NUMERIC | Lat on installs | (Deprecated) The Lat On Installs | ANY |
| match_type | TEXT | Match Type | An automated keyword and bidding strategy. See Ad Groups for Search Match use cases. | KEYWORD |
| month | TEXT | Month | Number of the month | |
| new_downloads | NUMERIC | New Downloads | The Number of New Downloads | ANY |
Apple Search Ads fields (now to year_week_iso)
| ID | Type | Name | Description | Report |
|---|---|---|---|---|
| now | Now | Current timestamp | ||
| number_of_installs | NUMERIC | Number of Installs | The Number of installs | ANY |
| org_id | NUMERIC | Org Id | The 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_downloads | NUMERIC | Re Downloads | The Number of Re Downloads | ANY |
| region | REGION | Region | The administrative area (e.g. state or province) the metrics are broken down by. | CAMPAIGN |
| search_term_match_type | TEXT | Search Term Match Type | An automated keyword and bidding strategy. See Ad Groups for Search Match use cases. | SEARCH_TERM |
| search_term_source | TEXT | Search Term Source | The source of the keyword to use as a search term. | SEARCH_TERM |
| search_term_text | TEXT | Search Term Text | The search terms to use for app searches. | SEARCH_TERM |
| source | TEXT | Source | The name of the Windsor connector returning the row | |
| spend | NUMERIC | Spend | The Media Spend | ANY |
| start_time | Start Time | The scheduled start date and time for the ad group. | AD_GROUP | |
| tap_installs | NUMERIC | Number of Tap Installs | The Number of tap installs | ANY |
| taps | NUMERIC | Taps | The Number of Taps | ANY |
| today | DATE | Today | Today's date | |
| totalcost | NUMERIC | Total Cost | The Media Spend | ANY |
| ttr | PERCENT | Tap Through Rate | The Tap Through Rate | ANY |
| view_installs | NUMERIC | Number of View Installs | The Number of view installs | ANY |
| week | TEXT | Week | Week (Sun-Sat). | |
| week_day | TEXT | Day of week and day number | Weekday number and name combined (Sun-Sat).Numbered from 0 Sunday to 6 Saturday. | |
| week_day_iso | TEXT | Day of week and day number, ISO | Weekday number and name combined, ISO format (Mon-Sun).Numbered from 1 Monday to 7 | |
| week_iso | TEXT | Week ISO | Week, ISO format (Mon-Sun). | |
| year | TEXT | Year | Year | |
| year_month | TEXT | Yearmonth | Year and month, e.g. 2024|3 | |
| year_month_name | TEXT | Year month name | Year and month with the month name written out, e.g. "Jan 2025". | |
| year_of_week | TEXT | Year of week | The year that contains first day of the week (Sun-Sat). | |
| year_of_week_iso | TEXT | Year of week, ISO | The year that contains first day of the ISO week (Mon-Sun). | |
| year_week | TEXT | Year week | Year and week for US weeks (Sun-Sat), e.g. 2024|15 | |
| year_week_iso | TEXT | Year week ISO | Year and week for ISO weeks (Mon-Sun), e.g. 2024|20 |
