SimilarWeb · OpenAPI Overlay 1.0.0

API Evangelist conversational phrasing for SimilarWeb REST Similar Sites API

2 actions 2 updates phrasing extends openapi/similarweb-similar-sites-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['/v2/website/{domain_name}/similar-sites'].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 Similar Sites API
  version: 1.0.0
extends: openapi/similarweb-similar-sites-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['/v2/website/{domain_name}/similar-sites'].get
  update:
    x-apievangelist-phrasing:
      intent: Find websites similar to a domain
      effect: read
      questions:
      - What websites are most similar to a given domain?
      - Who are a site's closest lookalikes by similarity score?
      instructions:
      - text: Find sites similar to {domain_name}.
        slots:
          domain_name: path.domain_name
      - text: List the top 40 lookalike websites for {domain_name} with similarity scores.
        slots:
          domain_name: path.domain_name
      method: generated
      generated: '2026-10-01'