Guides
Go to SimilarwebContact us

Websites Dataset

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.

Suggest Edits

📊

Historical Data Availability

Access up to 61 months of historical data, depending on your subscription plan.

What You Can Track

  • Traffic & Engagement: Visits, page views, bounce rates, session duration, and user behavior metrics
  • Marketing Channels & Traffic Sources: Traffic source analysis across organic search, paid search, direct, social, and more
  • Geographic Distribution: Country-level traffic breakdown and regional performance
  • Similar Sites: Competitive analysis and market positioning
  • Referrals: Referral traffic metrics showing visits from referring websites to target domains, including both incoming and outgoing referral data.
  • Popular Pages: Percentage of total website traffic that each page receives.
  • Website description: Estimated e-commerce revenue and site meta description analysis

📘

API Key Requirements

Batch API and REST API use different authentication keys. Ensure you're using your Batch API key for these requests.

🔍

How to enter domain names?

Domain names should be entered without protocol (e.g., example.com not https://example.com)

Getting Started

1. Authentication

Include your Batch API key in the request headers:

curl --location 'https://api.similarweb.com/batch/v4/request-report' \
--header 'api-key: {{API_KEY}}' \
--header 'Content-Type: application/json' \
--request POST \
--data body

2. Request Structure

All Websites Dataset requests follow this structure:

🦉
Batch API Request - Step-by-Step Walkthrough
Open Recipe

Available Tables (vtables)

Traffic & Engagement (traffic_and_engagement)

Primary use case: Core website performance metrics, user engagement, and traffic analysis

Primary Keys: domains, countries

Available Metrics:

Metric NameDescriptionGranularity
all_traffic_visitsTotal estimated visits across all devicesMonthly, Weekly, Daily
all_traffic_unique_visitorsTotal unique visitors across all devicesMonthly, Weekly, Daily
all_page_viewsTotal page views across all devicesMonthly, Weekly, Daily
all_traffic_pages_per_visitAverage pages viewed per visitMonthly, Weekly, Daily
all_traffic_average_visit_durationAverage session duration in secondsMonthly, Weekly, Daily
all_traffic_bounce_ratePercentage of single-page sessionsMonthly, Weekly, Daily
desktop_visitsDesktop-only visit countMonthly, Weekly, Daily
desktop_unique_visitorsDesktop-only unique visitorsMonthly, Weekly, Daily
desktop_page_viewsDesktop-only page viewsMonthly, Weekly, Daily
desktop_pages_per_visitDesktop average pages per visitMonthly, Weekly, Daily
desktop_average_visit_durationDesktop average session duration in secondsMonthly, Weekly, Daily
desktop_bounce_rateDesktop bounce rate percentageMonthly, Weekly, Daily
desktop_shareDesktop traffic share percentageMonthly, Weekly, Daily
desktop_ppc_spend_usdEstimated desktop PPC spend in USDMonthly, Weekly, Daily
mobile_visitsMobile-only visit countMonthly, Weekly, Daily
mobile_unique_visitorsMobile-only unique visitorsMonthly, Weekly, Daily
mobile_page_viewsMobile-only page viewsMonthly, Weekly, Daily
mobile_pages_per_visitMobile average pages per visitMonthly, Weekly, Daily
mobile_average_visit_durationMobile average session duration in secondsMonthly, Weekly, Daily
mobile_bounce_rateMobile bounce rate percentageMonthly, Weekly, Daily
mobile_shareMobile traffic share percentageMonthly, Weekly, Daily
mobile_ppc_spend_usdEstimated mobile PPC spend in USDMonthly, Weekly, Daily
deduplicated_audienceUnique audience across devicesMonthly, Weekly, Daily
total_new_visitorsNew visitors countMonthly, Weekly, Daily
total_returning_visitorsReturning visitors countMonthly, Weekly, Daily
categoryWebsite industry categoryMonthly, Weekly, Daily
global_rankGlobal website rankingMonthly, Weekly, Daily
country_rankRanking within specific countryMonthly, Weekly, Daily
category_rank_newRanking within industry categoryMonthly, Weekly, Daily

Example Request:

{
  "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",
          "desktop_average_visit_duration",
          "desktop_bounce_rate",
          "desktop_page_views",
          "desktop_pages_per_visit",
          "desktop_ppc_spend_usd",
          "desktop_share",
          "desktop_unique_visitors",
          "desktop_visits",
          "global_rank",
          "mobile_average_visit_duration",
          "mobile_bounce_rate",
          "mobile_page_views",
          "mobile_pages_per_visit",
          "mobile_ppc_spend_usd",
          "mobile_share",
          "mobile_unique_visitors",
          "mobile_visits",
          "total_new_visitors",
          "total_returning_visitors"
        ],
        "start_date": "2025-07",
        "end_date": "2025-07"
      }
    ]
  }
}

Marketing Channels (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

Available Metrics:

Metric NameDescriptionGranularity
desktop_marketing_channels_visitsDesktop visits by traffic sourceMonthly, Daily
mobile_marketing_channels_visitsMobile visits by traffic sourceMonthly
desktop_marketing_channels_shareDesktop traffic share by sourceMonthly, Daily
mobile_marketing_channels_shareMobile traffic share by sourceMonthly

Example Request:

{
  "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"
      }
    ]
  }
}

