SimilarWeb · OpenAPI Overlay 1.0.0

API Evangelist conversational phrasing for SimilarWeb REST Geography API

2 actions 2 updates phrasing extends openapi/similarweb-geography-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['/v4/website/{domain_name}/geo/traffic-by-country'].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 Geography API
  version: 1.0.0
extends: openapi/similarweb-geography-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['/v4/website/{domain_name}/geo/traffic-by-country'].get
  update:
    x-apievangelist-phrasing:
      intent: See a website's desktop traffic by country
      effect: read
      questions:
      - Which countries send the most desktop traffic to a website?
      - What share of a domain's desktop visits comes from each country?
      - Can I see a site's rank and engagement country by country?
      instructions:
      - text: Break down desktop traffic by country for {domain_name}.
        slots:
          domain_name: path.domain_name
      - text: Show the top {limit} countries for {domain_name} between {start_date} and {end_date}.
        slots:
          limit: query.limit
          domain_name: path.domain_name
          start_date: query.start_date
          end_date: query.end_date
      method: generated
      generated: '2026-10-01'