SimilarWeb

SimilarWeb Integrations API

Manage cloud storage integrations (S3, GCS, Snowflake)

GitHub OpenAPI

Operations 3

Each operation below carries the questions people ask an LLM about it and the instructions they give an agent to run it. Generated by API Evangelist overlay

POST /batch/v4/s3-integration Connect an Amazon S3 bucket for report delivery · S3 Integration #
Ask an LLM
“How do I get batch reports delivered straight into my S3 bucket?”
“Can I set a path prefix and region for S3 report delivery?”
Tell an agent
Create an S3 integration named {integration_name} for bucket {bucket_name}.
Connect S3 bucket {bucket_name} in region {region} under prefix {prefix} as {integration_name}.
POST /batch/v4/gcs-integration Connect a Google Cloud Storage bucket · Google Cloud Storage (GCS) Integration #
Ask an LLM
“How do I deliver batch reports to a Google Cloud Storage bucket?”
“Can reports land in a specific folder of my GCS bucket?”
Tell an agent
Create a GCS integration named {integration_name} for bucket {bucket_name}.
Deliver reports to Google Cloud Storage bucket {bucket_name} under {prefix}, called {integration_name}.
GET /batch/v4/integrations List configured cloud storage integrations · Get All Account Integrations #
Ask an LLM
“Which cloud storage destinations are already set up on my account?”
“What S3 and GCS integrations do we have configured?”
Tell an agent
List all cloud storage integrations on my account.
Show every report delivery integration we've configured.

Documentation

📖
Documentation
https://developers.similarweb.com/
📖
GettingStarted
https://developers.similarweb.com/docs/getting-started
📖
Authentication
https://developers.similarweb.com/docs/authentication
📖
RateLimits
https://developers.similarweb.com/docs/rate-limit

Specifications

⚙
OpenAPI
https://raw.githubusercontent.com/api-evangelist/similarweb/refs/heads/main/openapi/similarweb-integrations-api-openapi.yml

Work with this as data

Every API here is available over the APIs.io API and to AI agents over MCP.

MCP server

One button, every client — Claude, Cursor, VS Code and the rest.

https://apis.io/mcp

Tools for apis

7 MCP tools reach this
  • find_apisBrowse and filter every API in the catalog.
  • get_api_artifactsOne API's artifacts, grouped by type.
  • get_openapiThe primary OpenAPI for this API.
  • find_similar_apisAPIs that look like this one.
  • apis_io_searchSTART HERE — APIs, providers and tags for one query, each with its total.
  • resolveTurn a domain, URL or GitHub org into the provider it belongs to.
  • find_cohortsEvery scored population of providers in the catalog.
All 92 tools →

Call it yourself

curl for this page
This API 
curl "https://apis.io/api/v1/apis/similarweb:similarweb-integrations-api"
All apis 
curl "https://apis.io/api/v1/apis?limit=25"

Discovery needs no key. Ratings and market analysis are Pro.

Get an API key

Free tier, no form to fill in. Signing in shares your email address with us — we store it to create your key and to recognise you if you sign in with another provider. See our Privacy Policy and Terms.

GitHub Google LinkedIn

A second provider on the same verified email joins the account you already have.

OpenAPI Specification

similarweb-integrations-api-openapi.yml Raw ↑ 
openapi: 3.2.0
info:
  title: SimilarWeb Batch Integrations API
  description: The SimilarWeb Batch API is optimized for large-scale bulk data extraction, supporting asynchronous jobs of up to one million domains per request. It delivers data to cloud storage destinations including Amazon S3, Google Cloud Storage, and Snowflake. The API covers website traffic, keywords, referrals, geography, segments, apps, companies, e-commerce, and technographics datasets.
  version: 4.0.0
  termsOfService: https://www.similarweb.com/corp/legal/terms-of-use/
  contact:
    name: SimilarWeb Support
    url: https://support.similarweb.com/hc/en-us/articles/22089555897373-REST-API
  license:
    name: Proprietary
    url: https://www.similarweb.com/corp/legal/terms-of-use/
servers:
- url: https://api.similarweb.com
  description: SimilarWeb API server
tags:
- name: Integrations
  description: Manage cloud storage integrations (S3, GCS, Snowflake)
paths:
  /batch/v4/s3-integration:
    post:
      operationId: createS3Integration
      summary: S3 Integration
      description: Create a new Amazon S3 integration for batch report delivery.
      tags:
      - Integrations
      security:
      - apiKeyHeader: []
      requestBody:
        required: true
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/S3IntegrationRequest'
      responses:
        '200':
          description: Integration created
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/IntegrationResponse'
        '400':
          $ref: '#/components/responses/BadRequest'
  /batch/v4/gcs-integration:
    post:
      operationId: createGcsIntegration
      summary: Google Cloud Storage (GCS) Integration
      description: Create a new Google Cloud Storage integration for batch report delivery.
      tags:
      - Integrations
      security:
      - apiKeyHeader: []
      requestBody:
        required: true
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/GcsIntegrationRequest'
      responses:
        '200':
          description: GCS integration created
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/IntegrationResponse'
        '400':
          $ref: '#/components/responses/BadRequest'
  /batch/v4/integrations:
    get:
      operationId: getAllIntegrations
      summary: Get All Account Integrations
      description: Retrieve all cloud storage integrations configured for the account.
      tags:
      - Integrations
      security:
      - apiKeyHeader: []
      responses:
        '200':
          description: List of integrations
          content:
            application/json:
              schema:
                type: object
                properties:
                  integrations:
                    type: array
                    items:
                      $ref: '#/components/schemas/IntegrationResponse'
        '400':
          $ref: '#/components/responses/BadRequest'
components:
  schemas:
    GcsIntegrationRequest:
      type: object
      required:
      - bucket_name
      - integration_name
      properties:
        integration_name:
          type: string
          description: Name for this integration
        bucket_name:
          type: string
          description: Target Google Cloud Storage bucket name
        prefix:
          type: string
          description: Path prefix within the bucket
    IntegrationResponse:
      type: object
      properties:
        integration_name:
          type: string
        integration_type:
          type: string
          enum:
          - s3
          - gcs
          - snowflake
        status:
          type: string
        created_at:
          type: string
          format: date-time
    S3IntegrationRequest:
      type: object
      required:
      - bucket_name
      - integration_name
      properties:
        integration_name:
          type: string
          description: Name for this integration
        bucket_name:
          type: string
          description: Target Amazon S3 bucket name
        region:
          type: string
          description: AWS region of the bucket
        prefix:
          type: string
          description: Path prefix within the bucket
  responses:
    BadRequest:
      description: Bad request - invalid parameters or missing required fields
      content:
        application/json:
          schema:
            type: object
  securitySchemes:
    apiKeyHeader:
      type: apiKey
      in: header
      name: api-key
      description: SimilarWeb API key passed as a request header
externalDocs:
  description: SimilarWeb Batch API Documentation
  url: https://developers.similarweb.com/docs/intro-to-the-batch-api-datasets.md