Similarweb

Getting Started

Introduction

What's New in V5

Authentication

Making Your First Request

Guides

Available Data

Popular Use Cases

REST API vs Batch API

API Pricing & Data Credits

Error Handling & Troubleshooting

API Reference

<p class="slate-p " >Endpoints returning traffic and engagement statistics.</p><p class="slate-p " ></p><p class="slate-p " ></p>

Web Intelligence API

Search Intelligence API

Sales Intelligence API

App Intelligence API

Gen AI Intelligence API

The Similarweb Batch API gives you scalable access to one of the world's largest digital measurement databases. Use this section to set up your account, learn how to request reports, configure webhooks, and handle errors and country codes.

<Callout attributes='{"isFitToPage":true,"dataType":"info","style":{"width":"100%","minWidth":"100%"}}'>
  <p>Batch API and REST API use different authentication keys. Make sure you're using your <strong class="slate-bold">Batch API key</strong> when calling these endpoints.</p>
</Callout>


Batch API Reference

Welcome to Similarweb's Batch API — giving you scalable access to the world's largest digital measurement database. Get Similarweb data for more than 1,000,000 domains and 5 years of history, with tens of metrics, in one API call.

This guide walks you through the two main steps required to get millions of data points from the API.

## Get started checklist

*   🔑 [Get an API Key tutorial](https://developers.similarweb.com/docs/authentication), or generate a new key directly from your [account](https://account.similarweb.com/batch-api?from=developershub)
*   📈 Choose the data and metrics you need based on your subscription on [datahub.similarweb.com](https://dash.readme.com/go/similarweb?redirect=%2Fv4.0%2Fdocs%2Fdatahub) or discover new datasets [here](https://smwb-batch-api.streamlit.app/)
*   📝 Create a request report with a valid JSON body
*   🔗 Connect and integrate to your data lake (S3, Snowflake, Databricks)

## Step-by-step guide

<Steps attributes='{"style":{"width":"100%","minWidth":"100%"}}'>
<Step stepNumber="1" title="Submit a POST request"><p>Make a <strong class="slate-bold">POST</strong> request with a JSON body — either inline or attached as a file using <strong class="slate-bold">multipart/form-data</strong>.</p></Step>
<Step stepNumber="2" title="Track your report"><p>After you receive your <strong class="slate-bold">report ID</strong>, use the Request Report Status endpoint to receive the status and download URL once the report is ready.</p></Step>
</Steps>

<Tabs attributes='{"style":{"width":"100%"},"isFitToPage":true,"tabs":["POST","Python"]}'>
<TabPanel tabTitle="POST">
**POST** `https://api.similarweb.com/batch/v4/request-report`
</TabPanel>
<TabPanel tabTitle="Python">
<CodeBlock attributes='{"isFitToPage":true,"style":{},"lang":"python","label":"Python"}'>
  <CodeLine>import requests

url = "https://api.similarweb.com/batch/v4/request-report"

payload = {}
files = [
  ('request', ('Batchexample.json', open('/Users/Batchexample.json', 'rb'), 'application/json'))
]
headers = {
  'api-key': '{{your_api_key}}'
}

response = requests.request("POST", url, headers=headers, data=payload, files=files)

print(response.text)</CodeLine>
</CodeBlock>
</TabPanel>
</Tabs>

### Example JSON body

<CodeBlock attributes='{"isFitToPage":true,"style":{},"lang":"json","label":"Request Body"}'>
  <CodeLine>{
  "delivery_information": {
    "response_format": "csv"
  },
  "report_query": {
    "tables": [
      {
        "vtable": "traffic_and_engagement",
        "granularity": "monthly",
        "filters": {
          "domains": ["similarweb.com", "api.similarweb.com"],
          "countries": ["WW", "US"],
          "include_subdomains": true
        },
        "metrics": [
          "all_traffic_visits",
          "desktop_new_visitors",
          "desktop_pages_per_visit",
          "desktop_returning_visitors"
        ],
        "start_date": "2023-02",
        "end_date": "2024-02"
      }
    ]
  }
}</CodeLine>
</CodeBlock>

## Mandatory parameters

When requesting a report, include the following parameters in your JSON body.

<Table style="width:100%;min-width:100%" colSizes='["initial","initial","initial"]' isHeaderAdded='true' tableHeader='[{"id":"setup-col1","title":"Parameter"},{"id":"setup-col2","title":"Description"},{"id":"setup-col3","title":"Acceptable values"}]'>
  <table-row>
    <table-cell>vtable</table-cell>
    <table-cell>The dataset you want to pull metrics from. See the full list on Datahub or the discovery endpoints.</table-cell>
    <table-cell>traffic_and_engagement</table-cell>
  </table-row>
  <table-row>
    <table-cell>domains</table-cell>
    <table-cell>Domain names may include letters, numbers, dashes, and hyphens. One request supports up to 1M domains.</table-cell>
    <table-cell>amazon.com</table-cell>
  </table-row>
  <table-row>
    <table-cell>countries</table-cell>
    <table-cell>2-letter ISO country codes (case-sensitive, capital letters). Use "WW" for worldwide. When calling desktop_top_geo, remove all countries from your JSON.</table-cell>
    <table-cell>WW, US, GB</table-cell>
  </table-row>
  <table-row>
    <table-cell>metrics</table-cell>
    <table-cell>List of metrics per dataset.</table-cell>
    <table-cell>all_traffic_visits</table-cell>
  </table-row>
  <table-row>
    <table-cell>start_date, end_date</table-cell>
    <table-cell>Daily granularity uses YYYY-MM-DD; monthly granularity uses YYYY-MM.</table-cell>
    <table-cell>Daily: 2023-06-30 / Monthly: 2023-06</table-cell>
  </table-row>
  <table-row>
    <table-cell>granularity</table-cell>
    <table-cell>Time series granularity.</table-cell>
    <table-cell>monthly, weekly, daily</table-cell>
  </table-row>
  <table-row>
    <table-cell>response_format</table-cell>
    <table-cell>Output format of the API call.</table-cell>
    <table-cell>JSON, csv, parquet, orc</table-cell>
  </table-row>
</Table>

<Callout attributes='{"isFitToPage":true,"dataType":"warning","style":{"width":"100%","minWidth":"100%"}}'>
  <p><strong class="slate-bold">Save the report ID</strong> you receive after your API request — you'll need it to track the report status.</p>
  <p>The request limit is 20 pending requests per user. If you receive a <strong class="slate-bold">429</strong> error, you've exceeded the limit. Reduce the frequency of your requests to stay within your account limits.</p>
</Callout>

## Optional parameters

<Table style="width:100%;min-width:100%" colSizes='["initial","initial","initial"]' isHeaderAdded='true' tableHeader='[{"id":"opt-col1","title":"Parameter"},{"id":"opt-col2","title":"Description"},{"id":"opt-col3","title":"Acceptable values"}]'>
  <table-row>
    <table-cell>delivery_method</table-cell>
    <table-cell>Default is "download_link". When set to "snowflake", the response_format field is not required.</table-cell>
    <table-cell>download_link, bucket_access, snowflake</table-cell>
  </table-row>
  <table-row>
    <table-cell>delivery_method_params</table-cell>
    <table-cell>Use when delivering reports to aggregated Snowflake tables. Input "table_name": "your_table_name".</table-cell>
    <table-cell>table_name, integration_name, retention_days, overwrite_partitions</table-cell>
  </table-row>
  <table-row>
    <table-cell>all_history</table-cell>
    <table-cell>When true, automatically overrides dates to the minimum start and maximum end dates.</table-cell>
    <table-cell>true / false</table-cell>
  </table-row>
  <table-row>
    <table-cell>latest</table-cell>
    <table-cell>When true, overrides the end date with the latest available date.</table-cell>
    <table-cell>true / false</table-cell>
  </table-row>
  <table-row>
    <table-cell>window_size</table-cell>
    <table-cell>Overrides the start date with a time relative to the end date.</table-cell>
    <table-cell>{number}{y/m/d} — e.g. 12d, 3m, 2y</table-cell>
  </table-row>
  <table-row>
    <table-cell>limit</table-cell>
    <table-cell>Limits the number of results per entity selected.</table-cell>
    <table-cell>Above 0; default is 100 for most metrics</table-cell>
  </table-row>
  <table-row>
    <table-cell>include_subdomains</table-cell>
    <table-cell>Default is true.</table-cell>
    <table-cell>true / false</table-cell>
  </table-row>
  <table-row>
    <table-cell>webhook_url</table-cell>
    <table-cell>Delivery URL we'll ping when the status of your report changes.</table-cell>
    <table-cell>URL</table-cell>
  </table-row>
  <table-row>
    <table-cell>sort</table-cell>
    <table-cell>Sort by a specific metric.</table-cell>
    <table-cell>"sort": "all_traffic_visits"</table-cell>
  </table-row>
</Table>

## Get the report status

After submitting a request and receiving your report ID, use the Request Report Status endpoint to check progress.

<Tabs attributes='{"style":{"width":"100%"},"isFitToPage":true,"tabs":["GET","Python"]}'>
<TabPanel tabTitle="GET">
**GET** `https://api.similarweb.com/v3/batch/request-status/{{generated_report_id}}`
</TabPanel>
<TabPanel tabTitle="Python">
<CodeBlock attributes='{"isFitToPage":true,"style":{},"lang":"python","label":"Python"}'>
  <CodeLine>import requests

url = "https://api.similarweb.com/v3/batch/request-status/{{generated_report_id}}"

payload = {}
headers = {
  'api-key': '{{your_api_key}}'
}

response = requests.request("GET", url, headers=headers, data=payload)

print(response.text)</CodeLine>
</CodeBlock>
</TabPanel>
</Tabs>

### Example responses

<Tabs attributes='{"style":{"width":"100%"},"isFitToPage":true,"tabs":["Completed","In Progress"]}'>
<TabPanel tabTitle="Completed">
<CodeBlock attributes='{"isFitToPage":true,"style":{},"lang":"json","label":"Completed Report"}'>
  <CodeLine>{
  "data_points_count": 1779429,
  "download_url": "example_url.com",
  "status": "completed",
  "used_quota": 35589
}</CodeLine>
</CodeBlock>
</TabPanel>
<TabPanel tabTitle="In Progress">
<CodeBlock attributes='{"isFitToPage":true,"style":{},"lang":"json","label":"In Progress"}'>
  <CodeLine>{
  "status": "pending"
}</CodeLine>
</CodeBlock>
</TabPanel>
</Tabs>

## Data credits per request

<Callout attributes='{"isFitToPage":true,"dataType":"success","style":{"width":"100%","minWidth":"100%"}}'>
  <p>The download link remains valid for <strong class="slate-bold">30 days</strong>. We recommend saving it for some time in case you need our help troubleshooting any issue.</p>
</Callout>

<Callout attributes='{"isFitToPage":true,"dataType":"info","style":{"width":"100%","minWidth":"100%"}}'>
  <p>Data credits are calculated for each report based on the number of results you are actually receiving:</p>
  <p><strong class="slate-bold">Formula:</strong> Number of <strong class="slate-bold">domains</strong> × Number of <strong class="slate-bold">metrics</strong> × <strong class="slate-bold">history</strong> × <strong class="slate-bold">cadence</strong> (daily/monthly) × Number of <strong class="slate-bold">countries</strong> × Number of <strong class="slate-bold">results</strong></p>
</Callout>

<Callout attributes='{"isFitToPage":true,"dataType":"info","style":{"width":"100%","minWidth":"100%"}}'>
  <p>In order to calculate the estimated credits the report will cost, you can use the "request-validate" endpoint:</p>
  <p><a href="https://api.similarweb.com/v3/batch/request-validate" target="_blank">https://api.similarweb.com/v3/batch/request-validate</a></p>
</Callout>


Set up your Batch API

The discovery endpoints help you understand what's available before you submit a report. Use them to describe the available virtual tables, validate your webhook URL, and check your remaining account or user credits — all free of charge and without consuming your quota.


Batch API - Discovery

The Similarweb Batch API supports a range of datasets covering websites, audience and demographics, search and on-site search, apps, companies, technologies, ecommerce, and conversion analysis. Each dataset has its own dedicated page below with available metrics, filters, and sample requests.

<Callout attributes='{"isFitToPage":true,"dataType":"info","style":{"width":"100%","minWidth":"100%"}}'>
  <p>You can view the full list of datasets on <a href="https://dash.readme.com/go/similarweb?redirect=%2Fv4.0%2Fdocs%2Fdatahub" target="_blank">Datahub</a> or by calling the Describe Available Tables discovery endpoint.</p>
</Callout>


Batch API - Datasets

Batch API - Integrations

**Webhooks in Similarweb: Real-Time Notifications for Your Data Needs**

Webhooks let you stay informed about events and updates from the Similarweb API in real time. By subscribing to webhook notifications, your applications and systems are always up to date with the latest insights without the need for constant polling.

## Introduction to webhooks

Webhooks are a mechanism for receiving real-time notifications when specific events occur within the Similarweb API. Instead of repeatedly querying the API for updates, webhooks let Similarweb send POST requests directly to your endpoints as soon as an event of interest takes place.

*   **Real-time updates** — Know immediately when your report is available to download.
*   **Automations** — Build automations around your reporting and dashboards.

## Setting up webhooks

<Steps attributes='{"style":{"width":"100%","minWidth":"100%"}}'>
<Step stepNumber="1" title="Configure your endpoint"><p>Create a URL in your application that can receive HTTP POST requests from Similarweb.</p></Step>
<Step stepNumber="2" title="Validate using the webhook test endpoint"><p>Use the Check Webhook endpoint to validate that your webhook integration is successful.</p></Step>
<Step stepNumber="3" title="Use your validated URL with report endpoints"><p>Once validated, include the <strong class="slate-bold">webhook_url</strong> field in your report request body.</p></Step>
</Steps>

### Test webhook request

<Tabs attributes='{"style":{"width":"100%"},"isFitToPage":true,"tabs":["POST","Python"]}'>
<TabPanel tabTitle="POST">
<CodeBlock attributes='{"isFitToPage":true,"style":{},"lang":"bash","label":"POST"}'>
  <CodeLine>POST https://api.similarweb.com/v3/batch/webhooks/test

{
  "webhook_url": "http://slack.com/example_url/abc"
}</CodeLine>
</CodeBlock>
</TabPanel>
<TabPanel tabTitle="Python">
<CodeBlock attributes='{"isFitToPage":true,"style":{},"lang":"python","label":"Python"}'>
  <CodeLine>import requests

url = "https://api.similarweb.com/v3/batch/webhooks/test"

payload = "{\n\"webhook_url\": \"http://slack.com/example_url/abc\"\n}"
headers = {
  'api-key': '{{api_key}}'
}

response = requests.request("POST", url, headers=headers, data=payload)

print(response.text)</CodeLine>
</CodeBlock>
</TabPanel>
</Tabs>

The notification performs a POST with the following body:

<CodeBlock attributes='{"isFitToPage":true,"style":{},"lang":"json","label":"Test webhook output"}'>
  <CodeLine>{
  "event_type": "test_webhook_endpoint",
  "payload": "Webhook Integration with Similarweb is successful!"
}</CodeLine>
</CodeBlock>

Confirm in your internal system that you've received the `test_webhook_endpoint` event — it should be invoked immediately.

<Callout attributes='{"isFitToPage":true,"dataType":"warning","style":{"width":"100%","minWidth":"100%"}}'>
  <p>Timeout occurs after 5 seconds; a timeout will cause failure.</p>
</Callout>

## Use the validated URL with report endpoints

<CodeBlock attributes='{"isFitToPage":true,"style":{},"lang":"json","label":"POST request-report"}'>
  <CodeLine>POST https://api.similarweb.com/batch/v4/request-report

{
  "webhook_url": "http://slack.com/example_url/abc",
  "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": "2021-09",
  "end_date": "2021-11",
  "granularity": "monthly",
  "response_format": "csv"
}</CodeLine>
</CodeBlock>

When the report status changes, the webhook is triggered.

<Callout attributes='{"isFitToPage":true,"dataType":"info","style":{"width":"100%","minWidth":"100%"}}'>
  <p><strong class="slate-bold">Possible Report Statuses:</strong> "processing", "complete", or "internal_error".</p>
</Callout>


Webhook Endpoints

Similarweb MCP

MCP Integrations

Support and FAQ

Country Codes

Check Capabilities

Default

API V5 latest - USE THIS

Similarweb API V5 Documentation

Production

Sandbox

Ad Networks

AI Outreach

Amazon S3 Integration

App Active Users (DAU/WAU/MAU)

App Cross-Usage & Affinity

App Demographics

App Details

App Downloads

App IAB Categories

App Install Penetration

App Ranks

App Retention

App Revenue

App Search

App Sessions

App Technographics (SDKs)

App Top Charts

Contacts

Contacts Enrichment - Single

Contacts Enrichment - Bulk

Contacts Search

Lead Enrichment

Lead Enrichment - Company

Lead Enrichment - Website

Prompt Tracking

Keyword Competitors

Keywords Overview

Landing Pages

SERP Players - Aggregated

SERP Players - Clicks over time

Website Keywords

Website Audience

Audience Interest

Audience Overlap

Deduplicated Audience

Demographics

Demographics - specific groups

Website Content

Popular pages

Website Folders

Website Subdomains

Website Technologies

Website Performance

Conversion Rates Aggregated

Conversion Rates Over Time

Marketing Channel Sources

PPC Spend

Referrals

Top Sites Ranking

Traffic & Engagement

Traffic Geography

Website Ranking

Website Segments

List predefined segments

List User Segments

Segments Analysis

Segments Marketing Channels

App Technographics - Supported SDKs

Apps Dataset

How to find App IDs?

Company Dataset

Conversion Analysis (Site level) - All Traffic

Ecommerce Dataset (Shopper Intent)

Set Up Shopper Intelligence API

Intro to the Batch API Datasets

On-Site Search Dataset

Search Dataset

Technologies Dataset

Websites Audience & Demographics Dataset

Websites Dataset

Describe Available Tables (GET)

Get Remaining Credits (GET)

Get Remaining User Credits (GET)

Renew S3 Integration (POST)

Revoke S3 Integration (POST)

Revoke S3 Table (POST)

S3 Integration (POST)

Get All Account Integrations (GET)

Google Cloud Storage Integration

Renew GCS Integration (POST)

Revoke GCS Integration (POST)

Revoke GCS Table (POST)

Salesforce Connector

Snowflake API Integration

Get All Snowflake Integration Tables (GET)

Revoke Snowflake Integration (POST)

Snowflake Integration (POST)

Report Endpoints

Test Your Webhooks (GET)

Batch API - Geography from REST

Batch API - Referrals from REST

Batch API Request - Step-by-Step Walkthrough

ChatGPT MCP Integration

Check Data Credits Balance

Claude MCP Integration

Cursor MCP Integration

Recipes

Snowflake Table Integration

S3 Table Integration

GCS Table Integration

Batch API - Segment from REST

Batch API - Traffic and Engagement from REST

Batch API - Keywords from REST

Manus MCP Integration

Microsoft Copilot MCP Integration

Perplexity MCP Integration

<p class="slate-p " >Integrate Similarweb’s Batch API with your Google Cloud Storage (GCS) environment. This integration allows clients to store and access exported data directly in their own GCS buckets.</p><div class="steps-widget" style="width:100%;
  	min-width:100%;"><div class="steps-wrapper"><div class="steps-content"><h6 class="slate-h6 " >1</h6><h3 class="slate-h3 " >Create a new Google Cloud connection</h3><p class="slate-p " >Start by creating a new GCS integration to store and access data. This setup generates GCS access and secret keys that allow you to interact with your data securely in the specified bucket.</p></div></div><div class="steps-wrapper"><div class="steps-content"><h6 class="slate-h6 " >2</h6><h3 class="slate-h3 " >Save your credentials</h3><p class="slate-p " >After creating the connection, you receive private credentials including a GCS service-account JSON. These credentials are essential to access the shared bucket securely — store them in a safe place.</p></div></div><div class="steps-wrapper"><div class="steps-content"><h6 class="slate-h6 " >3</h6><h3 class="slate-h3 " >Generate a report using the create-table URL</h3><p class="slate-p " >Creating a table is similar to requesting a one-time report, but you modify the delivery information and call the create-table URL instead. This sets up a table that will store data continuously.</p></div></div><div class="steps-wrapper"><div class="steps-content"><h6 class="slate-h6 " >4</h6><h3 class="slate-h3 " >Modify the delivery information</h3><p class="slate-p " >Adjust the delivery_information block to define where and how the data is delivered. Set the delivery method to google_bucket_access to store the data in your GCS bucket.</p></div></div><div class="steps-wrapper"><div class="steps-content"><h6 class="slate-h6 " >5</h6><h3 class="slate-h3 " >Specify the integration name</h3><p class="slate-p " >Set the integration_name parameter to gcs_default to direct data to the appropriate integration.</p></div></div><div class="steps-wrapper"><div class="steps-content"><h6 class="slate-h6 " >6</h6><h3 class="slate-h3 " >Name your table</h3><p class="slate-p " >Provide a unique name for your table. This name is used to identify and manage the table in your GCS bucket — choose something that corresponds to the data you&apos;ll store.</p></div></div><div class="steps-wrapper"><div class="steps-content"><h6 class="slate-h6 " >7</h6><h3 class="slate-h3 " >Run the request</h3><p class="slate-p " >Once you&apos;ve filled out the request body, submit it to create the table. After submission, the table is set up in your GCS bucket and the requested data is added to it.</p></div></div><div class="steps-wrapper"><div class="steps-content"><h6 class="slate-h6 " >8</h6><h3 class="slate-h3 " >Retrieve the table path</h3><p class="slate-p " >After the table is created, you receive a location representing the GCS path (gs:÷…) where the table data is stored. Use this path to access the stored data.</p></div></div><div class="steps-wrapper"><div class="steps-content"><h6 class="slate-h6 " >9</h6><h3 class="slate-h3 " >Add data to the table</h3><p class="slate-p " >To append more data to the table after it&apos;s been created, use the request-report URL. This adds new data to the existing table without replacing it.</p></div></div><div class="steps-wrapper"><div class="steps-content"><h6 class="slate-h6 " >10</h6><h3 class="slate-h3 " >Send data to the table</h3><p class="slate-p " >By specifying the same integration_name and table_name as before, new data is added to your existing table. This keeps your data up to date with additional information as needed.</p></div></div><div class="steps-wrapper"><div class="steps-content"><h6 class="slate-h6 " >11</h6><h3 class="slate-h3 " >Keep field names consistent</h3><p class="slate-p " >When appending data, response_format, delivery_method, integration_name, and table_name must match the values you used when the table was first created.</p></div></div></div><h2 class="slate-h2 " >Response Properties</h2><p class="slate-p " >The response contains the information of the created integration.</p><div class="published-table"><div class="table-container" style="padding-left: 0px;"><table class="slate-table" style="min-width:100%;"><div class="published-table-header" style="width:100%;min-width:100%;"><div style="width:100%;">Property</div><div style="width:100%;">Description</div><div style="width:100%;">Example</div></div><colgroup ><col style="width:initial"><col style="width:initial"><col style="width:initial"></colgroup><tbody class="slate-TableElement-tbody"><tr class="slate-tr " ><div class="slate-TableCellElement-content"><td class="slate-td"><p class="slate-p " >expiration_date str</p></td></div><div class="slate-TableCellElement-content"><td class="slate-td"><p class="slate-p " >Date when the credentials expire</p></td></div><div class="slate-TableCellElement-content"><td class="slate-td"><p class="slate-p " >2025-03-21</p></td></div></tr><tr class="slate-tr " ><div class="slate-TableCellElement-content"><td class="slate-td"><p class="slate-p " ></p></td></div><div class="slate-TableCellElement-content"><td class="slate-td"><p class="slate-p " ></p></td></div><div class="slate-TableCellElement-content"><td class="slate-td"><p class="slate-p " ></p></td></div></tr><tr class="slate-tr " ><div class="slate-TableCellElement-content"><td class="slate-td"><p class="slate-p " >gcs_bucket str</p></td></div><div class="slate-TableCellElement-content"><td class="slate-td"><p class="slate-p " >The bucket where Similarweb will deliver the data</p></td></div><div class="slate-TableCellElement-content"><td class="slate-td"><p class="slate-p " >sw-daas-production</p></td></div></tr><tr class="slate-tr " ><div class="slate-TableCellElement-content"><td class="slate-td"><p class="slate-p " >gcs_prefix str</p></td></div><div class="slate-TableCellElement-content"><td class="slate-td"><p class="slate-p " >The path prefix inside the GCS bucket for this integration</p></td></div><div class="slate-TableCellElement-content"><td class="slate-td"><p class="slate-p " >account_id/my_integration/</p></td></div></tr><tr class="slate-tr " ><div class="slate-TableCellElement-content"><td class="slate-td"><p class="slate-p " >integration_name str</p></td></div><div class="slate-TableCellElement-content"><td class="slate-td"><p class="slate-p " >The name of the created integration. (can not be changed)</p></td></div><div class="slate-TableCellElement-content"><td class="slate-td"><p class="slate-p " >my_integration</p></td></div></tr><tr class="slate-tr " ><div class="slate-TableCellElement-content"><td class="slate-td"><p class="slate-p " >secret str</p></td></div><div class="slate-TableCellElement-content"><td class="slate-td"><p class="slate-p " >A complete GCP service account JSON for use with the integration</p></td></div><div class="slate-TableCellElement-content"><td class="slate-td"><p class="slate-p " >*</p></td></div></tr></tbody></table></div></div><div style="width:100%;
	min-width:100%;" class="callout-widget" data-type=info ><div class="callout-icon"><svg width="20" height="20" viewBox="0 0 20 20" fill="none" xmlns="http://www.w3.org/2000/svg"><path d="M10.0628 14.1676C10.2434 14.1676 10.3927 14.1086 10.5107 13.9905C10.6288 13.8725 10.6878 13.7232 10.6878 13.5426V9.77177C10.6878 9.6051 10.6253 9.46274 10.5003 9.34469C10.3753 9.22663 10.2295 9.1676 10.0628 9.1676C9.88227 9.1676 9.73296 9.22663 9.61491 9.34469C9.49685 9.46274 9.43783 9.61205 9.43783 9.7926V13.5634C9.43783 13.7301 9.50033 13.8725 9.62533 13.9905C9.75033 14.1086 9.89616 14.1676 10.0628 14.1676ZM10.0003 7.62594C10.1948 7.62594 10.358 7.56344 10.4899 7.43844C10.6219 7.31344 10.6878 7.15371 10.6878 6.95927C10.6878 6.76482 10.6219 6.59816 10.4899 6.45927C10.358 6.32038 10.1948 6.25094 10.0003 6.25094C9.80588 6.25094 9.64269 6.32038 9.51074 6.45927C9.3788 6.59816 9.31283 6.76482 9.31283 6.95927C9.31283 7.15371 9.3788 7.31344 9.51074 7.43844C9.64269 7.56344 9.80588 7.62594 10.0003 7.62594ZM10.0003 18.3343C8.81977 18.3343 7.72255 18.1225 6.70866 17.6989C5.69477 17.2752 4.81283 16.6884 4.06283 15.9384C3.31283 15.1884 2.72602 14.3065 2.30241 13.2926C1.8788 12.2787 1.66699 11.1815 1.66699 10.0009C1.66699 8.83427 1.8788 7.74399 2.30241 6.7301C2.72602 5.71621 3.31283 4.83427 4.06283 4.08427C4.81283 3.33427 5.69477 2.74399 6.70866 2.31344C7.72255 1.88288 8.81977 1.6676 10.0003 1.6676C11.167 1.6676 12.2573 1.88288 13.2712 2.31344C14.285 2.74399 15.167 3.33427 15.917 4.08427C16.667 4.83427 17.2573 5.71621 17.6878 6.7301C18.1184 7.74399 18.3337 8.83427 18.3337 10.0009C18.3337 11.1815 18.1184 12.2787 17.6878 13.2926C17.2573 14.3065 16.667 15.1884 15.917 15.9384C15.167 16.6884 14.285 17.2752 13.2712 17.6989C12.2573 18.1225 11.167 18.3343 10.0003 18.3343ZM10.0003 17.0843C11.9448 17.0843 13.6114 16.3898 15.0003 15.0009C16.3892 13.612 17.0837 11.9454 17.0837 10.0009C17.0837 8.05649 16.3892 6.38982 15.0003 5.00094C13.6114 3.61205 11.9448 2.9176 10.0003 2.9176C8.05588 2.9176 6.38921 3.61205 5.00033 5.00094C3.61144 6.38982 2.91699 8.05649 2.91699 10.0009C2.91699 11.9454 3.61144 13.612 5.00033 15.0009C6.38921 16.3898 8.05588 17.0843 10.0003 17.0843Z" fill="#3960B4"></path></svg></div><div ><p class="slate-p " ><strong class="slate-bold">The secret field in the response contains a Google service account JSON.</strong></p><p class="slate-p " >To access your GCS integration programmatically (e.g., using PySpark),save this JSON to a file and use the GOOGLE_APPLICATION_CREDENTIALS environment variable to authenticate.</p></div></div>

<p class="slate-p " >Access your Similarweb Batch API reports via Amazon S3.</p><p class="slate-p " >Access your Batch API reports directly from an Amazon S3 bucket maintained by Similarweb, so you can easily process your custom reports and automatically integrate them into your own database systems.</p><div style="width:100%;
	min-width:100%;" class="callout-widget" data-type=warning ><div class="callout-icon"><svg width="18" height="16" viewBox="0 0 18 16" fill="none" xmlns="http://www.w3.org/2000/svg"><path d="M0.916637 15.5009C0.791637 15.5009 0.683998 15.4732 0.59372 15.4176C0.503443 15.362 0.430526 15.2857 0.37497 15.1884C0.319415 15.0912 0.288165 14.9905 0.28122 14.8864C0.274276 14.7822 0.305526 14.6745 0.37497 14.5634L8.4583 0.605103C8.52775 0.493991 8.60761 0.41413 8.69789 0.365519C8.78816 0.316908 8.88886 0.292603 8.99997 0.292603C9.11108 0.292603 9.21178 0.316908 9.30205 0.365519C9.39233 0.41413 9.47219 0.493991 9.54164 0.605103L17.625 14.5634C17.6944 14.6745 17.7257 14.7822 17.7187 14.8864C17.7118 14.9905 17.6805 15.0912 17.625 15.1884C17.5694 15.2857 17.4965 15.362 17.4062 15.4176C17.3159 15.4732 17.2083 15.5009 17.0833 15.5009H0.916637ZM1.99997 14.2509H16L8.99997 2.1676L1.99997 14.2509ZM9.0833 13.0634C9.26386 13.0634 9.41316 13.0044 9.53122 12.8864C9.64928 12.7683 9.7083 12.619 9.7083 12.4384C9.7083 12.2579 9.64928 12.1086 9.53122 11.9905C9.41316 11.8725 9.26386 11.8134 9.0833 11.8134C8.90275 11.8134 8.75344 11.8725 8.63539 11.9905C8.51733 12.1086 8.4583 12.2579 8.4583 12.4384C8.4583 12.619 8.51733 12.7683 8.63539 12.8864C8.75344 13.0044 8.90275 13.0634 9.0833 13.0634ZM9.0833 10.7509C9.26386 10.7509 9.41316 10.6919 9.53122 10.5739C9.64928 10.4558 9.7083 10.3065 9.7083 10.1259V6.70927C9.7083 6.52871 9.64928 6.37941 9.53122 6.26135C9.41316 6.1433 9.26386 6.08427 9.0833 6.08427C8.90275 6.08427 8.75344 6.1433 8.63539 6.26135C8.51733 6.37941 8.4583 6.52871 8.4583 6.70927V10.1259C8.4583 10.3065 8.51733 10.4558 8.63539 10.5739C8.75344 10.6919 8.90275 10.7509 9.0833 10.7509Z" fill="#F1C21B"></path></svg></div><div ><p class="slate-p " ><strong class="slate-bold">Compatible with Similarweb Batch API only</strong></p><p class="slate-p " >To get access, speak to a Similarweb representative.</p></div></div><h2 class="slate-h2 " >Setup instructions</h2><div class="steps-widget" style="width:100%;
  	min-width:100%;"><div class="steps-wrapper"><div class="steps-content"><h6 class="slate-h6 " >1</h6><h3 class="slate-h3 " >Create a new S3 connection</h3><p class="slate-p " >Start by creating a new S3 integration to store and access data. This setup generates AWS access and secret keys that allow you to interact with your data securely in the specified S3 bucket.</p></div></div><div class="steps-wrapper"><div class="steps-content"><h6 class="slate-h6 " >2</h6><h3 class="slate-h3 " >Save your credentials</h3><p class="slate-p " >After creating the connection, you receive private credentials including AWS access keys. These keys are essential to access the shared S3 bucket securely — store them in a safe place.</p></div></div><div class="steps-wrapper"><div class="steps-content"><h6 class="slate-h6 " >3</h6><h3 class="slate-h3 " >Generate a report using the create-table URL</h3><p class="slate-p " >Creating a table is similar to requesting a one-time report, but you modify the delivery information and call the create-table URL instead. This sets up a table that will store data continuously.</p></div></div><div class="steps-wrapper"><div class="steps-content"><h6 class="slate-h6 " >4</h6><h3 class="slate-h3 " >Modify the delivery information</h3><p class="slate-p " >Adjust the delivery_information block to define where and how the data is delivered. Set the delivery method to bucket_access to store the data in your S3 bucket.</p></div></div><div class="steps-wrapper"><div class="steps-content"><h6 class="slate-h6 " >5</h6><h3 class="slate-h3 " >Specify the integration name</h3><p class="slate-p " >Set the integration_name parameter to s3_default to direct data to the appropriate integration.</p></div></div><div class="steps-wrapper"><div class="steps-content"><h6 class="slate-h6 " >6</h6><h3 class="slate-h3 " >Name your table</h3><p class="slate-p " >Provide a unique name for your table. This name is used to identify and manage the table in your S3 bucket — choose something that corresponds to the data you&apos;ll store.</p></div></div><div class="steps-wrapper"><div class="steps-content"><h6 class="slate-h6 " >7</h6><h3 class="slate-h3 " >Run the request</h3><p class="slate-p " >Once you&apos;ve filled out the request body, submit it to create the table. After submission, the table is set up in your S3 bucket and the requested data is added to it.</p></div></div><div class="steps-wrapper"><div class="steps-content"><h6 class="slate-h6 " >8</h6><h3 class="slate-h3 " >Retrieve the table path</h3><p class="slate-p " >After the table is created, you receive a location representing the S3 path where the table data is stored. Use this path to access the stored data.</p></div></div><div class="steps-wrapper"><div class="steps-content"><h6 class="slate-h6 " >9</h6><h3 class="slate-h3 " >Add data to the table</h3><p class="slate-p " >To append more data to the table after it&apos;s been created, use the request-report URL. This adds new data to the existing table without replacing it.</p></div></div><div class="steps-wrapper"><div class="steps-content"><h6 class="slate-h6 " >10</h6><h3 class="slate-h3 " >Send data to the table</h3><p class="slate-p " >By specifying the same integration_name and table_name as before, new data is added to your existing table. This keeps your data up to date with additional information as needed.</p></div></div><div class="steps-wrapper"><div class="steps-content"><h6 class="slate-h6 " >11</h6><h3 class="slate-h3 " >Keep field names consistent</h3><p class="slate-p " >When appending data, response_format, delivery_method, integration_name, and table_name must match the values you used when the table was first created.</p></div></div></div><p class="slate-p " >To access your reports securely via the S3 bucket, use the ‘Get-S3-Credentials’ endpoint to retrieve a personalized AWS access key.</p><p class="slate-p " >Endpoint-</p><p class="slate-p " >[GET] <a href="https://api.similarweb.com/batch/v5/s3-connector/setup" target="_self">https://api.similarweb.com/batch/v5/s3-connector/setup</a></p><p class="slate-p " >Response - 200 OK</p><div style="text-align:left"><figure ><div style="display:inline-block"><img src="https://files.readme.io/08977ae-1624e037a7cbe9.png" alt="" style="
              width:498pxpx;
	            height:113pxpx;
	            aspect-ratio:498px / 113px"
         /></div></figure></div>

<p class="slate-p " >Integrate Similarweb Batch API reports into your Snowflake account.</p><p class="slate-p " >Store, access, and analyze Similarweb data directly from your Snowflake database, so you can easily perform queries on your custom reports, or automatically integrate them into your own analytics or visualization tools.</p><div style="width:100%;
	min-width:100%;" class="callout-widget" data-type=warning ><div class="callout-icon"><svg width="18" height="16" viewBox="0 0 18 16" fill="none" xmlns="http://www.w3.org/2000/svg"><path d="M0.916637 15.5009C0.791637 15.5009 0.683998 15.4732 0.59372 15.4176C0.503443 15.362 0.430526 15.2857 0.37497 15.1884C0.319415 15.0912 0.288165 14.9905 0.28122 14.8864C0.274276 14.7822 0.305526 14.6745 0.37497 14.5634L8.4583 0.605103C8.52775 0.493991 8.60761 0.41413 8.69789 0.365519C8.78816 0.316908 8.88886 0.292603 8.99997 0.292603C9.11108 0.292603 9.21178 0.316908 9.30205 0.365519C9.39233 0.41413 9.47219 0.493991 9.54164 0.605103L17.625 14.5634C17.6944 14.6745 17.7257 14.7822 17.7187 14.8864C17.7118 14.9905 17.6805 15.0912 17.625 15.1884C17.5694 15.2857 17.4965 15.362 17.4062 15.4176C17.3159 15.4732 17.2083 15.5009 17.0833 15.5009H0.916637ZM1.99997 14.2509H16L8.99997 2.1676L1.99997 14.2509ZM9.0833 13.0634C9.26386 13.0634 9.41316 13.0044 9.53122 12.8864C9.64928 12.7683 9.7083 12.619 9.7083 12.4384C9.7083 12.2579 9.64928 12.1086 9.53122 11.9905C9.41316 11.8725 9.26386 11.8134 9.0833 11.8134C8.90275 11.8134 8.75344 11.8725 8.63539 11.9905C8.51733 12.1086 8.4583 12.2579 8.4583 12.4384C8.4583 12.619 8.51733 12.7683 8.63539 12.8864C8.75344 13.0044 8.90275 13.0634 9.0833 13.0634ZM9.0833 10.7509C9.26386 10.7509 9.41316 10.6919 9.53122 10.5739C9.64928 10.4558 9.7083 10.3065 9.7083 10.1259V6.70927C9.7083 6.52871 9.64928 6.37941 9.53122 6.26135C9.41316 6.1433 9.26386 6.08427 9.0833 6.08427C8.90275 6.08427 8.75344 6.1433 8.63539 6.26135C8.51733 6.37941 8.4583 6.52871 8.4583 6.70927V10.1259C8.4583 10.3065 8.51733 10.4558 8.63539 10.5739C8.75344 10.6919 8.90275 10.7509 9.0833 10.7509Z" fill="#F1C21B"></path></svg></div><div ><p class="slate-p " ><strong class="slate-bold">Compatible with Similarweb Batch API only</strong></p><p class="slate-p " >To enable access to the Similarweb Snowflake connector, please speak to a Similarweb representative.</p></div></div><h2 class="slate-h2 " >Snowflake integration instructions</h2><div class="steps-widget" style="width:100%;
  	min-width:100%;"><div class="steps-wrapper"><div class="steps-content"><h6 class="slate-h6 " >1</h6><h3 class="slate-h3 " >Create a new Snowflake connection</h3><p class="slate-p " >Start by creating a Snowflake integration to store and access your data. You&apos;ll need to provide your snowflake_account_id (locator ID) and snowflake_region.</p></div></div><div class="steps-wrapper"><div class="steps-content"><h6 class="slate-h6 " >2</h6><h3 class="slate-h3 " >Generate a report using the create-table URL</h3><p class="slate-p " >Creating a table is similar to requesting a one-time report, but you modify the delivery information and call the create-table URL instead. This sets up a table that will store data continuously.</p></div></div><div class="steps-wrapper"><div class="steps-content"><h6 class="slate-h6 " >3</h6><h3 class="slate-h3 " >Modify the delivery information</h3><p class="slate-p " >Adjust the delivery_information block to define where and how the data is delivered. Set the delivery method to snowflake to store the data in your Snowflake account.</p></div></div><div class="steps-wrapper"><div class="steps-content"><h6 class="slate-h6 " >4</h6><h3 class="slate-h3 " >Specify the integration name</h3><p class="slate-p " >Set the integration_name parameter to snowflake_default to direct data to the appropriate integration.</p></div></div><div class="steps-wrapper"><div class="steps-content"><h6 class="slate-h6 " >5</h6><h3 class="slate-h3 " >Name your table</h3><p class="slate-p " >Provide a unique name for your table. This name is used to identify and manage the table in Snowflake — choose something that corresponds to the data you&apos;ll store.</p></div></div><div class="steps-wrapper"><div class="steps-content"><h6 class="slate-h6 " >6</h6><h3 class="slate-h3 " >Run the request</h3><p class="slate-p " >Once you&apos;ve filled out the request body, submit it to create the table. After submission, the table is set up in Snowflake and the requested data is added to it.</p></div></div><div class="steps-wrapper"><div class="steps-content"><h6 class="slate-h6 " >7</h6><h3 class="slate-h3 " >Retrieve the table path</h3><p class="slate-p " >After the table is created, you receive a share_name representing the Snowflake path where the table data is stored. Use this path to access the stored data.</p></div></div><div class="steps-wrapper"><div class="steps-content"><h6 class="slate-h6 " >8</h6><h3 class="slate-h3 " >Add data to the table</h3><p class="slate-p " >To append more data to the table after it&apos;s been created, use the request-report URL. This adds new data to the existing table without replacing it.</p></div></div><div class="steps-wrapper"><div class="steps-content"><h6 class="slate-h6 " >9</h6><h3 class="slate-h3 " >Send data to the table</h3><p class="slate-p " >By specifying the same integration_name and table_name as before, new data is added to your existing table. This keeps your data up to date with additional information as needed.</p></div></div><div class="steps-wrapper"><div class="steps-content"><h6 class="slate-h6 " >10</h6><h3 class="slate-h3 " >Keep field names consistent</h3><p class="slate-p " >When appending data, delivery_method, integration_name, and table_name must match the values you used when the table was first created.</p></div></div></div><p class="slate-p " >The screenshots below are taken from Snowflake’s latest user interface (UI), Snowsight. If you are using a different version of the UI, your account might look different.</p><p class="slate-p " ><strong class="slate-bold">Step 1</strong></p><p class="slate-p " >Retrieve your Snowflake locator ID. This can be found on the platform’s left sidebar.</p><p class="slate-p " >Note: Your reports can only be shared to 1 Snowflake ID.</p><p class="slate-p " ><strong class="slate-bold">Step 2</strong></p><p class="slate-p " >Retrieve your Snowflake region using the following request:</p><div style="text-align:left"><figure ><div style="display:inline-block"><img src="https://files.readme.io/b32a235-Screen_Shot_2022-11-09_at_10.43.58.png" alt="" style="
              width:746pxpx;
	            height:378pxpx;
	            aspect-ratio:746px / 378px"
         /></div></figure></div>

Use the Similarweb Salesforce Connector to automatically enrich your accounts, contacts, and leads, strengthening the quality of your pipeline and increasing sales efficiency.

The connector includes 17 vital metrics, including traffic, web category, HQ location, engagement metrics, and many more.

### Watch the tutorial video to get started or read the full guide below to get a step-by-step walkthrough of the integration process:

<Video url="https://player.vimeo.com/video/433917316"/>

**Setup manual (PDF):** [Open the setup manual](https://www.similarweb.com/corp/wp-content/uploads/2024/09/Similarweb-Salesforce-Connector-Setup-Manual-v2.9-July-2024_compressed.pdf)

Contact us today to find out how to enrich your leads, contacts, and accounts with Similarweb.

This endpoint provides a list of all of the account's integrations (S3 integrations and Snowflake integrations).

Response
--------

The response contains all integrations created under the user's account.

#### IntegrationsList Object

This object contains a list of all integrations created under the user's account.

<Table style="width:100%;min-width:100%" colSizes='["initial","initial","initial"]' isHeaderAdded='true' tableHeader='[{"id":"007b6259-4e37-4155-9dbf-03d8b2a81018","title":"Property"},{"id":"9e192b38-01e5-4ea8-9f76-e7933f513e77","title":"Description"},{"id":"0eda4334-0fff-4faf-a1b0-4cd2b839a585","title":"Example"}]'>
  <table-row>
    <table-cell><p class="slate-p ">S3 List[S3Integration]</p></table-cell>
    <table-cell><p class="slate-p ">A list of all of the account's S3 integrations.</p></table-cell>
    <table-cell><p class="slate-p ">[ "my_integrations_1", my_integrations_2" ]</p></table-cell>
  </table-row>
  <table-row>
    <table-cell><p class="slate-p ">Snowflake List[SnowflakeIntegration]</p></table-cell>
    <table-cell><p class="slate-p ">A list of all of the account's Snowflake integrations.</p></table-cell>
    <table-cell><p class="slate-p ">[ "my_snowflake_integration", "snowflake_default", ]</p></table-cell>
  </table-row>
</Table>

<Divider />

#### S3Integration Object

This object describes the S3 integration.

<Table style="width:100%;min-width:100%" colSizes='["initial","initial","initial"]' isHeaderAdded='true' tableHeader='[{"id":"9895928a-2a20-4644-958e-68098393d50a","title":"Property"},{"id":"f62184f9-f6e2-418c-9fb1-51140f40b0bf","title":"Description"},{"id":"4399f7a7-a4d3-4bbc-ac31-7ae011aa2c55","title":"Example"}]'>
  <table-row>
    <table-cell><p class="slate-p ">expiration_date str</p></table-cell>
    <table-cell><p class="slate-p ">The date after which the integration will not be active.</p></table-cell>
    <table-cell><p class="slate-p ">"2024-06-06"</p></table-cell>
  </table-row>
  <table-row>
    <table-cell><p class="slate-p ">integration_name str</p></table-cell>
    <table-cell><p class="slate-p ">The name of the integration.</p></table-cell>
    <table-cell><p class="slate-p ">"my_integrations_1"</p></table-cell>
  </table-row>
</Table>

<Divider />

#### Snowflake Integration Object

This object describes the Snowflake integration.

<Table style="width:100%;min-width:100%" colSizes='["initial","initial","initial"]' isHeaderAdded='true' tableHeader='[{"id":"93912477-12d5-423b-b794-c5e3bab35a08","title":"Property"},{"id":"d779a75d-b251-473f-8512-42f46d70b4c2","title":"Description"},{"id":"4bd5eb77-ac70-4700-a667-4ef0c3310a2f","title":"Example"}]'>
  <table-row>
    <table-cell><p class="slate-p ">client_account_id str</p></table-cell>
    <table-cell><p class="slate-p ">The Snowflake account ID (AKA the account locator).</p></table-cell>
    <table-cell><p class="slate-p ">"ABC12345"</p></table-cell>
  </table-row>
  <table-row>
    <table-cell><p class="slate-p ">integration_name str</p></table-cell>
    <table-cell><p class="slate-p ">The Snowflake integration name.</p></table-cell>
    <table-cell><p class="slate-p ">"snowflake_default"</p></table-cell>
  </table-row>
  <table-row>
    <table-cell><p class="slate-p ">share_name str</p></table-cell>
    <table-cell><p class="slate-p ">The snowflake share name.</p></table-cell>
    <table-cell><p class="slate-p ">"SIMILARWEB_12345678_snowflake_default"</p></table-cell>
  </table-row>
</Table>

Sections

Google Cloud Storage Integration

On this page

Sections

Google Cloud Storage Integration

On this page

Ask an AI

Code with AI