Supermetrics brings all your marketing data into Google Sheets, Google Data Studio, Excel, BigQuery, Snowflake, Redshift, Azure
| Category | Field | Code | Description |
|---|---|---|---|
| TIME | Year | Year | Year, e.g. 2017 |
| Year of week (Mon-Sun) | YearOfISOweek | ||
| Year of week (Sun-Sat) | Yearofweek | ||
| Year & month | Yearmonth | Year and month, e.g. 2017|06 | |
| Year & week (Mon-Sun) | YearweekISO | Year and week for ISO weeks, e.g. 2017|08 | |
| Year & week (Sun-Sat) | Yearweek | Year and week for US weeks, e.g. 2017|08 | |
| Quarter | Quarter | Quarter, e.g. 1 | |
| Month | Month | Month, e.g. 6 | |
| Week (Mon-Sun) | WeekISO | ISO week number, e.g. 51 | |
| Week (Sun-Sat) | Week | US week number, e.g. 51 | |
| Day of week | DayOfWeek | ||
| Date | Date | Date, e.g. 2017-01-31 | |
| Hour (advert account time zone) | hourly_stats_aggregated_by_advertiser_time_zone | ||
| Hour (viewer's time zone) | hourly_stats_aggregated_by_audience_time_zone | ||
| ATTRIBUTION | Attribution setting | attribution_setting | The default attribution window to be used when the attribution result is calculated. Each ad set has its own attribution setting value. The attribution setting for a campaign or an account is calculated based on existing ad sets. Returns mixed, indicating multiple attribution settings, skan, indicating SKAdNetwork attribution of iOS 14 app install campaigns, and na, indicating no ad set in a campaign or account |
| IMPRESSION | Impression device | impression_device | |
| Placement | placement | ||
| Place page ID | place_page_id | ||
| Publisher platform | publisher_platform | Distinguishes between platforms like Facebook and Instagram | |
| Platform position | platform_position | ||
| Device platform | device_platform | ||
| USER | Gender | gender | |
| Age | age | ||
| Country | Countryname | ||
| Country code | country | ||
| Region | region | ||
| DMA | dma | Designated Market Area | |
| Audience type | user_segment_key | The audience type for Advantage+ Shopping Campaigns. Values may be 'prospecting', 'existing', 'unknown' or 'uncategorized'. This breakdown only works with Advantage+ Shopping Campaigns | |
| PRODUCT | Product ID | product_id | |
| ACTION/CONVERSION | Action type | ActionTypeWithCustomLabels | The kind of actions taken on your ad, Page, app or event after your ad was served to someone, even if they didn't click on it. Action types include Page likes, app installs, conversions, event responses and more. Custom conversion types will be listed by their label |
| Action type (with custom conv. IDs) | ActionType | The kind of actions taken on your ad, Page, app or event after your ad was served to someone, even if they didn't click on it. Action types include Page likes, app installs, conversions, event responses and more. Custom conversion types will be listed by their ID number | |
| Action target ID | ActionTargetID | ||
| Action device | ActionDevice | ||
| Canvas component name | ActionCanvasComponentName | ||
| ACCOUNT DETAILS | Account name | account_name | The name of your ad account, which groups your advertising activity |
| Account ID | account_id | The ID number of your ad account, which groups your advertising activity | |
| Business name | business_name | ||
| Business country | business_country_code | ||
| Business city | business_city | ||
| Account status | account_status | ||
| Account edit link | account_edit_link | Link to edit the Facebook Ads account | |
| Account currency | currency | ||
| Account timezone | timezone_name | ||
| Account timezone ID | timezone_id | ||
| Account timezone offset from UTC | timezone_offset_hours_utc | ||
| Account users | users | ||
| Account spend cap | spend_cap | ||
| Account amount spent | amount_spent | ||
| Account balance | balance | ||
| Account funding source | funding_source | ||
| CAMPAIGN DETAILS | Campaign name | campaign_group_name | The name of the advertising campaign that you're viewing in reporting |
| Campaign ID | campaign_group_id | The unique ID number of the advertising campaign that you're viewing in reporting | |
| Campaign objective | campaignobjective | The objective you selected for your campaign. Your objective reflects the goal you want to achieve with your advertising | |
| Campaign status (effective status) | campaignstatus | ||
| Campaign tags | campaign_tags | List of tags assigned to your campaign | |
| Campaign edit link | campaign_edit_link | Link to edit the campaign in Facebook Ads | |
| Campaign configured status | campaignconfigured_status | ||
| Campaign buying type | campaignbuyingtype | The method by which you pay for and target ads in your campaigns: through dynamic auction bidding, fixed-price bidding, or reach and frequency buying | |
| Campaign spending limit | campaignspend_cap | ||
| Campaign start date | campaign_start_date | ||
| Campaign end date | campaign_end_date | ||
| Campaign start date & time | campaign_start_time | ||
| Campaign end date & time | campaign_end_time | ||
| Campaign daily budget | campaign_daily_budget | ||
| Campaign lifetime budget | campaign_lifetime_budget | ||
| Is Campaign using SKAdNetwork | campaign_is_skadnetwork_attribution | Flag to indicate that the campaign will be using SKAdNetwork, which also means that it will only be targeting iOS 14.x and above | |
| Campaign budget remaining | campaign_budget_remaining | ||
| AD SET DETAILS | Ad set name | campaign_name | The name of the ad set that you're viewing in reporting |
| Ad set ID | campaign_id | The unique ID of the ad set you're viewing in reports | |
| Ad set status (effective status) | adsetstatus | ||
| Ad set tags | adset_tags | List of tags assigned to your ad set | |
| Ad set edit link | ad_group_edit_link | Link to edit the ad set in Facebook Ads | |
| Ad set configured status | adsetconfigured_status | ||
| Bid type | bidtype | ||
| Bid amount | bidamount | ||
| Ad set bid info | bidinfo | ||
| Start date | adsetstart_time | ||
| End date | adsetend_time | ||
| Start date & time | adsetstart_time_exact | ||
| End date & time | adsetend_time_exact | ||
| Daily budget | adsetdaily_budget | ||
| Lifetime budget | adsetlifetime_budget | ||
| Lifetime minimum spend target | lifetime_min_spend_target | Lifetime minimum spend target for an ad set defined in your account currency. You must specify the lifetime budget at the ad campaign level | |
| Lifetime spend cap | lifetime_spend_cap | Daily spend cap of the ad set defined in your account currency. You must specify the daily budget in the campaign | |
| Budget remaining | adsetbudget_remaining | ||
| Targeting | adsettargeting | ||
| Targeting maximum age | adsettargeting_age_max | Maximum of age range defined by user for ad set targeting. A breakdown of the data in the "Targeting" dimension | |
| Targeting minimum age | adsettargeting_age_min | Minimum of age range defined by user for ad set targeting. A breakdown of the data in the "Targeting" dimension | |
| Targeting country location | adsettargeting_geo_location_countries | Countries defined by user for ad set targeting. A breakdown of the data in the "Targeting" dimension | |
| Targeting country groups | adsettargeting_geo_location_country_groups | Country groups defined by user for ad set targeting. A breakdown of the data in the "Targeting" dimension | |
| Targeting location type | adsettargeting_geo_location_type | Location types defined by user for ad set targeting. A breakdown of the data in the "Targeting" dimension | |
| Promoted object | adsetpromoted_object | ||
| Ad set optimization goal | optimization_goal | The optimization goal you selected for your ad or ad set. Your optimization goal reflects what you want to optimize for the ads | |
| AD DETAILS | Ad name | adgroup_name | The name of the ad that you're viewing in the report |
| Ad ID | adgroup_id | The unique ID of the ad that you're viewing in reporting | |
| Ad status (effective status) | adstatus | ||
| Ad tags | ad_tags | List of tags assigned to your ad | |
| Ad preview URL: desktop feed | desktop_feed_preview_url | URL to a preview of the ad, as seen in the desktop feed standard placement | |
| Ad preview URL: Facebook story | facebook_story_preview_url | URL to a preview of the ad, as seen in the Facebook story mobile placement | |
| Ad preview URL: right column | right_column_preview_url | URL to a preview of the ad, as seen in the right column standard placement | |
| Ad preview URL: mobile feed | mobile_feed_preview_url | URL to a preview of the ad, as seen in the mobile feed standard placement | |
| Ad preview URL: Instagram | instagram_preview_url | URL to a preview of the ad, as seen in the Instagram standard placement | |
| Ad preview URL: Instagram story | instagram_story_preview_url | URL to a preview of the ad, as seen in the Instagram Story placement | |
| Ad preview URL: mobile banner | mobile_banner_preview_url | URL to a preview of the ad, as seen in the mobile banner placement | |
| Ad preview URL: mobile interstitial | mobile_interstitial_preview_url | URL to a preview of the ad, as seen in the mobile interstitial placement | |
| Ad configured status | adconfigured_status | ||
| Ad bid info | adbid_info | ||
| Ad creative ID | creative_id | ||
| Ad creative name | creative_name | ||
| Ad title | creative_title | ||
| Ad body | creative_body | ||
| Object type | creative_object_type | ||
| Call-to-action type | creative_call_to_action_type | ||
| Ad creative thumbnail URL | creative_thumbnail_url | ||
| Ad creative image URL | creative_image_url | ||
| Ad creative image | creative_image | ||
| Destination URL | destinationURL | ||
| Internal destination URL | creative_link_url | ||
| External destination URL | creative_object_url | ||
| URL tags | creative_url_tags | ||
| Tracking template URL | creative_template_url | ||
| Tracking specs | adtracking_specs | ||
| Conversion specs | adconversion_specs | ||
| Review feedback | adreview_feedback | ||
| Source (utm) | utm_source | Value of the utm_source parameter extracted from the ad destination URL | |
| Medium (utm) | utm_medium | Value of the utm_medium parameter extracted from the ad destination URL | |
| Campaign (utm) | utm_campaign | Value of the utm_campaign parameter extracted from the ad destination URL | |
| Content (utm) | utm_content | Value of the utm_content parameter extracted from the ad destination URL | |
| Term (utm) | utm_term | Value of the utm_term parameter extracted from the ad destination URL | |
| PROMOTED POST | Post ID | promoted_post_id | |
| Post Instagram ID | promoted_post_id_ig | ||
| Post type | promoted_post_type | ||
| Post source | promoted_post_source | ||
| Page name | promoted_page_name | The Facebook Page associated with the business your ad is promoting. Only works at ad level | |
| Page ID | promoted_page_id | ID of the Facebook Page associated with the business your ad is promoting. Only works at ad level | |
| Post name | promoted_post_name | ||
| Post caption | promoted_post_caption | ||
| Post message | promoted_post_message | ||
| Post story | promoted_post_story | ||
| Post description | promoted_post_description | ||
| Promoted post destination URL | promoted_post_destination_url | ||
| Existing post destination URL | promoted_destination_url | ||
| Post privacy | promoted_post_privacy | ||
| Post privacy description | promoted_post_privacy_description | ||
| Post icon | promoted_post_icon | ||
| Post thumbnail URL | promoted_post_picture | ||
| Promoted post thumbnail | promoted_post_picture_image | ||
| Post image URL | promoted_post_full_picture | ||
| Post created date | promoted_post_created_time | ||
| Link to post | promoted_post_permalink_url | ||
| Link to Instagram post | promoted_post_permalink_url_ig | ||
| LEAD ADS | Lead form ID | lead_form_id | |
| Lead form name | lead_form_name | ||
| Lead form status | lead_form_status | ||
| Lead created | lead_created_time | ||
| Lead ID | lead_id | ||
| Lead info | lead_info | ||
| Lead info (JSON) | lead_info_json | ||
| Lead email | lead_email | ||
| Lead phone number | lead_phone_number | ||
| Lead full name | lead_full_name | ||
| Lead company name | lead_company_name | ||
| Lead country | lead_country | ||
| Lead state | lead_state | ||
| Lead field 1 name | lead_name_f1 | ||
| Lead field 2 name | lead_name_f2 | ||
| Lead field 3 name | lead_name_f3 | ||
| Lead field 4 name | lead_name_f4 | ||
| Lead field 5 name | lead_name_f5 | ||
| Lead field 6 name | lead_name_f6 | ||
| Lead field 1 value | lead_value_f1 | ||
| Lead field 2 value | lead_value_f2 | ||
| Lead field 3 value | lead_value_f3 | ||
| Lead field 4 value | lead_value_f4 | ||
| Lead field 5 value | lead_value_f5 | ||
| Lead field 6 value | lead_value_f6 | ||
| CAROUSEL CARD | Carousel card ID | ActionCarouselCardId | |
| Carousel card name | ActionCarouselCardName | ||
| Carousel card description | carousel_card_description | Description of carousel card | |
| Carousel card call to action type | carousel_card_call_to_action_type | Call to action type of carousel card | |
| Carousel card target URL | carousel_card_target_url | Target URL of carousel card | |
| Carousel card image URL | carousel_card_image_url | The image URL of the carousel card | |
| Carousel card image | carousel_card_image | The image of the carousel card | |
| REACH ESTIMATES | Reach estimate: users | reach_estimate_users | |
| Reach estimate: daily active users | reach_estimate_daily_active_users | ||
| Reach estimate: min bid amount | reach_estimate_bid_amount_min | ||
| Reach estimate: median bid amount | reach_estimate_bid_amount_median | ||
| Reach estimate: max bid amount | reach_estimate_bid_amount_max | ||
| Reach estimate: bid estimate curve JSON | reach_estimate_bid_curve_json | ||
| Reach estimate: bid estimate curve for spend | reach_estimate_bid_curve_spend | ||
| Reach estimate: bid estimate curve for reach | reach_estimate_bid_curve_reach | ||
| Reach estimate: bid estimate curve for impressions | reach_estimate_bid_curve_impressions | ||
| Reach estimate: bid estimate curve for actions | reach_estimate_bid_curve_actions | ||
| PERFORMANCE | Quality ranking (text) | quality_score_organic_text | Ad's perceived quality compared with ads competing for the same audience |
| Engagement Rate Ranking (text) | quality_score_ectr_text | Ad's expected engagement rate compared with ads competing for the same audience | |
| Conversion Rate Ranking (text) | quality_score_ecvr_text | Ad's expected conversion rate compared with ads that had the same optimisation goal and competed for the same audience | |
| DYNAMIC CREATIVE ADS | Body asset ID | body_asset_id | Body asset ID |
| Body asset text | body_asset_text | Body asset text | |
| Description asset ID | description_asset_id | Description asset ID | |
| Description asset text | description_asset_text | Description asset text | |
| Image asset ID | image_asset_id | ID for an image asset | |
| Image asset name | image_asset_name | Name for an image asset | |
| Image asset hash | image_asset_hash | Hash for an image asset | |
| Image asset URL | image_asset_url | URL for an image asset | |
| Title asset ID | title_asset_id | Title asset ID | |
| Title asset text | title_asset_text | Title asset text | |
| Call to action asset ID | call_to_action_asset_id | Call to action asset asset ID | |
| Call to action asset name | call_to_action_asset_name | Call to action asset name | |
| Link asset ID | link_url_asset_id | Link asset ID | |
| Link asset website URL | link_url_asset_website_url | Website URL for a link URL asset | |
| Link URL asset display URL | link_url_asset_display_url | Link URL asset display URL | |
| Video asset name | video_asset_video_name | Video asset name | |
| Video asset ID | video_asset_id | Video asset ID | |
| Video asset video ID | video_asset_video_id | Video asset video ID | |
| Video asset URL | video_asset_url | Video asset URL | |
| Video asset thumbnail URL | video_asset_thumbnail_url | Video asset thumbnail URL | |
| Video asset thumbnail image | video_asset_thumbnail_image | Video asset thumbnail image | |
| DEPRECATED | Reach estimate: bid estimate curve JSON | OLD_reach_estimate_bid_curve_json | Please note that this field will be removed on 2020-01-20 |
| Reach estimate: bid estimate curve for reach | OLD_reach_estimate_bid_curve_reach | Please note that this field will be removed on 2020-01-20 | |
| Reach estimate: max bid amount | OLD_reach_estimate_bid_amount_max | Please note that this field will be removed on 2020-01-20 | |
| Reach estimate: median bid amount | OLD_reach_estimate_bid_amount_median | Please note that this field will be removed on 2020-01-20 | |
| Reach estimate: users | OLD_reach_estimate_users | Please note that this field will be removed on 2020-01-20 | |
| Reach estimate: min bid amount | OLD_reach_estimate_bid_amount_min | Please note that this field will be removed on 2020-01-20 | |
| Reach estimate: bid estimate curve for impressions | OLD_reach_estimate_bid_curve_impressions | Please note that this field will be removed on 2020-01-20 | |
| Reach estimate: bid estimate curve for actions | OLD_reach_estimate_bid_curve_actions | Please note that this field will be removed on 2020-01-20 | |
| Relevance score positive feedback (deprecated) | relevance_positive_feedback | Please note that this field will be removed on 2020-01-20 | |
| Relevance score negative feedback (deprecated) | relevance_negative_feedback | Please note that this field will be removed on 2020-01-20 | |
| Relevance score status | relevance_status | Relevance score status. Please note that this field will be removed on 2020-03-25 | |
| Ad preview URL: instant article | instant_article_preview_url | URL to a preview of the ad, as seen in the instant article standard placement. Please note that this field will be removed on 2023-12-12 | |
| Reach estimate: bid estimate curve for spend | OLD_reach_estimate_bid_curve_spend | Please note that this field will be removed on 2020-01-20 |