SimilarWeb · OpenAPI Overlay 1.0.0

API Evangelist conversational phrasing for SimilarWeb REST Traffic Sources API

2 actions 2 updates phrasing extends openapi/similarweb-traffic-sources-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 2

$.info

$.paths['/v1/website/{domain_name}/traffic-sources/overview-share'].get

OpenAPI Overlay

# Generated by API Evangelist (build-phrasing.py). Our phrasing, not observed demand.
overlay: 1.0.0
info:
  title: API Evangelist conversational phrasing for SimilarWeb REST Traffic Sources API
  version: 1.0.0
extends: openapi/similarweb-traffic-sources-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: 1
- target: $.paths['/v1/website/{domain_name}/traffic-sources/overview-share'].get
  update:
    x-apievangelist-phrasing:
      intent: Break down a site's desktop visits by channel
      effect: read
      questions:
      - 'Where does a website''s desktop traffic come from: search, social, direct or referrals?'
      - How much of a domain's search traffic is organic versus paid?
      instructions:
      - text: Break down desktop visits by marketing channel for {domain_name}.
        slots:
          domain_name: path.domain_name
      - text: Show the channel mix for {domain_name} in {country} between {start_date} and {end_date}.
        slots:
          domain_name: path.domain_name
          country: query.country
          start_date: query.start_date
          end_date: query.end_date
      method: generated
      generated: '2026-10-01'