--- title: "Settings" slug: "settings" updated: 2026-11-05T14:12:49Z published: 2026-11-05T14:12:49Z canonical: "docs.supermetrics.com/settings" --- > ## Documentation Index > Fetch the complete documentation index at: https://docs.supermetrics.com/llms.txt > Use this file to discover all available pages before exploring further. # Settings Settings are additional properties to alter your query request or response. ## General settings These settings are available for all data sources. - **allow_sum_unique** bool Enable summing of values that should normally not be summed, such as ratios and percentages. Defaults to false. - **blanks_to_zero** bool Turn all missing metric values into zeroes. This includes nulls and empty strings. Defaults to false. - **case_insensitive_dimension_merge** bool Split query results by dimensions in a case-insensitive manner. Last occurred dimensions value is kept as the final dimension value. Defaults to false. - **clean_invalid_dates** bool Ensure return values are date strings based on field's data type. Non-date values are replaced with nulls. Defaults to false. - **clean_numeric_types** bool Ensure return values are either integers or floats, based on field's data type. Non-numeric values are replaced with nulls. Defaults to false. - **combine_dimensions** bool Combine all dimension values into one dimension instead, separated by the vertical pipe character. Defaults to false. - **decode_json_fields** bool Return JSON string values as native data structures if field's data type is string.text.json. Empty strings are replaced with nulls. Failure to decode a string will fail the request with a DECODE_JSON_FIELDS_FAILURE error. Applicable to keyjson and ndjson output formats. Defaults to false. - **dimensions_after_metrics** bool Return metrics before the dimensions. Defaults to false. - **dimensions_max_bytes** int Truncate all dimension values to specified maximum byte length. Unicode characters can contain multiple bytes. Truncated values are appended with "...". - **dimensions_max_length** int Truncate all dimension values to specified maximum character length. Unicode characters are counted as one character. Truncated values are appended with "...". - **dimensions_to_lowercase** bool Lowercase all dimension values before splitting by dimensions. Defaults to false. - **dimensions_to_strings** bool Convert non-string dimension values into strings. Null values are kept as-is. Defaults to false. - **exclude_invalid_accounts** bool Validates the accounts before running the query and automatically removes accounts from query results when they have been deactivated, or the user does not have permission to access them, instead of failing the query. Defaults to false. - **exclude_unavailable_accounts** bool *To be deprecated.* Automatically remove accounts from query when they can't be found, instead of returning an QUERY_ACCOUNT_UNAVAILABLE error. Defaults to false. - **metrics_in_rows** bool Pivot results and show metrics in rows instead in columns. Defaults to false. - **multilevel_col_headers** bool Return several rows of column headers, one row for each pivoted dimension and metric. Defaults to false. - **no_dimensions** bool Split by the requested dimensions but do not return values for them. Defaults to false. - **no_headers** bool Do not return any header rows in the result rows. Defaults to false. - **no_json_keys** bool Do not include keys into JSON output format. Applicable to json, keyjson and ndjson output formats. Default value depends on the output format. - **no_rounding** bool Disable rounding metric values. Defaults to false. - **round_metrics_to** int Round all metric values to a specific decimals amount. Defaults to 4. - **show_all_time_values** bool When splitting the data by a time dimension, this setting ensures all time values (dates / weeks / months / years) will be returned, even if there's no data for some of them. Defaults to false. - **timezone** string Timezone to use when converting a relative query date range into fixed dates. In some data sources, this setting can also affect query results. Value should be a valid timezone database name. - **use_historical_start_date** bool When necessary, automatically adjust query start date to the earliest historical start date which the data source supports, instead of returning an START_DATE_HISTORICAL error. Defaults to false. ## Data source settings Settings below are available only for specific data sources. The list is sorted by data source ID. ### Adobe Analytics (ADA) - **disable_count_repeat_instances** bool Disable counting repeat instances. Defaults to false. ### Google Ads (AW) - **brand_keywords** string Brand keywords are separated by a vertical pipe character. Used to distinguish branded searches from non-branded ones when you're using the "Branded vs. non-branded search queries" dimension. - **geo_view** bool Enable geo view on Geo Performance Report for row locations. Defaults to false. - **include_zero_impressions** bool Include rows with zero impressions into the queried Google Ads report. This can greatly impact the amount of raw data fetched and will make the query slower. Defaults to false. ### Call Rail (CALR) - **report_type** string Query report type. - Call-Calls - FormSubmission-Form submissions ### Criteo (CRI) - **currency** string Currency code for metrics in ISO 4217. Defaults to EUR. ### Facebook Ads (FA) - **action_report_time** string Determines the report time of action stats. Defaults to impression. - impression-On impression date - conversion-On conversion date - mixed-Mixed - **conversion_window** string Defines the Facebook Ads conversion window. Defaults to no value. - -Default (7 d click + 1 d view) - 28D_CLICK-28 d click - 7D_CLICK-7 d click - 1D_CLICK-1 d click - 28D_VIEW-28 d view - 7D_VIEW-7 d view - 1D_VIEW-1 d view - 28D_CLICK;28D_VIEW-28 d click + 28 d view - 28D_CLICK;7D_VIEW-28 d click + 7 d view - 28D_CLICK;1D_VIEW-28 d click + 1 d view - 7D_CLICK;28D_VIEW-7 d click + 28 d view - 7D_CLICK;7D_VIEW-7 d click + 7 d view - 1D_CLICK;28D_VIEW-1 d click + 28 d view - 1D_CLICK;7D_VIEW-1 d click + 7 d view - 1D_CLICK;1D_VIEW-1 d click + 1 d view - 1D_EV-1 d engaged view - 1D_VIEW_FIRST_CONVERSION-1 d view first conversion - 7D_VIEW_FIRST_CONVERSION-7 d view first conversion - 28D_VIEW_FIRST_CONVERSION-28 d view first conversion - 1D_CLICK_FIRST_CONVERSION-1 d click first conversion - 7D_CLICK_FIRST_CONVERSION-7 d click first conversion - 28D_CLICK_FIRST_CONVERSION-28 d click first conversion - **exclude_inactive_accounts** bool Automatically removes accounts from the query when Facebook account status is disabled (2) or temporary unavailable (101). Facebook account status is fetched periodically, and does not update in real time. Defaults to false. - **last_promoted_post** bool Gets the last post instead of the first among conversion and tracking specs for an ad. Defaults to false. ### Facebook Insights (FB) - **localization** string Report locale code to support multi-language posts. Defaults to en_US. ### Google Search Console (GW) - **report_type** string Query report type. - STANDARD-Search analytics - SITEMAPS-Sitemaps - ERRORSAMPLES-Crawl error samples - ERRORCOUNTS-Crawl error stats - SEARCHAPPEARANCE-Search appearance analytics - **data_precision** string When report_type is STANDARD: use this to define analytics data accuracy. Higher accuracy will make the query slower. - 1_NORMAL-Normal - 2_ENHANCED-Enhanced - 3_HIGH-High, contact us for availability. - 4_VERY_HIGH-Very high, contact us for availability. - **discrepancy_correction** string When requested, we try to correct discrepancies in raw data to match totals shown in the GSC UI. - AGGREGATE_LEVEL-Aggregate-level correction. Rows with "(unknown)" are added for adjustment values. - PAGE_LEVEL-Page-level correction. A row with "(unknown)" is added for adjustment values. - **brand_keywords** string When report_type is STANDARD: brand keywords are separated by a vertical pipe character. Used to distinguish branded searches from non-branded ones, when you're using the "Branded vs. non-branded search queries" dimension. Defaults to the domain name as the brand term. ### HubSpot (HS) - **contact_date_field** string Defines what field the date range and date dimensions are based on when reporting Contacts data. Defaults to lifecycle_state_changed. - contact_created-Contact created date - lifecycle_state_changed-Lifecycle stage changed date - **ticket_date_field** string Defines what the date range and date dimensions are based on for reporting Tickets data. Defaults to ticket_created. - ticket_created-Ticket created date - ticket_closed-Ticket closed date - **email_date_field** string Defines what the date range and date dimensions are based off of for reporting Email data. Defaults to email_event_sent_by_date. - email_event_created_date-Email event date - email_event_sent_by_date-Email send date - **deal_date_field** string Defines what field the date range and date dimensions are based on when reporting Deals data. Defaults to deal_closed. - deal_created-Deal created date - deal_closed-Deal closed date ### Pinterest Ads (PIA) - **action_report_time** string Determines the report time of action stats. Defaults to AD_EVENT. - AD_EVENT: Date of ad event (impression, click, engagement) - CONVERSION_EVENT: Date of conversion event - **attribution_window** string Defines the Pinterest Ads attribution window. Defaults to 30_30_1. - 60_60_60-60 d click + 60 d engagement + 60 d view - 60_60_30-60 d click + 60 d engagement + 30 d view - 60_60_7-60 d click + 60 d engagement + 7 d view - 60_60_1-60 d click + 60 d engagement + 1 d view - 60_30_30-60 d click + 30 d engagement + 30 d view - 60_30_7-60 d click + 30 d engagement + 7 d view - 60_30_1-60 d click + 30 d engagement + 1 d view - 60_7_7-60 d click + 7 d engagement + 7 d view - 60_7_1-60 d click + 7 d engagement + 1 d view - 60_1_1-60 d click + 1 d engagement + 1 d view - 30_60_1-30 d click + 60 d engagement + 1 d view - 30_30_30-30 d click + 30 d engagement + 30 d view - 30_30_7-30 d click + 30 d engagement + 7 d view - 30_30_1-30 d click + 30 d engagement + 1 d view - 30_7_7-30 d click + 7 d engagement + 7 d view - 30_7_1-30 d click + 7 d engagement + 1 d view - 30_1_1-30 d click + 1 d engagement + 1 d view - 7_7_7-7 d click + 7 d engagement + 7 d view - 7_7_1-7 d click + 7 d engagement + 1 d view - 7_1_1-7 d click + 1 d engagement + 1 d view - 1_1_1-1 d click + 1 d engagement + 1 d view - 7_0_0-7 d click - 1_0_0-1 d click ### Quora Ads (QA) - **conversion_window** string Defines the Quora Ads conversion window. Defaults to no value. - -28 d click + 1 d view - CLICK_28_DAY-28 d click - VIEW_1_DAY-1 d view - **conversion_type** string Defines the Quora Ads conversion type. Defaults to Generic. - Generic - AppInstall - Purchase - GenerateLead - CompleteRegistration - AddPaymentInfo - AddToCart - AddToWishlist - InitiateCheckout - Search ### Snapchat Marketing (SCM) - **action_report_time** string Determines the report time of conversion metrics. Defaults to conversion. - conversion-On conversion date - impression-On impression date - **attribution_window** string Defines the Snapchat Marketing attribution window. Defaults to 1_DAY_1_DAY. - NONE_1_DAY-None view + 1 d swipe - NONE_7_DAY-None view + 7 d swipe - NONE_28_DAY-None view + 28 d swipe - 1_HOUR_1_DAY-1 h view + 1 d swipe - 1_HOUR_7_DAY-1 h view + 7 d swipe - 1_HOUR_28_DAY-1 h view + 28 d swipe - 3_HOUR_1_DAY-3 h view + 1 d swipe - 3_HOUR_7_DAY-3 h view + 7 d swipe - 3_HOUR_28_DAY-3 h view + 28 d swipe - 6_HOUR_1_DAY-6 h view + 1 d swipe - 6_HOUR_7_DAY-6 h view + 7 d swipe - 6_HOUR_28_DAY-6 h view + 28 d swipe - 1_DAY_1_DAY-1 d view + 1 d swipe - 1_DAY_7_DAY-1 d view + 7 d swipe - 1_DAY_28_DAY-1 d view + 28 d swipe - 7_DAY_7_DAY-7 d view + 7 d swipe - 7_DAY_28_DAY-7 d view + 28 d swipe - 28_DAY_28_DAY-28 d view + 28 d swipe ### Salesforce (SF) - **deal_date_field** string Defines what field the date range and date dimensions are based on when reporting Opportunities data. Defaults to deal_closed. - deal_created-Opportunity created date - deal_closed-Opportunity closed date ### Snowflake (SNO) - **query** string Snowflake SQL query string. ### Semrush (SR) - **database** string SEMRush database. - **device_type** string Device type. - all - desktop - smartphone_apple - smartphone_android - tablet_apple - tablet_android - **display_date** string Display date in format YYYYMMDD. Used in historical data queries. - **granularity** string Granularity. - monthly - daily - **target_type** string Target type. - domain - root_domain - url ### Vimeo Public Data (VMPD) - **report_type** string Query report type. - User-Vimeo user data - Videos-Vimeo video data - UploadedVideos-Vimeo video uploads - **result_type** string For report_type User: result type. Defaults to relevant. - relevant - date - alphabetical - followers - videos - **result_type** string For report_type Videos: result type. Defaults to relevant. - relevant - date - alphabetical - comments - duration - likes - plays - **result_type** string For report_type Uploaded Videos: result type. Defaults to default. - default - date - alphabetical - comments - duration - last_user_action_event_date - likes - modified_time - plays ### Yandex.Metrica (YAM) - **avoid_sampling** bool Request Yandex.Metrica to send data without sampling by using the best accuracy possible. Using this setting can significantly slow down queries. Defaults to false.