SimilarWeb · OpenAPI Overlay 1.0.0

API Evangelist conversational phrasing for SimilarWeb REST Keywords API

2 actions 2 updates phrasing extends openapi/similarweb-keywords-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-analysis/keywords'].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 Keywords API
  version: 1.0.0
extends: openapi/similarweb-keywords-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-analysis/keywords'].get
  update:
    x-apievangelist-phrasing:
      intent: Get the keywords driving traffic to a website
      effect: read
      questions:
      - Which search keywords send the most traffic to a competitor's site?
      - Can I see only non-branded paid keywords for a domain?
      - What CPC and difficulty do a website's top keywords have?
      instructions:
      - text: List the top keywords for {URL}.
        slots:
          URL: query.URL
      - text: Show {branded_type} keywords for {URL} in {country}, limited to {limit}.
        slots:
          branded_type: query.branded_type
          URL: query.URL
          country: query.country
          limit: query.limit
      method: generated
      generated: '2026-10-01'