SimilarWeb · OpenAPI Overlay 1.0.0

API Evangelist conversational phrasing for SimilarWeb REST Traffic and Engagement API

3 actions 3 updates phrasing extends openapi/similarweb-traffic-and-engagement-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 3

$.info
$.paths['/v1/website/{domain_name}/traffic-and-engagement/visits'].get
$.paths['/v1/website/{domain_name}/traffic-and-engagement/bounce-rate'].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 REST Traffic and Engagement API
  version: 1.0.0
extends: openapi/similarweb-traffic-and-engagement-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: 2
- target: $.paths['/v1/website/{domain_name}/traffic-and-engagement/visits'].get
  update:
    x-apievangelist-phrasing:
      intent: Get a website's desktop visits over time
      effect: read
      questions:
      - How many desktop visits does a website get each month?
      - Can I see daily desktop visits for a site in a single US state?
      - How far back can I pull a domain's desktop visit history?
      instructions:
      - text: Get desktop visit estimates for {domain_name}.
        slots:
          domain_name: path.domain_name
      - text: Show {granularity} desktop visits for {domain_name} in {country} from {start_date} to {end_date}.
        slots:
          granularity: query.granularity
          domain_name: path.domain_name
          country: query.country
          start_date: query.start_date
          end_date: query.end_date
      method: generated
      generated: '2026-10-01'
- target: $.paths['/v1/website/{domain_name}/traffic-and-engagement/bounce-rate'].get
  update:
    x-apievangelist-phrasing:
      intent: Get a website's desktop bounce rate
      effect: read
      questions:
      - What's the desktop bounce rate for a website?
      - Can I see a domain's bounce rate using its verified Google Analytics data?
      instructions:
      - text: Get the desktop bounce rate trend for {domain_name}.
        slots:
          domain_name: path.domain_name
      - text: Show monthly bounce rate for {domain_name} in {country}.
        slots:
          domain_name: path.domain_name
          country: query.country
      method: generated
      generated: '2026-10-01'