Accessing Previous Data Version via Similarweb API

We understand that transitioning to a new data version can be challenging. To ensure a smooth transition and provide flexibility, we are keeping the previous data version (4.0) available through our API until the end of the year. This guide will walk you through the steps necessary to access our previous data version, enabling side-by-side comparisons and continued use of the familiar dataset.

Use Cases

1. Side-by-Side Comparison: Compare the new data version with the previous one to understand the changes and improvements.
2. Extended Transition Period: For clients who prefer not to transition immediately, continue pulling data from the previous version.
3. Consistency in Analysis: Maintain consistency in your ongoing projects by using the familiar data version while evaluating the new updates.

Getting Started

To continue using the previous data version in your Batch API queries, include the "data_version": "VERSION_4.0" line in your query structure. This will apply the previous data version to your analysis, ensuring you receive the data as it was before the update.

• Supported Granularity: Monthly / Daily
• Historical Data: Up to 5 years of historical data is supported. Access to historical data will be based on your package.
• Country Filters: All country filters are included. Access to country filters will be based on your package.

API Example Query with the Previous Data Version - Traffic and Engagement

Here's an example of how to incorporate the previous data version into your Batch API query:

Java
POST https://api.similarweb.com/batch/v4/request-report
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"
  },
  "report_query": {
    "tables": [
      {
        "vtable": "traffic_and_engagement",
        "granularity": "monthly",
        "filters": {
          "domains": [
            "similarweb.com",
            "amazon.com"
          ],
          "countries": [
            "WW",
            "GB",
            "US"
          ],
          "include_subdomains": true
        },
        "metrics": [
          "desktop_share",
          "desktop_average_visit_duration",
          "country_rank",
          "category_rank_new",
          "mobile_bounce_rate",
          "mobile_share"
        ],
        "start_date": "2024-01",
        "end_date": "2024-03",
        "data_version": "VERSION_4.0"
      }
    ]
  },
  "report_name": "previous data version"
}'

Available Metrics - Traffic and Engagement

All traffic metrics:

• all_traffic_visits
• all_traffic_pages_per_visit
• all_traffic_average_visit_duration
• all_traffic_bounce_rate
• all_page_views
• global_rank
• deduplicated_audience

All traffic metrics:

• desktop_visits
• desktop_unique_visitors
• desktop_pages_per_visit
• desktop_average_visit_duration
• desktop_bounce_rate
• desktop_page_views
• desktop_share
• desktop_top_geo

Mobile metrics:

• mobile_visits
• mobile_unique_visitors
• mobile_pages_per_visit
• mobile_average_visit_duration
• mobile_bounce_rate
• mobile_page_views
• mobile_share

API Example Query with the Previous Data Version - Marketing Channels

Here's an example of how to incorporate the previous data version into your Batch API query:

POST https://api.similarweb.com/batch/v4/request-report
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"
  },
  "report_query": {
    "tables": [
      {
        "vtable": "marketing_channels",
        "granularity": "monthly",
        "filters": {
          "domains": [
            "similarweb.com",
            "amazon.com"
          ],
          "countries": [
            "WW",
            "GB",
            "US"
          ],
   "channels": [
  "direct"
  "organic_search"
  "paid_search"
  "referrals"
  "mail"
 ],
          "include_subdomains": true
        },
        "metrics": [
"desktop_marketing_channels_share"
"desktop_marketing_channels_visits"
"mobile_marketing_channels_share"
"mobile_marketing_channels_visits"
        ],
        "start_date": "2024-01",
        "end_date": "2024-03",
        "data_version": "VERSION_4.0"
      }
    ]
  },
  "report_name": "previous data version"
}'

Available Metrics - Marketing Channels

Desktop metrics:

desktop_marketing_channels_visits
desktop_marketing_channels_share

Mobile metrics:

mobile_marketing_channels_visits
mobile_marketing_channels_share

 

Important Notes

• Previous Data Version Availability: The previous data version will continue to populate new data for the remaining months of the year until it is fully sunset on December 31st, 2024.
• Transition Period: The previous data version will remain accessible until the end of the year, giving you ample time to transition to the new version.

We are committed to making this transition as smooth as possible and are excited for you to experience the benefits of our data updates. Should you have any questions or need further assistance, please reach out to your account manager or submit a request through our contact form.

We look forward to your feedback and are here to support you every step of the way.