 |
VOOZH | about |
|
VOOZH | about |
Theme switcher
The Batch API Websites Dataset provides comprehensive web analytics across desktop and mobile platforms, enabling you to analyze website performance, user engagement, traffic sources, and competitive positioning. Access detailed metrics on visits, page views, bounce rates, marketing channels, and audience behavior.
Historical Data Availability: Access up to 61 months of historical data, depending on your subscription plan.
Starting May 31, 2026: Data upgrades are rolling out for the Traffic & Engagement and Marketing Channels vtables. Make sure to follow the action items below. For full details, visit our knowledge center guide.
How to enter domain names? Domain names should be entered without protocol (e.g. example.com not https://example.com).
Include your Batch API key in the request headers:
curl --location 'https://api.similarweb.com/batch/v5/request-report' \
--header 'api-key: {{API_KEY}}' \
--header 'Content-Type: application/json' \
--request POST \
--data body
Use this URL: https://api.similarweb.com/batch/v5/request-report to make a report request.
vtable name: traffic_and_engagement
Primary use case: Core website performance metrics, user engagement, and traffic analysis.
Primary keys: domains, countries
Starting May 31, 2026, you must update your request parameters to continue accessing these metrics during the transition period. For more details and migration steps, please refer to the Knowledge Center guidance.
Starting November 30, 2026 parts of this vtable will be fully deprecated.
all_traffic_visits | Total estimated visits across all devices. | Monthly, Weekly, Daily |
all_traffic_unique_visitors | Total unique visitors across all devices. | Monthly, Daily |
all_page_views | Total page views across all devices. | Monthly, Daily |
all_traffic_pages_per_visit | Average pages viewed per visit. | Monthly, Weekly, Daily |
all_traffic_average_visit_duration | Average session duration in seconds. | Monthly, Weekly, Daily |
all_traffic_bounce_rate | Percentage of single-page sessions. | Monthly, Weekly, Daily |
desktop_visits / desktop_unique_visitors / desktop_page_views | Desktop-only volume metrics. | Monthly, Weekly, Daily |
desktop_pages_per_visit / desktop_average_visit_duration / desktop_bounce_rate / desktop_share | Desktop engagement and share metrics. | Monthly, Weekly, Daily |
desktop_ppc_spend_usd | Estimated desktop PPC spend in USD. | Monthly |
mobile_visits / mobile_unique_visitors / mobile_page_views | Mobile-only volume metrics. | Monthly, Weekly, Daily |
mobile_pages_per_visit / mobile_average_visit_duration / mobile_bounce_rate / mobile_share | Mobile engagement and share metrics. | Monthly, Weekly, Daily |
mobile_ppc_spend_usd | Estimated mobile PPC spend in USD. | Monthly |
deduplicated_audience | Unique audience across devices. | Monthly |
total_new_visitors / total_returning_visitors | New and returning visitor counts. | Monthly |
category / global_rank / country_rank / category_rank_new | Category and ranking attributes. | Monthly |
{
"delivery_information": {
"response_format": "csv",
"delivery_method_params": {"retention_days": 60}
},
"report_query": {
"tables": [
{
"vtable": "traffic_and_engagement",
"granularity": "monthly",
"filters": {"countries": ["WW"], "include_subdomains": true},
"metrics": [
"all_page_views", "all_traffic_average_visit_duration",
"all_traffic_bounce_rate", "all_traffic_pages_per_visit",
"all_traffic_unique_visitors", "all_traffic_visits",
"category", "category_rank_new", "country_rank",
"deduplicated_audience", "global_rank",
"total_new_visitors", "total_returning_visitors"
],
"start_date": "2025-07",
"end_date": "2025-07"
}
]
}
}
vtable name: marketing_channels
Primary use case: Traffic source analysis and marketing channel attribution.
Primary keys: domains, countries, channels
Available channels: organic_search, direct, paid_search, referrals, display_ads, social, mail, search
Starting May 31, 2026, you must update your request parameters to continue using this vtable during the transition period. For more details and migration steps, please refer to the Knowledge Center guidance. You can use the website_marketing_channels vtable to retrieve the new data version.
Starting November 30, this vtable will be fully deprecated.
desktop_marketing_channels_visits | Desktop visits by traffic source. | Monthly, Daily |
mobile_marketing_channels_visits | Mobile visits by traffic source. | Monthly |
desktop_marketing_channels_share | Desktop traffic share by source. | Monthly, Daily |
mobile_marketing_channels_share | Mobile traffic share by source. | Monthly |
{
"delivery_information": {"response_format": "csv", "delivery_method_params": {"retention_days": 60}},
"report_query": {
"tables": [{
"vtable": "marketing_channels",
"granularity": "monthly",
"filters": {"countries": ["US"], "channels": ["organic_search","direct","paid_search","social"]},
"metrics": ["desktop_marketing_channels_visits","desktop_marketing_channels_share","mobile_marketing_channels_visits","mobile_marketing_channels_share"],
"start_date": "2025-06","end_date": "2025-07"
}]
}
}
This vtable will be available starting May 31, 2026.
vtable name: website_marketing_channels
Primary use case: Traffic source analysis and marketing channel attribution.
Primary keys: domains, countries
Available channels: organic_search, paid_search, referrals, display_ads, direct,organic_social, paid_social, mail, affiliates, gen_ai
{
"delivery_information": {"response_format": "csv", "delivery_method_params": {"retention_days": 60}},
"report_query": {
"tables": [{
"vtable": "website_marketing_channels",
"granularity": "monthly",
"filters": {"countries": ["US"], "channels": ["gen_ai", "organic_search","direct","paid_search","organic_social"]},
"metrics": ["marketing_channels_desktop_share","marketing_channels_desktop_visits","marketing_channels_mobile_share","marketing_channels_mobile_visits"],
"start_date": "2026-04","end_date": "2026-05"
}]
}
}
marketing_channels_desktop_share | Offers insights into the distribution of desktop traffic across various marketing channels, expressed as a share of total traffic. | Daily, Monthly | Dobule |
marketing_channels_desktop_visits | Provides an overview of the different sources driving desktop traffic to a site, categorizing visits based on marketing channels. | Daily, Monthly | Dobule |
marketing_channels_mobile_share | Offers insights into the distribution of mobile traffic across various marketing channels, expressed as a share of total traffic. | Daily, Monthly | Dobule |
marketing_channels_mobile_visits | Provides an overview of the different sources driving mobile traffic to a site, categorizing visits based on marketing channels. | Daily, Monthly | Dobule |
marketing_channels_total_share | Aggregates desktop and mobile data to reveal the overall distribution of traffic across all marketing channels, illustrating each channel's contribution to total traffic share. | Daily, Monthly | Dobule |
marketing_channels_total_visits | Presents the combined number of visits from both desktop and mobile devices, categorized by marketing channel. Offers a unified view of channel performance across all devices. | Daily, Monthly | Dobule |
vtable name: traffic_sources
Primary use case: Detailed referral analysis and specific traffic source identification.
Primary keys: domains, countries
Metric: desktop_traffic_source_share — Specific sources driving desktop traffic (e.g., Google, Facebook, YouTube). Granularity: Monthly.
{
"delivery_information": {
"response_format": "csv",
"delivery_method_params": {
"retention_days": 60
}
},
"report_query": {
"tables": [
{
"vtable": "traffic_sources",
"granularity": "monthly",
"filters": {
"countries": ["WW"]
},
"metrics": [
"desktop_traffic_source_share"
],
"start_date": "2025-07",
"end_date": "2025-07"
}
]
}
}
vtable name:similar_sites
Primary use case: Competitive analysis and website similarity measurement.
Primary keys: domain1, domain2
Metric: site_affinity — Similarity score between two websites. Granularity: Monthly.
{
"delivery_information": {
"response_format": "csv",
"delivery_method_params": {
"retention_days": 60
}
},
"report_query": {
"tables": [
{
"vtable": "similar_sites",
"granularity": "monthly",
"filters": {
"domain1": ["example.com"],
"domain2": ["competitor.com"]
},
"metrics": [
"site_affinity"
],
"start_date": "2025-07",
"end_date": "2025-07"
}
]
}
}
vtable name:desktop_top_geo
Primary use case: Geographic traffic distribution analysis.
Primary keys: domains
Metric: desktop_top_geo — Desktop traffic share by top 10 countries (minimum 1 month period). Granularity: Monthly.
{
"delivery_information": {
"response_format": "csv",
"delivery_method_params": {
"retention_days": 60
}
},
"report_query": {
"tables": [
{
"vtable": "desktop_top_geo",
"granularity": "monthly",
"filters": {},
"metrics": [
"desktop_top_geo"
],
"start_date": "2025-07",
"end_date": "2025-07"
}
]
}
}
vtable name:website_search_keywords
Primary use case: Click metrics from search results for specific keywords leading to website visits.
Primary keys: domains, keywords, countries
organic_desktop_site_clicks | Clicks generated from organic search results on desktop. | Daily, Weekly, Monthly |
organic_mobile_site_clicks | Clicks generated from organic search results on mobile. | Daily, Weekly, Monthly |
paid_desktop_site_clicks | Clicks generated from paid search results on desktop. | Daily, Weekly, Monthly |
paid_mobile_site_clicks | Clicks generated from paid search results on mobile. | Daily, Weekly, Monthly |
{
"delivery_information": {
"response_format": "csv",
"delivery_method_params": {
"retention_days": 60
}
},
"report_query": {
"tables": [
{
"vtable": "website_search_keywords",
"granularity": "monthly",
"filters": {
"countries": ["WW"],
"include_subdomains": true
},
"metrics": [
"organic_desktop_site_clicks",
"organic_mobile_site_clicks",
"paid_desktop_site_clicks",
"paid_mobile_site_clicks"
],
"start_date": "2025-07",
"end_date": "2025-07"
}
]
}
}'
vtable name: (referrals)
Primary use case: Referral traffic metrics showing visits from referring websites to target domains, both incoming and outgoing.
Primary keys: domains
desktop_referral_visits desktop_referral_share desktop_referral_change | Desktop incoming referral metrics. | Monthly |
desktop_outgoing_referral_visits desktop_outgoing_referral_share desktop_outgoing_referral_change | Desktop outgoing referral metrics. | Monthly |
mobile_referral_visits mobile_referral_share mobile_referral_change | Mobile incoming referral metrics. | Monthly |
{
"delivery_information": {
"response_format": "csv",
"delivery_method_params": {
"retention_days": 60
}
},
"report_query": {
"tables": [
{
"vtable": "referrals",
"granularity": "monthly",
"filters": {
"countries": ["WW"],
"include_subdomains": true
},
"metrics": [
"desktop_outgoing_referral_change",
"desktop_outgoing_referral_share",
"desktop_outgoing_referral_visits",
"desktop_referral_change",
"desktop_referral_share",
"desktop_referral_visits",
"mobile_referral_change",
"mobile_referral_share",
"mobile_referral_visits"
],
"start_date": "2025-07",
"end_date": "2025-07"
}
]
}
}'
This vtable will be available starting July 1st.
vtable name: (genai_referrals)
Primary use case: Referral traffic metrics showing visits from referring GenAI websites to target domains, both incoming and outgoing.
Primary keys: domains
desktop_genai_referral_visits desktop_genai_referral_share desktop_genai_referral_change | Desktop incoming GenAI referral metrics. | Monthly |
desktop_outgoing_genai_referral_visits desktop_outgoing_genai_referral_share desktop_outgoing_genai_referral_change | Desktop outgoing GenAI referral metrics. | Monthly |
mobile_genai_referral_visits mobile_genai_referral_share mobile_genai_referral_change | Mobile incoming GenAI referral metrics. | Monthly |
mobile_outoging_genai_referral_visits mobile_outgoing_genai_referral_share mobile_outgoing_genai_referral_change | Mobile outgoing GenAI referral metrics. | Monthly |
vtable name:website
Primary use case: Website metadata and revenue estimation.
Primary keys: domains
{
"delivery_information": {
"response_format": "csv",
"delivery_method_params": {
"retention_days": 60
}
},
"report_query": {
"tables": [
{
"vtable": "website",
"granularity": "monthly",
"filters": {
"include_subdomains": true
},
"metrics": [
"ecommerce_type",
"first_level_domain",
"main_category",
"online_revenue",
"sub_category"
],
"start_date": "2025-07",
"end_date": "2025-07"
}
]
}
}'
ecommerce_type | Type of e-commerce functionality (marketplace, direct seller, non-ecommerce). | Monthly |
first_level_domain | The first-level domain of the website. | Monthly |
main_category / sub_category | Primary and secondary industry categories. | Monthly |
online_revenue | Estimated monthly e-commerce revenue. | Monthly |
