SimilarWeb · OpenAPI Overlay 1.0.0

API Evangelist conversational phrasing for SimilarWeb REST Rankings API

3 actions 3 updates phrasing extends openapi/similarweb-rankings-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}/global-rank/global-rank'].get

$.paths['/v4/rank-tracker/{campaign_id}/reports/overview-report/performanceOverTime'].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 Rankings API
  version: 1.0.0
extends: openapi/similarweb-rankings-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}/global-rank/global-rank'].get
  update:
    x-apievangelist-phrasing:
      intent: Get a website's global rank
      effect: read
      questions:
      - Where does a website rank globally across desktop and mobile?
      - How has a domain's global rank changed month to month?
      instructions:
      - text: Get the global rank for {domain_name}.
        slots:
          domain_name: path.domain_name
      - text: Show the global rank of {domain_name} from {start_date} to {end_date}.
        slots:
          domain_name: path.domain_name
          start_date: query.start_date
          end_date: query.end_date
      method: generated
      generated: '2026-10-01'
- target: $.paths['/v4/rank-tracker/{campaign_id}/reports/overview-report/performanceOverTime'].get
  update:
    x-apievangelist-phrasing:
      intent: Review a rank tracking campaign's performance
      effect: read
      questions:
      - How is my rank tracking campaign's average position trending?
      - Can I see visibility and SERP feature coverage for a tracked campaign on mobile only?
      instructions:
      - text: Show the performance overview for rank tracking campaign {campaign_id}.
        slots:
          campaign_id: path.campaign_id
      - text: Report average position and visibility for campaign {campaign_id} on {device} for site {site}.
        slots:
          campaign_id: path.campaign_id
          device: query.device
          site: query.site
      method: generated
      generated: '2026-10-01'