post https://api.similarweb.com/v3/batch/shopper/request-report
This dataset helps companies monitor consumer demand, analyze shopper behavior, and optimize search strategies to win in the Ecommerce world.
In order to set up the shopper intelligence API, please follow the instructions here, more information on Shopper intelligence can be found here.
The Ecommerce/Shopper datasets include:
- Brands and categories
- Top brands in category
- Top products in category
- Top keywords in category
- Top products in brands
- Top keywords in brands
When generating a report, make sure all metrics are supported by same granularity as the requested report.
Example JSON
{
"domains":[
"amazon.com"
],
"category_ids": [2335752011],
"metrics":[
"category_sales_performance_product_views",
"category_sales_performance_units_sold",
"category_sales_performance_revenue",
"category_sales_performance_cvr"
],
"start_date": "2022-09",
"end_date": "2022-11",
"granularity": "monthly",
"response_format": "csv"
}
{
"domains":[
"amazon.com"
],
"brands": ["Fisher-Price","Baby Einstein"],
"metrics":[
"brand_sales_performance_product_views",
"brand_sales_performance_units_sold",
"brand_sales_performance_revenue",
"brand_sales_performance_cvr",
"brand_sales_performance_revenue_1P",
"brand_sales_performance_revenue_3P",
"brand_sales_performance_units_sold_1P",
"brand_sales_performance_units_sold_3P"
],
"start_date": "2022-09",
"end_date": "2022-11",
"granularity": "monthly",
"response_format": "csv"
}
{
"domains":[
"amazon.com"
],
"brands": ["Fisher-Price","Baby Einstein"],
"metrics":[
"brand_sales_performance_top_products_units_sold",
"brand_sales_performance_top_products_revenue",
"brand_sales_performance_top_products_product_views",
"brand_sales_performance_top_products_average_unit_price",
"brand_sales_performance_top_products_reviews",
"brand_sales_performance_top_products_rating"
],
"start_date": "2022-09",
"end_date": "2022-11",
"granularity": "monthly",
"response_format": "csv"
}
{
"domains":[
"amazon.com"
],
"category_ids": [2335752011],
"metrics":[
"category_onsite_search_top_keywords_total_clicks",
"category_onsite_search_top_keywords_organic_clicks_share",
"category_onsite_search_top_keywords_paid_clicks_share",
"category_onsite_search_top_keywords_top_brand",
"category_onsite_search_top_keywords_top_brand_share"
],
"start_date": "2022-09",
"end_date": "2022-11",
"granularity": "monthly",
"response_format": "csv"
}
Categories and Brands
Table URL: https://api.similarweb.com/v3/batch/shopper/request-report
Primary keys:domain, category_id
| Metric Name | Description | Supported Granularity | Type |
|---|---|---|---|
| category_sales_performance_product_views, brand_sales_performance_product_views | The number of unique product views for the selected domain and category/brand. | Monthly | Integer |
| category_sales_performance_revenue, brand_sales_performance_revenue | The amount of revenue generated by the selected domain and category/brand | Monthly | Integer |
| category_sales_performance_units_sold, brand_sales_performance_units_sold | The number of units sold in the selected domain and category/brand | Monthly | Integer |
| category_sales_performance_cvr, brand_sales_performance_cvr | Conversion rate is calculated by dividing unique purchases by product views in the selected domain and category/brand | Monthly | Double |
| category_sales_performance_revenue_1P, brand_sales_performance_revenue_1P | The amount of revenue generated in the selected domain and category/brand by first-party sales | Monthly | Double |
| category_sales_performance_units_sold_1P, brand_sales_performance_units_sold_1P | The number of units sold by the selected brand in the selected domain and category/brand by first-party sales. | Monthly | Double |
| category_sales_performance_revenue_3P, brand_sales_performance_revenue_3P | The amount of revenue generated in the selected domain and category/brand by third-party sales. | Monthly | Double |
| category_sales_performance_units_sold_3P, brand_sales_performance_units_sold_3P | The number of units sold by the selected brand in the selected domain and category/brand by third-party sales. | Monthly | Double |
Top brands in category
Table URL: https://api.similarweb.com/v3/batch/shopper_brand_category/request-report
Primary keys:domain, category_id
| Metric Name | Description | Supported Granularity | Type |
|---|---|---|---|
| category_sales_performance_top_brands_product_views | The number of unique product views for the top brands in the selected domain and category. Query results include up to 80 brands. | Monthly | Integer |
| category_sales_performance_top_brands_revenue | The amount of revenue generated by the top brands in the selected domain and category. Query results include up to 80 brands. | Monthly | Integer |
| category_sales_performance_top_brands_units_sold | The number of units sold for the top brands in the selected domain and category. Query results include up to 80 brands. | Monthly | Integer |
| category_sales_performance_top_brands_cvr | Conversion rate is calculated by dividing unique purchases by product views in the selected domain and category. | Monthly | Double |
Top Products in Category
Table URL: https://api.similarweb.com/v3/batch/shopper_products_category/request-report
Primary keys: domain, category_id
| Metric Name | Description | Supported Granularity | Type |
|---|---|---|---|
| category_sales_performance_top_products_product_views | The number of unique views for the top products in the selected domain and category. Query results include up to 1,000 products. | Monthly | Integer |
| category_sales_performance_top_products_revenue | The amount of revenue generated by the top products in the selected domain and category. Query results include up to 1,000 products. | Monthly | Integer |
| category_sales_performance_top_products_units_sold | The number of units sold for the top products in the selected domain and category. Query results include up to 1,000 products. | Monthly | Integer |
| category_sales_performance_top_products_average_unit_price | The average unit price of top products in selected domain, and category. Query results include up to 1,000 products. | Monthly | Double |
| category_sales_performance_top_products_reviews | The number of reviews for the top products in the selected domain and category. Query results include up to 1,000 products. | Monthly | Integer |
| category_sales_performance_top_products_rating | The rating of the top products in the selected domain and category. Query results include up to 1,000 products. | Monthly | Double |
Top keywords in category
Table URL: https://api.similarweb.com/v3/batch/shopper_keywords_category/request-report
Primary keys:domain, brands
| Metric Name | Description | Supported Granularity | Type |
|---|---|---|---|
| category_onsite_search_top_keywords_total_clicks | 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. | Monthly | Integer |
| category_onsite_search_top_keywords_organic_clicks_share | For each keyword, the percentage of organic clicks in the selected domain, category and time frame. | Monthly | Double |
| category_onsite_search_top_keywords_paid_clicks_share | For each keyword, the percentage of paid clicks in the selected domain, category and time frame. | Monthly | Double |
| category_onsite_search_top_keywords_top_brand | For each keyword, the brand which received the most clicks in the selected category, domain and time frame. | Monthly | Integer |
| category_onsite_search_top_keywords_top_brand_share | For each keyword, percent of clicks the top brand received in the selected category and time frame. | Monthly | Double |
Top products in brands
Table URL: https://api.similarweb.com/v3/batch/shopper_products_brand/request-report
Primary keys:domain, brands
| Metric Name | Description | Supported Granularity | Type |
|---|---|---|---|
| brand_sales_performance_top_products_product_views | The number of unique views for the top products by the selected brand in the selected domain and category. | Monthly | Integer |
| brand_sales_performance_top_products_revenue | The amount of revenue generated by the top products by the selected brand in the selected domain and category. | Monthly | Intege |
| brand_sales_performance_top_products_units_sold | The number of units sold for the top products by the selected brand in the selected domain and category. | Monthly | Integer |
| brand_sales_performance_top_products_average_unit_price | The average unit price of top products by the selected brand in the selected domain and category. | Monthly | Double |
| brand_sales_performance_top_products_reviews | The number of reviews for the top products by the selected brand in the selected domain and category. | Monthly | Integer |
| brand_sales_performance_top_products_rating | The rating of the top products by the selected brand in the selected domain and category. | Monthly | Double |
Shopper Top Keywords Brand
Table URL: https://api.similarweb.com/v3/batch/shopper_keywords_brand/request-report
Primary keys:domain, category_id, brands
| Metric Name | Description | Supported Granularity | Type |
|---|---|---|---|
| brand_onsite_search_top_keywords_total_clicks | 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. | Monthly | Integer |
| brand_onsite_search_top_keywords_brand_clicks | 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. | Monthly | Integer |
| brand_onsite_search_top_keywords_brand_share | For each keyword, percent of clicks on the selected brand’s products in the selected domain and time frame. | Monthly | Float |
| brand_onsite_search_top_keywords_brand_organic_clicks_share | For each keyword, the percentage of organic clicks on the selected brand's products in the selected domain, category and time frame. | Monthly | Double |
| brand_onsite_search_top_keywords_brand_paid_clicks_share | For each keyword, the percentage of paid clicks on the selected brand's products in the selected domain, category, and time frame. | Monthly | Double |
The download link will remain valid for 30 days. We recommend saving these for a certain time period just in case you will need our assistance to troubleshoot any issue that may occur.