SimilarWeb · OpenAPI Overlay 1.0.0

API Evangelist conversational phrasing for SimilarWeb Batch Integrations API

4 actions 4 updates phrasing extends openapi/similarweb-integrations-api-openapi.yml
Generated by API Evangelist Written by API Evangelist tooling for SimilarWeb's API. It is a proposal applied on top of the contract, not a document SimilarWeb publishes.
View Overlay File View on GitHub Overlay Specification

What the actions change

x-apievangelist-phrasing

Targets 4

$.info
$.paths['/batch/v4/s3-integration'].post
$.paths['/batch/v4/gcs-integration'].post
$.paths['/batch/v4/integrations'].get

OpenAPI Overlay

Raw ↑ 
# Generated by API Evangelist (build-phrasing.py). Our phrasing, not observed demand.
overlay: 1.0.0
info:
  title: API Evangelist conversational phrasing for SimilarWeb Batch Integrations API
  version: 1.0.0
extends: openapi/similarweb-integrations-api-openapi.yml
actions:
- target: $.info
  update:
    x-apievangelist-phrasing:
      method: generated
      generated: '2026-10-01'
      generator: build-phrasing.py
      label: Generated by API Evangelist
      operations: 3
- target: $.paths['/batch/v4/s3-integration'].post
  update:
    x-apievangelist-phrasing:
      intent: Connect an Amazon S3 bucket for report delivery
      effect: write
      questions:
      - How do I get batch reports delivered straight into my S3 bucket?
      - Can I set a path prefix and region for S3 report delivery?
      instructions:
      - text: Create an S3 integration named {integration_name} for bucket {bucket_name}.
        slots:
          integration_name: requestBody.integration_name
          bucket_name: requestBody.bucket_name
      - text: Connect S3 bucket {bucket_name} in region {region} under prefix {prefix} as {integration_name}.
        slots:
          bucket_name: requestBody.bucket_name
          region: requestBody.region
          prefix: requestBody.prefix
          integration_name: requestBody.integration_name
      method: generated
      generated: '2026-10-01'
- target: $.paths['/batch/v4/gcs-integration'].post
  update:
    x-apievangelist-phrasing:
      intent: Connect a Google Cloud Storage bucket
      effect: write
      questions:
      - How do I deliver batch reports to a Google Cloud Storage bucket?
      - Can reports land in a specific folder of my GCS bucket?
      instructions:
      - text: Create a GCS integration named {integration_name} for bucket {bucket_name}.
        slots:
          integration_name: requestBody.integration_name
          bucket_name: requestBody.bucket_name
      - text: Deliver reports to Google Cloud Storage bucket {bucket_name} under {prefix}, called {integration_name}.
        slots:
          bucket_name: requestBody.bucket_name
          prefix: requestBody.prefix
          integration_name: requestBody.integration_name
      method: generated
      generated: '2026-10-01'
- target: $.paths['/batch/v4/integrations'].get
  update:
    x-apievangelist-phrasing:
      intent: List configured cloud storage integrations
      effect: read
      questions:
      - Which cloud storage destinations are already set up on my account?
      - What S3 and GCS integrations do we have configured?
      instructions:
      - text: List all cloud storage integrations on my account.
      - text: Show every report delivery integration we've configured.
      method: generated
      generated: '2026-10-01'