{"activeVersionTag":"latest","latestAvailableVersionTag":"latest","collection":{"info":{"_postman_id":"36608be9-97b9-4b84-be68-0aa610750f90","name":"Batch API","description":"## We have launched our new [Docs](https://developers.similarweb.com/docs)!\n\nTo get the most up-to-date information about our API Offerings please go [here](https://developers.similarweb.com/reference/intro-to-the-batch-api-datasets).\n\n---\n\n---\n\n---\n\n---\n\n---\n\n---\n\nEasily extract valuable digital traffic data at scale for any analysis purpose. The Similarweb new and enhanced Batch API has additional capabilities incorporated to retrieve data reports in the most efficient manner possible.\n\nYou can now group your requests so your code runs faster and more efficiently. The Batch API allows you to make requests for up to 1M domains/apps/keywords for multiple countries and so many different metrics (find them detailed below).\n\nPlease note that you will need a different API key designated for the Batch API. It is not possible to use a REST API key to make Batch API requests. To get your API Key, go to the [Similarweb Account Page](https://account.similarweb.com/batch-api).\n\nTo visit the REST API documentation, click [here](https://developers.similarweb.com/docs).\n\n# What's New?\n\nSeptember 2023\n\nOur new [docs](https://developers.similarweb.com/docs) are available! to get the most up-to-date information about our API Offerings please go [here](https://developers.similarweb.com/reference/intro-to-the-batch-api-datasets).\n\nMay 2023\n\n#### Traffic Sources\n\nReturns the distinct sources driving traffic to websites.\n\n1 new metric - **desktop_traffic_source_share**\n\n#### Company Information\n\nReturns company data correlated to websites.\n\n7 new metrics - **company_headquarters_country, company_headquarters_state, company_headquarters_city, company_headquarters_zip_code, company_name, company_estimated_revenue_range, company_employee_range**\n\nApril 2023\n\n#### Keyword Monthly Volume Monthly\n\nThe Monthly number of searches performed for the keyword in Google, in the selected country, across desktop and mobile.\n\nNew Metric - all_keyword_monthly_search_volume\n\nData Availability - 3 years history.\n\n#### Keyword Difficulty\n\nReturns a measure of how difficult it would be to rank on the top 20 results in google for this keyword in the selected country.\n\nNew Metric - desktop_keyword_difficulty\n\nMarch 2023\n\n#### New Vs Returning\n\nReturns the unique users that were not spotted visiting the site for at least three months, the remaining visitors are returning visitors.\n\nTwo new metrics - **desktop_new_visitors, desktop_returning_visitors**\n\n#### Desktop & Mobile Audience Interests\n\nReturns which domains interest a visitor audience of a specific domain.\n\n4 new metrics - **desktop_audience_interests_affinity, desktop_audience_interests_overlap, mobile_audience_interests_affinity, mobile_audience_interests_overlap**\n\n###### January 2023\n\n#### Age & Gender Demographics\n\nReturns a Gender/Age Distribution of a website's users (not available for WW).\n\n14 new metrics - **all_males_share, all_females_share, desktop_ages_18_to_24_share, desktop_ages_25_to_34_share, desktop_ages_35_to_44_share, desktop_ages_45_to_54_share, desktop_ages_55_to_64_share, desktop_ages_65_plus_share, mobile_ages_18_to_24_share, mobile_ages_25_to_34_share, mobile_ages_35_to_44_share, mobile_ages_45_to_54_share, mobile_ages_55_to_64_share, mobile_ages_65_plus_share.**\n\n#### PPC Spend\n\nReturns an estimation of the domain's spending on PPC search terms.\n\nTwo new metrics **desktop_ppc_spend_usd** and **mobile_ppc_spend_usd.**\n\n#### App Intelligence\n\nWe've now added the App Intelligence metrics!\n\nSix new metrics **apps_daily_active_users**, **apps_unique_installs**, **apps_downloads**, **apps_sessions_per_user**, **apps_avg_usage_time_per_session**, and **apps_avg_total_usage_time_per_user**.\n\n#### Deduplicated Audience\n\nReturns the average number of individuals who visited across desktop and mobile.\n\nthe new metric is - **deduplicated_audience**.\n\n#### Similar Sites\n\nReveal websites that are similar in their content, audience, keywords, and referrals compared to the chosen website.\n\nthe new metric is - **site_affinity**.\n\n###### December 2022\n\n#### More date selection functionality\n\nWe are now supporting 4 ways of expressing dates selection -\n\n**start & end date** - just specify the dates you are interested in.\n\n**all history** - grab all the historical data we have available with one request.\n\n**latest** - set the end date to the latest available automatically to always get the freshest data.\n\n**window size** - in case you need to specify a relative time frame compared to the end date _(start_date = end_date - window_size)_ - for example - the last 3 months, last week, etc, usually work with the latest parameter.\n\n###### October 2022\n\n#### App Intelligence Premium\n\nComplete the view of your digital landscape with App Intelligence Premium, powered by data.ai (formerly App Annie). Query 20 metrics boasting best-in-class data across Android and iOS in up to 60 countries.\n\n###### August 2022\n\n#### 5 years of historical data\n\nAnalyze 61 months of historical data for a better understanding of market trends over time. 5 years of historical data is a premium add-on. Get in touch with your account manager for more information.\n\nTo see which metrics are available, use the [Data Availability](https://documenter.getpostman.com/view/8688131/SWLe78Fo#2ddedd58-f19d-46b9-9782-a86fc45d80d8) describe endpoint. Remember to browse daily, weekly, and monthly granularity.\n\n#### Pageviews\n\nTotal pageviews is a new metric avilable via the Batch API. Request desktop, mobile web, or total traffic. Available exclusively in daily granularity.\n\n#### Mobile Web Algorithm Update\n\nWe released a brand new Mobile Web Algorithm on August 22, improving Similarweb’s accuracy across more sites, site sizes, and countries. This impacts any metric that has a mobile web or a total traffic component (mobile web + desktop). Read more [here](https://support.similarweb.com/hc/en-us/articles/6171887839389-Guide-to-Similarweb-s-Mobile-Web-Algorithm-Update-2022), or speak to your account manager for more information.\n\n# Traffic and Engagement Metrics\n\nHere are the supported metrics with their granularity:\n\n| **Metric Name** | **Supported Granularity** | **Type** | **Description** | **Primary Key** | **Metric Group** |\n| --- | --- | --- | --- | --- | --- |\n| all_traffic_visits | Monthly, Weekly, Daily | Double | Returns estimated number of visits for the domain. | site, country | Traffic & Engagement |\n| all_page_views | Daily | Double | Returns the total number of pageviews for the selected domain. | site, country | Traffic & Engagement |\n| all_traffic_pages_per_visit | Monthly, Weekly, Daily | Double | Returns the average page views per visit for the given domain. | site, country | Traffic & Engagement |\n| all_traffic_average_visit_duration | Monthly, Weekly, Daily | Double | Returns the average visit duration on the given domain (in seconds). | site, country | Traffic & Engagement |\n| all_traffic_bounce_rate | Monthly, Weekly, Daily | Double | Returns the bounce rate for the given domain. | site, country | Traffic & Engagement |\n| desktop_vs_mobile_split | Monthly | Double | Returns desktop vs. mobile web traffic share split. This metric costs 2 data points (desktop and mobile). | site, country | Traffic & Engagement |\n| desktop_visits | Monthly, Weekly, Daily | Double | Returns the estimated number of desktop visits for the domain. | site, country | Traffic & Engagement |\n| desktop_unique_visitors | Monthly, Daily | Double | Returns unique desktop visitors. | site, country | Traffic & Engagement |\n| desktop_page_views | Daily | Double | Returns the total number of desktop pageviews for the selected domain. | site, country | Traffic & Engagement |\n| desktop_pages_per_visit | Monthly, Weekly, Daily | Double | Returns the average page views per desktop visit for the given domain. | site, country | Traffic & Engagement |\n| desktop_average_visit_duration | Monthly, Weekly, Daily | Double | Returns the average desktop visit duration on the given domain (in seconds). | site, country | Traffic & Engagement |\n| desktop_bounce_rate | Monthly, Weekly, Daily | Double | Returns the desktop bounce rate for the given domain. | site, country | Traffic & Engagement |\n| mobile_visits | Monthly, Weekly, Daily | Double | Returns estimated number of mobile web visits for the domain. | site, country | Traffic & Engagement |\n| mobile_unique_visitors | Monthly, Daily | Double | Returns unique mobile web visitors. | site, country | Traffic & Engagement |\n| mobile_page_views | Daily | Double | Returns the total number of mobile pageviews for the selected domain. | site, country | Traffic & Engagement |\n| mobile_pages_per_visit | Monthly, Weekly, Daily | Double | Returns the average page views per mobile web visit for the given domain. | site, country | Traffic & Engagement |\n| mobile_average_visit_duration | Monthly, Weekly, Daily | Double | Returns the average mobile web visit duration on the given domain (in seconds). | site, country | Traffic & Engagement |\n| mobile_bounce_rate | Monthly, Weekly, Daily | Double | Returns the mobile web bounce rate for the given domain. | site, country | Traffic & Engagement |\n| global_rank | Monthly | Integer | Returns SimilarWeb's monthly Global Rank for a given domain. | site, country | Traffic & Engagement |\n| country_rank | Monthly | Integer | Returns SimilarWeb's monthly Country Rank for a given domain. | site, country | Traffic & Engagement |\n| category_rank_new | Monthly | Integer | Returns the Global Rank within its given category. | site, country | Traffic & Engagement |\n| category | Monthly | String | Returns the top category associated with the domain. | site, country | Traffic & Engagement |\n| desktop_marketing_channels | Monthly, Weekly, Daily | Array | Returns the overview of traffic sources driving desktop traffic to the domain broken down by source type and traffic share. This metric supports JSON format only. | site, country | Marketing Channels |\n| mobile_marketing_channels | Monthly | Array | Returns the overview of traffic sources driving mobile web traffic to the domain broken down by source type and traffic share. This metric supports JSON format only. | site, country | Marketing Channels |\n| desktop_top_geo | Monthly | Array | Returns the desktop traffic share broken down by the top 10 countries driving traffic to the website, between the selected dates (min. 1 month). The countries are represented by their [two-letter country codes](https://en.wikipedia.org/wiki/ISO_3166-1_alpha-2). | site | Top Geo |\n| site_affinity | Monthly | Double | Returns a similarity grade of two websites (Similar sites). | site_1, site_2 | Similar Sites |\n| deduplicated_audience | Monthly | Double | Returns the average number of individuals who visited across desktop and mobile. | site, country | Traffic & Engagement |\n| desktop_ppc_spend_usd | Monthly | Double | Returns an estimation of the domain spending on PPC search terms on desktop. | site, country | Traffic & Engagement |\n| mobile_ppc_spend_usd | Monthly | Double | Returns an estimation of the domain spending on PPC search terms on mobile. | site, country | Traffic & Engagement |\n| desktop_new_visitors | Monthly | Double | Returns the unique users that were not spotted visiting the site for at least three months, the remaining visitors are returning visitors. | site, country | Traffic & Engagement |\n| desktop_returning_visitors | Monthly | Double | Returns the unique users that were not spotted visiting the site for at least three months, the remaining visitors are returning visitors. | site, country | Traffic & Engagement |\n\n# Referral Traffic Metrics\n\n| Metric Name | Supported Granularity | Type | Description | Primary Key | Metric Group |\n| --- | --- | --- | --- | --- | --- |\n| desktop_referral_visits | Monthly | Double | Returns the desktop traffic visits of a referral, this metric is a one-to-many metric which means that for one key - a maximum of 1000 referrals values may be returned. | site, country, site2 | Desktop Referrals |\n| desktop_referral_share | Monthly | Double | Returns the traffic share of each referral from the overall traffic to the selected site in the selected country, this metric is a one-to-many metric which means that for one key - a maximum of 1000 referrals values may be returned. | site, country, site2 | Desktop Referrals |\n| desktop_referral_change | Monthly | Double | Returns the percentage of change in the traffic based on the selected period over the previous period, this metric is a one-to-many metric which means that for one key - a maximum of 1000 referrals values may be returned. | site, country, site2 | Desktop Referrals |\n| mobile_referral_visits | Monthly | Double | Returns the mobile traffic visits of a referral, this metric is a one-to-many metric which means that for one key - 1000 referrals values may be returned. | site, country, site2 | Mobile Referrals |\n| mobile_referral_share | Monthly | Double | Returns the traffic share of each referral from the overall traffic to the selected site in the selected country, this metric is a one-to-many metric which means that for one key - a maximum of 1000 referrals values may be returned. | site, country, site2 | Mobile Referrals |\n| mobile_referral_change | Monthly | Double | Returns the percentage of change in the traffic based on the selected period over the previous period, this metric is a one-to-many metric which means that for one key - a maximum of 1000 referrals values may be returned. | site, country, site2 | Mobile Referrals |\n| desktop_outgoing_referral_visits | Monthly | Double | Returns the desktop traffic visits of an outgoing referral, this metric is a one-to-many metric which means that for one key - 1000 referrals values may be returned. | site, country, site2 | Desktop Referrals |\n| desktop_outgoing_referral_share | Monthly | Double | Returns the traffic share of each referral from the overall traffic to the selected site in the selected country, this metric is a one-to-many metric which means that for one key - a maximum of 1000 outgoing referrals values may be returned. | site, country, site2 | Desktop Referrals |\n| desktop_outgoing_referral_change | Monthly | Double | Returns the percentage of change in the traffic based on the selected period over the previous period, this metric is a one-to-many metric which means that for one key - a maximum of 1000 outgoing referrals values may be returned. | site, country, site2 | Desktop Referrals |\n\n# Audience Interests Metrics\n\nReturns which domains interest a visitor audience of a specific domain.\n\n| **Metric Name** | **Supported Granularity** | **Type** | **Description** | **Primary Key** | **Table** | **Datapoints Deducted (datapoints:keyword)** |\n| --- | --- | --- | --- | --- | --- | --- |\n| **desktop_audience_interests_affinity** | Monthly | Double |  | Site, country, site_y | audience_interests | 1:1 |\n| **desktop_audience_interests_overlap** | Monthly | Double |  | Site, country, site_y | audience_interests | 1:1 |\n| **mobile_audience_interests_affinity** | Monthly | Double |  | Site, country, site_y | audience_interests | 1:1 |\n| **mobile_audience_interests_overlap** | Monthly | Double |  | Site, country, site_y | audience_interests | 1:1 |\n\n# Keyword Analysis Metrics\n\nThe below metrics are available to customers with Keyword Analysis included in their API subscription. Reach out to your Account Manager for more information.\n\nReporting for weekly keywords begins October 2021. Request up to 36 months of historical data, depending on your subscription permissions.\n\n\"7days\" granularity returns the last 7 days of available data. For this granularity, include `“latest”: true` in the body of the request.\n\nUp to 300k keywords are available per site. For pagination purposes, use “sort”, “limit”, “offset”, and \"sort_asc\". For example:\n\n_“sort”: desktop_keywords_paid_visits - the metric you'd like the report to be ordered by_\n\n\\*\"limit\": 10\\* - the number of top results\n\n\\*\"offset\": 0\\* - the number of top results to be skipped\n\n\\*\"sort_asc\": true\\* - the order of results. Enter \"true\" for ascending, or \"false\" for descending. Default is false.\n\n| **Metric Name** | **Supported Granularity** | **Type** | **Description** | **Primary Key** | **Metric Group** | **Datapoints Deducted (datapoints:keyword)** |\n| --- | --- | --- | --- | --- | --- | --- |\n| desktop_keywords_organic_visits | 7days, weekly | Double | Number of visits driven to a website by clicks on organic search results. | Site, country, keyword | Desktop Site Keywords | 1:100 |\n| desktop_keywords_organic_share | 7days, weekly | Double | Percentage occurence of search term in organic searches (compared to Paid searches). | Site, country, keyword | Desktop Site Keywords | 1:100 |\n| desktop_keywords_top_organic_url_position | 7days, weekly | Double | The URL's average organic position on the Google SERP in the selected timeframe. | Site, country, keyword | Desktop Site Keywords | 1:100 |\n| desktop_keywords_top_organic_url | 7days, weekly | String | Most recent URL displayed in organic Google search results, in the selected country, from the past 30 days. | Site, country, keyword | Desktop Site Keywords | 1:100 |\n| desktop_keywords_paid_visits | 7days, weekly | Double | Number of visits driven to a website by clicks on paid search results. | Site, country, keyword | Desktop Site Keywords | 1:100 |\n| desktop_keywords_paid_share | 7days, weekly | Double | Percentage occurence of search term in Paid searches (compared to organic). | Site, country, keyword | Desktop Site Keywords | 1:100 |\n| desktop_keywords_top_paid_url_position | 7days, weekly | Double | The URL's average paid position on the Google SERP in the selected timeframe. | Site, country, keyword | Desktop Site Keywords | 1:100 |\n| desktop_keywords_top_paid_url | 7days, weekly | String | Most recent URL displayed in paid Google search results, in the selected country, from the past 30 days. | Site, country, keyword | Desktop Site Keywords | 1:100 |\n| desktop_keywords_total_visits | 7days, weekly | Double | The Number of visits driven to a website by clicks on both organic and paid search results. | Site, country, keyword | Desktop Site Keywords | 1:100 |\n| desktop_keywords_total_share | 7days, weekly | Double | Percentage of search traffic sent by this keyword to the analyzed websites | Site, country, keyword | Desktop Site Keywords | 1:100 |\n| desktop_keywords_top_all_url_position | 7days, weekly | Double | The URL's average position for both paid and organic keywords on the Google SERP in the selected timeframe. | Site, country, keyword | Desktop Site Keywords | 1:100 |\n| desktop_keywords_top_all_url | 7days, weekly | String | Most recent URL displayed for both paid and organic Google search results, in the selected country, from the past 30 days. | Site, country, keyword | Desktop Site Keywords | 1:100 |\n| all_keyword_volume | Monthly | Double | The Annual average number of searches performed for the keyword in Google, in the selected country, across desktop and mobile. Reporting from 03/2022. | Keyword, country | Keywords | 1:25 |\n| all_keyword_monthly_search_volume | Monthly | Double | The Monthly number of searches performed for the keyword in Google, in the selected country, across desktop and mobile. | Keyword, country | Keywords | 1:25 |\n| all_keyword_cpc | Monthly | Double | Estimated price (USD) that advertisers pay to buy an ad in Google Adwords triggered by the keyword, in the selected country. Reporting from 03/2022. | Keyword, country | Keywords | 1:25 |\n| desktop_keyword_difficulty | Monthly | Double | Returns a measure of how difficult it would be to rank on the top 20 results in google for this keyword in the selected country.  <br>Available since 01/2021. | Keyword, Country | Keywords | 1:25 |\n\n# Shopper Intelligence Metrics\n\nThe following metrics are available exclusively to Similarweb Shopper Intelligence customers with Batch API access.\n\n| **Metric Name** | **Supported Granularity** | **Type** | **Description** | **Primary Key** | **Metric Group** | **Limit** |\n| --- | --- | --- | --- | --- | --- | --- |\n| category_sales_performance_cvr | Monthly | Double | Conversion rate is calculated by dividing unique purchases by product views in the selected domain and category | site,category_id,category_name | Shopper Brand Category 1st Party 3rd Party | Customizable. Default: 100. |\n| category_sales_performance_product_views | Monthly | Integer | The number of unique product views for the selected domain and category | site,category_id,category_name | Shopper Category 1st Party 3rd Party | Customizable. Default: 100. |\n| category_sales_performance_revenue | Monthly | Integer | The amount of revenue generated by the selected domain and category | site,category_id,category_name | Shopper Category 1st Party 3rd Party | Customizable. Default: 100. |\n| category_sales_performance_units_sold | Monthly | Integer | The number of units sold in the selected domain and category | site,category_id,category_name | Shopper Category 1st Party 3rd Party | Customizable. Default: 100. |\n| category_sales_performance_revenue_1P | Monthly | Double | The amount of revenue generated in the selected domain and category by first-party sales | site,category_id,category_name | Shopper Brand Category 1st Party 3rd Party | Customizable. Default: 100. |\n| category_sales_performance_revenue_3P | Monthly | Double | The amount of revenue generated in the selected domain and category by third-party sales. | site,category_id,category_name | Shopper Brand Category 1st Party 3rd Party | Customizable. Default: 100. |\n| category_sales_performance_units_sold_1P | Monthly | Double | The number of units sold in the selected domain and category by first-party sales. | site,category_id,category_name | Shopper Brand Category 1st Party 3rd Party | Customizable. Default: 100. |\n| category_sales_performance_units_sold_3P | Monthly | Double | The number of units sold in the selected domain and category by third-party sales. | site,category_id,category_name | Shopper Brand Category 1st Party 3rd Party | Customizable. Default: 100. |\n| category_sales_performance_top_brands_units_sold | Monthly | Integer | The number of units sold for the top brands in the selected domain and category. Query results include up to 80 brands. | site,category_id,category_name | Shopper Category Top Brands | 80 |\n| category_sales_performance_top_brands_revenue | Monthly | Integer | The amount of revenue generated by the top brands in the selected domain and category. Query results include up to 80 brands. | site,category_id,category_name | Shopper Category Top Brands | 80 |\n| category_sales_performance_top_brands_product_views | Monthly | Integer | The number of unique product views for the top brands in the selected domain and category. Query results include up to 80 brands. | site,category_id,category_name | Shopper Category Top Brands | 80 |\n| category_sales_performance_top_brands_cvr | Monthly | Double | Conversion rate is calculated by dividing unique purchases by product views in the selected domain and category. | site,category_id,category_name | Shopper Category Top Brands | 80 |\n| category_sales_performance_top_products_units_sold | Monthly | Integer | The number of units sold for the top products in the selected domain and category. Query results include up to 1,000 products. | site,category_id,category_name | Shopper Top Products Category | 1000 |\n| category_sales_performance_top_products_revenue | Monthly | Integer | The amount of revenue generated by the top products in the selected domain and category. Query results include up to 1,000 products. | site,category_id,category_name | Shopper Top Products Category | 1000 |\n| category_sales_performance_top_products_product_views | Monthly | Integer | The number of unique views for the top products in the selected domain and category. Query results include up to 1,000 products. | site,category_id,category_name | Shopper Top Products Category | 1000 |\n| category_sales_performance_top_products_average_unit_price | Monthly | Double | The average unit price of top products in selected domain, and category. Query results include up to 1,000 products. | site,category_id,category_name | Shopper Top Products Category | 1000 |\n| category_sales_performance_top_products_reviews | Monthly | Integer | The number of reviews for the top products in the selected domain and category. Query results include up to 1,000 products. | site,category_id,category_name | Shopper Top Products Category | 1000 |\n| category_sales_performance_top_products_rating | Monthly | Double | The rating of the top products in the selected domain and category. Query results include up to 1,000 products. | site,category_id,category_name | Shopper Top Products Category | 1000 |\n| category_onsite_search_top_keywords_total_clicks | Monthly | Integer | For each keyword, the number of unique clicks on products in the selected domain, category and time frame. If a consumer clicked on the same product twice in the same 30-min session it is counted as one click. | site,category_id,category_name | Shopper Top Keywords Category | 2000 |\n| category_onsite_search_top_keywords_organic_clicks_share | Monthly | Double | For each keyword, the percentage of organic clicks in the selected domain, category and time frame. | site,category_id,category_name | Shopper Top Keywords Category | 2000 |\n| category_onsite_search_top_keywords_paid_clicks_share | Monthly | Double | For each keyword, the percentage of paid clicks in the selected domain, category and time frame. | site,category_id,category_name | Shopper Top Keywords Category | 2000 |\n| category_onsite_search_top_keywords_top_brand | Monthly | Integer | For each keyword, the brand which received the most clicks in the selected category, domain and time frame. | site,category_id,category_name | Shopper Top Keywords Category | 2000 |\n| category_onsite_search_top_keywords_top_brand_share | Monthly | Double | For each keyword, percent of clicks the top brand received in the selected category and time frame. | site,category_id,category_name | Shopper Top Keywords Category | 2000 |\n| brand_sales_performance_cvr | Monthly | Double | Conversion rate is calculated by dividing unique purchases by product views in the selected domain and category. | site,brand,category_id,category_name | Shopper Brand Category 1st Party 3rd Party | Customizable. Default: 100. |\n| brand_sales_performance_product_views | Monthly | Integer | The number of unique product views for the selected brand in the selected domain and category. | site,brand,category_id,category_name | Shopper Brand Category 1st Party 3rd Party | Customizable. Default: 100. |\n| brand_sales_performance_revenue | Monthly | Integer | The amount of revenue generated by the selected brand in the selected domain and category. | site,brand,category_id,category_name | Shopper Brand Category 1st Party 3rd Party | Customizable. Default: 100. |\n| brand_sales_performance_units_sold | Monthly | Integer | The number of units sold by the selected brand in the selected domain and category. | site,brand,category_id,category_name | Shopper Brand Category 1st Party 3rd Party | Customizable. Default: 100. |\n| brand_sales_performance_revenue_1P | Monthly | Double | The amount of revenue generated by the selected brand in the selected domain and category by first-party sales. | site,brand,category_id,category_name | Shopper Brand Category 1st Party 3rd Party | Customizable. Default: 100. |\n| brand_sales_performance_revenue_3P | Monthly | Double | The amount of revenue generated by the selected brand in the selected domain and category by third-party sales. | site,brand,category_id,category_name | Shopper Brand Category 1st Party 3rd Party | Customizable. Default: 100. |\n| brand_sales_performance_units_sold_1P | Monthly | Double | The number of units sold by the selected brand in the selected domain and category by first-party sales. | site,brand,category_id,category_name | Shopper Brand Category 1st Party 3rd Party | Customizable. Default: 100. |\n| brand_sales_performance_units_sold_3P | Monthly | Double | The number of units sold by the selected brand in the selected domain and category by third-party sales. | site,brand,category_id,category_name | Shopper Brand Category 1st Party 3rd Party | Customizable. Default: 100. |\n| brand_sales_performance_top_products_units_sold | Monthly | Integer | The number of units sold for the top products by the selected brand in the selected domain and category. | site,brand,category_id,category_name | Shopper Top Products Brand | 1000 |\n| brand_sales_performance_top_products_revenue | Monthly | Integer | The amount of revenue generated by the top products by the selected brand in the selected domain and category. | site,brand,category_id,category_name | Shopper Top Products Brand | 1000 |\n| brand_sales_performance_top_products_product_views | Monthly | Integer | The number of unique views for the top products by the selected brand in the selected domain and category. | site,brand,category_id,category_name | Shopper Top Products Brand | 1000 |\n| brand_sales_performance_top_products_average_unit_price | Monthly | Double | The average unit price of top products by the selected brand in the selected domain and category. | site,brand,category_id,category_name | Shopper Top Products Brand | 1000 |\n| brand_sales_performance_top_products_reviews | Monthly | Integer | The number of reviews for the top products by the selected brand in the selected domain and category. | site,brand,category_id,category_name | Shopper Top Products Brand | 1000 |\n| brand_sales_performance_top_products_rating | Monthly | Double | The rating of the top products by the selected brand in the selected domain and category. | site,brand,category_id,category_name | Shopper Top Products Brand | 1000 |\n| brand_onsite_search_top_keywords_brand_clicks | Monthly | Integer | For each keyword, the number of unique clicks on the selected brand's products in the selected domain, category and time frame. If a consumer clicked on the same product twice in the same 30-min session it is counted as one click. | site,brand,category_id,category_name | Shopper Top Keywords Brand | 1000 |\n| brand_onsite_search_top_keywords_brand_organic_clicks_share | Monthly | Double | For each keyword, the percentage of organic clicks on the selected brand's products in the selected domain, category and time frame. | site,brand,category_id,category_name | Shopper Top Keywords Brand | 1000 |\n| brand_onsite_search_top_keywords_brand_paid_clicks_share | Monthly | Double | For each keyword, the percentage of paid clicks on the selected brand's products in the selected domain, category, and time frame. | site,brand,category_id,category_name | Shopper Top Keywords Brand | 1000 |\n| brand_onsite_search_top_keywords_total_clicks | Monthly | Integer | For each keyword, the number of unique clicks on products in the selected domain, category and time frame. If a consumer clicked on the same product twice in the same 30-min session it is counted as one click. | site,brand,category_id,category_name | Shopper Top Keywords Brand | 1000 |\n| brand_onsite_search_top_keywords_brand_share | Monthly | Float | For each keyword, percent of clicks on the selected brand’s products in the selected domain and time frame. | site,brand,category_id,category_name | Shopper Top Keywords Brand | 1000 |\n\nNote: all Shopper Intelligence metrics are reported on a monthly basis. For example, querying category_sales_performance_top_products_units_sold for January-March 2022 will produce 3 data points, one for each month (January, February, and March).\n\n# App Intelligence Metrics\n\nThe following metrics are available exclusively to customers with the 'App Intelligence' product in their subscription. Reach out to your Similarweb Account Manager to unlock this feature.\n\n| **Metric Name** | **Supported Granularity** | **Type** | **Description** | **Primary Key** |\n| --- | --- | --- | --- | --- |\n| apps_daily_active_users | Monthly, Daily | Double | Returns the number of devices that have used the app in the selected period of time. | app, country |\n| apps_unique_installs | Monthly, Daily | Double | Returns app unique installs from the store. | app, country |\n| apps_downloads | Monthly, Daily | Double | Returns the app downloads from the store. | app, country |\n| apps_sessions_per_user | Monthly, Daily | Double | Returns the average number of times each active user opened the app per day. | app, country |\n| apps_avg_usage_time_per_session | Monthly, Daily | Double | Returns the average time spent in an app per user per day. | app, country |\n| apps_avg_total_usage_time_per_user | Monthly, Daily | Double | Returns the average total time spent in an app per day. | app, country |\n\n# App Intelligence Premium Metrics\n\nThe following metrics are available exclusively to customers with the 'App Intelligence Premium' product in their subscription. Reach out to your Similarweb Account Manager to unlock this feature.\n\n| **Metric Name** | **Supported Granularity** | **Type** | **Description** | **Primary Key** |\n| --- | --- | --- | --- | --- |\n| apps_data_ai_affinity_ios | Monthly | array of double | Returns ratio between this app's usage within the user base of the app in query versus the general population. | primary_app,country, device_code, secondary_app (ios device_code: ios-phone, ios-tablet. android device_code: android-phone, android-tablet) |\n| apps_data_ai_affinity_android | Monthly | array of double | Returns ratio between this app's usage within the user base of the app in query versus the general population. | primary_app,country, device_code, secondary_app (ios device_code: ios-phone, ios-tablet. android device_code: android-phone, android-tablet) |\n| apps_data_ai_open_rate_ios | Monthly | array of double | Returns the percentage of the install base that opened the app during the selected time period. | app, country, device_code (ios device_code: ios-phone, ios-tablet. android device_code: android-phone, android-tablet) |\n| apps_data_ai_open_rate_android | Monthly | array of double | Returns the percentage of the install base that opened the app during the selected time period. | app, country, device_code (ios device_code: ios-phone, ios-tablet. android device_code: android-phone, android-tablet) |\n| apps_data_ai_monthly_active_users_ios | Monthly | array of double | Returns the average number of active users per month who have used the app in a given period. | app, country, device_code (ios device_code: ios-phone, ios-tablet. android device_code: android-phone, android-tablet) |\n| apps_data_ai_monthly_active_users_android | Monthly | array of double | Returns the average number of active users per month who have used the app in a given period. | app, country, device_code (ios device_code: ios-phone, ios-tablet. android device_code: android-phone, android-tablet) |\n| apps_data_ai_total_sessions_ios | Monthly | array of double | Returns the total number of times each active user opened the app in the selected period. | app, country, device_code (ios device_code: ios-phone, ios-tablet. android device_code: android-phone, android-tablet) |\n| apps_data_ai_total_sessions_android | Monthly | array of double | Returns the total number of times each active user opened the app in the selected period. | app, country, device_code (ios device_code: ios-phone, ios-tablet. android device_code: android-phone, android-tablet) |\n| apps_data_ai_total_time_ios | Monthly | array of double | Returns the total time that users spent in the app during the selected period. | app, country, device_code (ios device_code: ios-phone, ios-tablet. android device_code: android-phone, android-tablet) |\n| apps_data_ai_total_time_android | Monthly | array of double | Returns the total time that users spent in the app during the selected period. | app, country, device_code (ios device_code: ios-phone, ios-tablet. android device_code: android-phone, android-tablet) |\n| apps_data_ai_average_monthly_user_sessions_ios | Monthly | array of double | Returns the average number of times each active user opened the app per month. | app, country, device_code (ios device_code: ios-phone, ios-tablet. android device_code: android-phone, android-tablet) |\n| apps_data_ai_average_monthly_user_sessions_android | Monthly | array of double | Returns the average number of times each active user opened the app per month. | app, country, device_code (ios device_code: ios-phone, ios-tablet. android device_code: android-phone, android-tablet) |\n| apps_data_ai_average_monthly_user_time_spent_ios | Monthly | array of double | Returns the average time spent in an app per user, per month. | app, country, device_code (ios device_code: ios-phone, ios-tablet. android device_code: android-phone, android-tablet) |\n| apps_data_ai_average_monthly_user_time_spent_android | Monthly | array of double | Returns the average time spent in an app per user, per month. | app, country, device_code (ios device_code: ios-phone, ios-tablet. android device_code: android-phone, android-tablet) |\n| apps_data_ai_average_session_length_ios | Monthly | array of double | Returns the average time spent in an app per session, per month. | app, country, device_code (ios device_code: ios-phone, ios-tablet. android device_code: android-phone, android-tablet) |\n| apps_data_ai_average_session_length_android | Monthly | array of double | Returns the average time spent in an app per session, per month. | app, country, device_code (ios device_code: ios-phone, ios-tablet. android device_code: android-phone, android-tablet) |\n| apps_data_ai_retention_day_30_ios | Monthly | array of double | Returns the percentage of users who used the app 30 days after the first app opened. | app, country, device_code (ios device_code: ios-phone, ios-tablet. android device_code: android-phone, android-tablet) |\n| apps_data_ai_retention_day_30_android | Monthly | array of double | Returns the percentage of users who used the app 30 days after the first app opened. | app, country, device_code (ios device_code: ios-phone, ios-tablet. android device_code: android-phone, android-tablet) |\n| apps_data_ai_install_base_ios | Monthly | array of double | Returns the average number of devices with the analyzed app installed. | app, country, device_code (ios device_code: ios-phone, ios-tablet. android device_code: android-phone, android-tablet) |\n| apps_data_ai_install_base_android | Monthly | array of double | Returns the average number of devices with the analyzed app installed. | app, country, device_code (ios device_code: ios-phone, ios-tablet. android device_code: android-phone, android-tablet) |\n| apps_data_ai_monthly_downloads | Monthly | array of double | Returns the number of downloads per months for the analyzed app | app, country |\n| apps_daily_active_users | Monthly, Daily | array of double | Returns the daily active users for the analyzed app | app, country |\n| apps_downloads | Monthly, Daily | array of double | Returns the number of downloads per month for the analyzed app | app, country |\n| apps_sessions_per_user | Monthly, Daily | array of double | Returns the average number of times each active user opened the app in the selected period. | app, country |\n| apps_avg_usage_time_per_session | Monthly, Daily | array of double | Returns the total time that users spent in the analyzed app | app, country |\n| apps_avg_total_usage_time_per_user | Monthly, Daily | array of double | Returns the average time spent in an app per user | app, country |\n\n# Error Handling\n\n**Bad Request** - This error should be treated manually, some parameters of your req in the request you invoked.  \nfor example, an error message could look like - \"Request failed due to invalid start/end date. Invalid start_date. Historical data for monthly granularity is available as of - 2018-07. You have requested - 2017-01 please pick a later date.\"  \nSo to fix that error you have to change your requests start date to be later\n\n**Internal Error** - This error is an unexpected our that occurred in our servers if you encounter this error our recommendation is to embrace a retry policy, you can re-submit your request or use our 'retry' endpoint, to resubmit your request.\n\n**Unauthorized** - Your API key is invalid, make sure your Similarweb account is active. If you need further help with your API Key reach out to our support team.\n\n**Too Many Requests** - the limit is 10 requests per second, to avoid this error, do not exceed this limitation (limitation will be live soon).\n\n# Webhooks\n\nReceive event notifications as soon as the status of your report changes. To do this, enter the delivery URL you'd like us to ping when you request a report (for example, you can use the URL of a dedicated Slack channel). Status can be: \"processing\", \"complete\", or \"internal_error\". See an example response payload below.\n\n``` json\n{\n    \"event_type\": \"report_status_change\",\n    \"payload\": {\n       \"status\": \"completed\",\n       \"report_id\" : \"3f94dd67-94ec-4d2a-90b4-620ccfc45be7\"\n    }\n  }\n\n ```\n\nUse the [Check Webhook endpoint](https://documenter.getpostman.com/view/8688131/SWLe78Fo#7de95025-164b-4b93-b050-7b4aa204c575) to validate your webhook integration was sucessful.","schema":"https://schema.getpostman.com/json/collection/v2.0.0/collection.json","isPublicCollection":false,"owner":"8688131","collectionId":"36608be9-97b9-4b84-be68-0aa610750f90","publishedId":"SWLe78Fo","public":true,"publicUrl":"https://documenter-api.postman.tech/view/8688131/SWLe78Fo","privateUrl":"https://go.postman.co/documentation/8688131-36608be9-97b9-4b84-be68-0aa610750f90","customColor":{"top-bar":"FFFFFF","right-sidebar":"303030","highlight":"195AFE"},"documentationLayout":"classic-double-column","customisation":null,"version":"8.10.1","publishDate":"2022-06-21T08:09:23.000Z","activeVersionTag":"latest","documentationTheme":"light","metaTags":{},"logos":{}},"statusCode":200},"environments":[],"user":{"authenticated":false,"permissions":{"publish":false}},"run":{"button":{"js":"https://run.pstmn.io/button.js","css":"https://run.pstmn.io/button.css"}},"web":"https://www.getpostman.com/","team":{"logo":"https://res.cloudinary.com/postman/image/upload/t_team_logo_pubdoc/v1/team/768118b36f06c94b0306958b980558e6915839447e859fe16906e29d683976f0","favicon":""},"isEnvFetchError":false,"languages":"[{\"key\":\"csharp\",\"label\":\"C#\",\"variant\":\"HttpClient\"},{\"key\":\"csharp\",\"label\":\"C#\",\"variant\":\"RestSharp\"},{\"key\":\"curl\",\"label\":\"cURL\",\"variant\":\"cURL\"},{\"key\":\"dart\",\"label\":\"Dart\",\"variant\":\"http\"},{\"key\":\"go\",\"label\":\"Go\",\"variant\":\"Native\"},{\"key\":\"http\",\"label\":\"HTTP\",\"variant\":\"HTTP\"},{\"key\":\"java\",\"label\":\"Java\",\"variant\":\"OkHttp\"},{\"key\":\"java\",\"label\":\"Java\",\"variant\":\"Unirest\"},{\"key\":\"javascript\",\"label\":\"JavaScript\",\"variant\":\"Fetch\"},{\"key\":\"javascript\",\"label\":\"JavaScript\",\"variant\":\"jQuery\"},{\"key\":\"javascript\",\"label\":\"JavaScript\",\"variant\":\"XHR\"},{\"key\":\"c\",\"label\":\"C\",\"variant\":\"libcurl\"},{\"key\":\"nodejs\",\"label\":\"NodeJs\",\"variant\":\"Axios\"},{\"key\":\"nodejs\",\"label\":\"NodeJs\",\"variant\":\"Native\"},{\"key\":\"nodejs\",\"label\":\"NodeJs\",\"variant\":\"Request\"},{\"key\":\"nodejs\",\"label\":\"NodeJs\",\"variant\":\"Unirest\"},{\"key\":\"objective-c\",\"label\":\"Objective-C\",\"variant\":\"NSURLSession\"},{\"key\":\"ocaml\",\"label\":\"OCaml\",\"variant\":\"Cohttp\"},{\"key\":\"php\",\"label\":\"PHP\",\"variant\":\"cURL\"},{\"key\":\"php\",\"label\":\"PHP\",\"variant\":\"Guzzle\"},{\"key\":\"php\",\"label\":\"PHP\",\"variant\":\"HTTP_Request2\"},{\"key\":\"php\",\"label\":\"PHP\",\"variant\":\"pecl_http\"},{\"key\":\"powershell\",\"label\":\"PowerShell\",\"variant\":\"RestMethod\"},{\"key\":\"python\",\"label\":\"Python\",\"variant\":\"http.client\"},{\"key\":\"python\",\"label\":\"Python\",\"variant\":\"Requests\"},{\"key\":\"r\",\"label\":\"R\",\"variant\":\"httr\"},{\"key\":\"r\",\"label\":\"R\",\"variant\":\"RCurl\"},{\"key\":\"ruby\",\"label\":\"Ruby\",\"variant\":\"Net::HTTP\"},{\"key\":\"shell\",\"label\":\"Shell\",\"variant\":\"Httpie\"},{\"key\":\"shell\",\"label\":\"Shell\",\"variant\":\"wget\"},{\"key\":\"swift\",\"label\":\"Swift\",\"variant\":\"URLSession\"}]","languageSettings":[{"key":"csharp","label":"C#","variant":"HttpClient"},{"key":"csharp","label":"C#","variant":"RestSharp"},{"key":"curl","label":"cURL","variant":"cURL"},{"key":"dart","label":"Dart","variant":"http"},{"key":"go","label":"Go","variant":"Native"},{"key":"http","label":"HTTP","variant":"HTTP"},{"key":"java","label":"Java","variant":"OkHttp"},{"key":"java","label":"Java","variant":"Unirest"},{"key":"javascript","label":"JavaScript","variant":"Fetch"},{"key":"javascript","label":"JavaScript","variant":"jQuery"},{"key":"javascript","label":"JavaScript","variant":"XHR"},{"key":"c","label":"C","variant":"libcurl"},{"key":"nodejs","label":"NodeJs","variant":"Axios"},{"key":"nodejs","label":"NodeJs","variant":"Native"},{"key":"nodejs","label":"NodeJs","variant":"Request"},{"key":"nodejs","label":"NodeJs","variant":"Unirest"},{"key":"objective-c","label":"Objective-C","variant":"NSURLSession"},{"key":"ocaml","label":"OCaml","variant":"Cohttp"},{"key":"php","label":"PHP","variant":"cURL"},{"key":"php","label":"PHP","variant":"Guzzle"},{"key":"php","label":"PHP","variant":"HTTP_Request2"},{"key":"php","label":"PHP","variant":"pecl_http"},{"key":"powershell","label":"PowerShell","variant":"RestMethod"},{"key":"python","label":"Python","variant":"http.client"},{"key":"python","label":"Python","variant":"Requests"},{"key":"r","label":"R","variant":"httr"},{"key":"r","label":"R","variant":"RCurl"},{"key":"ruby","label":"Ruby","variant":"Net::HTTP"},{"key":"shell","label":"Shell","variant":"Httpie"},{"key":"shell","label":"Shell","variant":"wget"},{"key":"swift","label":"Swift","variant":"URLSession"}],"languageOptions":[{"label":"C# - HttpClient","value":"csharp - HttpClient - C#"},{"label":"C# - RestSharp","value":"csharp - RestSharp - C#"},{"label":"cURL - cURL","value":"curl - cURL - cURL"},{"label":"Dart - http","value":"dart - http - Dart"},{"label":"Go - Native","value":"go - Native - Go"},{"label":"HTTP - HTTP","value":"http - HTTP - HTTP"},{"label":"Java - OkHttp","value":"java - OkHttp - Java"},{"label":"Java - Unirest","value":"java - Unirest - Java"},{"label":"JavaScript - Fetch","value":"javascript - Fetch - JavaScript"},{"label":"JavaScript - jQuery","value":"javascript - jQuery - JavaScript"},{"label":"JavaScript - XHR","value":"javascript - XHR - JavaScript"},{"label":"C - libcurl","value":"c - libcurl - C"},{"label":"NodeJs - Axios","value":"nodejs - Axios - NodeJs"},{"label":"NodeJs - Native","value":"nodejs - Native - NodeJs"},{"label":"NodeJs - Request","value":"nodejs - Request - NodeJs"},{"label":"NodeJs - Unirest","value":"nodejs - Unirest - NodeJs"},{"label":"Objective-C - NSURLSession","value":"objective-c - NSURLSession - Objective-C"},{"label":"OCaml - Cohttp","value":"ocaml - Cohttp - OCaml"},{"label":"PHP - cURL","value":"php - cURL - PHP"},{"label":"PHP - Guzzle","value":"php - Guzzle - PHP"},{"label":"PHP - HTTP_Request2","value":"php - HTTP_Request2 - PHP"},{"label":"PHP - pecl_http","value":"php - pecl_http - PHP"},{"label":"PowerShell - RestMethod","value":"powershell - RestMethod - PowerShell"},{"label":"Python - http.client","value":"python - http.client - Python"},{"label":"Python - Requests","value":"python - Requests - Python"},{"label":"R - httr","value":"r - httr - R"},{"label":"R - RCurl","value":"r - RCurl - R"},{"label":"Ruby - Net::HTTP","value":"ruby - Net::HTTP - Ruby"},{"label":"Shell - Httpie","value":"shell - Httpie - Shell"},{"label":"Shell - wget","value":"shell - wget - Shell"},{"label":"Swift - URLSession","value":"swift - URLSession - Swift"}],"layoutOptions":[{"value":"classic-single-column","label":"Single Column"},{"value":"classic-double-column","label":"Double Column"}],"versionOptions":[],"environmentOptions":[{"value":"0","label":"No Environment"}],"canonicalUrl":"https://documenter.gw.postman.com/view/metadata/SWLe78Fo"}