Traffic Sources (traffic_sources)

Primary use case: Detailed referral analysis and specific traffic source identification

Primary Keys: domains, countries

Available Metrics:

Metric NameDescriptionGranularity
desktop_traffic_source_shareSpecific sources driving desktop traffic (e.g., Google, Facebook, YouTube)Monthly

Example Request:

{
  "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"
      }
    ]
  }
}

Similar Sites (similar_sites)

Primary use case: Competitive analysis and website similarity measurement

Primary Keys: domain1, domain2

Available Metrics:

Metric NameDescriptionGranularity
site_affinitySimilarity score between two websitesMonthly

Example Request:

{
  "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"
      }
    ]
  }
}

Desktop Top Geography (desktop_top_geo)

Primary use case: Geographic traffic distribution analysis

Primary Keys: domains

Available Metrics:

Metric NameDescriptionGranularity
desktop_top_geoDesktop traffic share by top 10 countries (minimum 1 month period)Monthly

Example Request:

{
  "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"
      }
    ]
  }
}

Website Search / Keywords Table (website_search_keywords)

Primary use case: Click metrics from search results for specific keywords leading to website visits.

Primary Keys: domains, keywords, countries

Available Metrics:

Metric NameDescriptionGranularity
organic_desktop_site_clicksNumber of clicks generated from organic search results on desktop devicesDaily, weekly, monthly
organic_mobile_site_clicksNumber of clicks generated from organic search results on mobile devicesDaily, weekly, monthly
paid_desktop_site_clicksNumber of clicks generated from paid search results on desktop devicesDaily, weekly, monthly
paid_mobile_site_clicksNumber of clicks generated from paid search results on mobile devicesDaily, weekly, monthly

Example Request

curl --location 'https://api.similarweb.com/batch/v4/request-report' \
--header 'api-key: {{API_KEY}}' \
--header 'Content-Type: application/json' \
--data '{
  "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"
      }
    ]
  }
}'

Referrals (referrals)

Primary use case: This table provides referral traffic metrics showing visits from referring websites to target domains, including both incoming and outgoing referral data.

Primary Keys: domains

Available Metrics:

Metric NameDescriptionGranularity
desktop_referral_visitsNumber of desktop visits from referring sites to the analyzed domainMonthly
desktop_referral_sharePercentage share of desktop referral traffic from each referring domainMonthly
desktop_referral_changeMonth-over-month change in desktop referral visitsMonthly
desktop_outgoing_referral_visitsNumber of desktop visits from the analyzed domain to other sitesMonthly
desktop_outgoing_referral_sharePercentage share of desktop outgoing referral traffic to each destinationMonthly
desktop_outgoing_referral_changeMonth-over-month change in desktop outgoing referral visitsMonthly
mobile_referral_visitsNumber of mobile visits from referring sites to the analyzed domainMonthly
mobile_referral_sharePercentage share of mobile referral traffic from each referring domainMonthly
mobile_referral_changeMonth-over-month change in mobile referral visitsMonthly

Example Request

curl --location 'https://api.similarweb.com/batch/v4/request-report' \
--header 'api-key: {{API_KEY}}' \
--header 'Content-Type: application/json' \
--data '{
  "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"
      }
    ]
  }
}'

Popular Pages (popular_pages)

Primary use case: Returns a list of pages receiving incoming traffic from all devices (desktop and mobile) and traffic share per page.

Primary Keys: domains

Available Metrics:

Metric NameDescriptionGranularity
popular_page_sharePercentage of total website traffic that each page receivesMonthly, Weekly, Daily

Example Request

curl --location 'https://api.similarweb.com/batch/v4/request-report' \
--header 'api-key: {{API_KEY}}' \
--header 'Content-Type: application/json' \
--data '{
  "delivery_information": {
    "response_format": "csv",
    "delivery_method_params": {
      "retention_days": 60
    }
  },
  "report_query": {
    "tables": [
      {
        "vtable": "popular_pages",
        "granularity": "monthly",
        "filters": {
          "countries": ["WW"]
        },
        "metrics": [
          "popular_page_share"
        ],
        "start_date": "2025-07",
        "end_date": "2025-07"
      }
    ]
  }
}'

Website Description (website)

Primary use case: Website metadata and revenue estimation

Primary Keys: domains

Available Metrics:

Metric NameDescriptionGranularity
ecommerce_typeType of e-commerce functionality on the website (e.g., marketplace, direct seller, non-ecommerce)Monthly
first_level_domainThe first-level domain of the websiteMonthly
main_categoryPrimary industry category of the websiteMonthly
sub_categorySecondary/specific industry category of the websiteMonthly
online_revenueEstimated monthly e-commerce revenue generated by the websiteMonthly

Example Request

curl --location 'https://api.similarweb.com/batch/v4/request-report' \
--header 'api-key: {{API_KEY}}' \
--header 'Content-Type: application/json' \
--data '{
  "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"
      }
    ]
  }
}'

Updated about 22 hours ago

What’s Next

webs