SimilarWeb · OpenAPI Overlay 1.0.0

API Evangelist conversational phrasing for SimilarWeb REST Account API

3 actions 3 updates phrasing extends openapi/similarweb-account-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['/v3/batch/credits'].get
$.paths['/v1/website/{domain_name}/capabilities'].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 Account API
  version: 1.0.0
extends: openapi/similarweb-account-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['/v3/batch/credits'].get
  update:
    x-apievangelist-phrasing:
      intent: Check remaining data credits
      effect: read
      questions:
      - How many data credits do I have left on my Similarweb account?
      - Am I about to run out of credits for batch data pulls?
      instructions:
      - text: Show my remaining data credit balance.
      - text: Tell me how many batch credits are left on the account.
      method: generated
      generated: '2026-10-01'
- target: $.paths['/v1/website/{domain_name}/capabilities'].get
  update:
    x-apievangelist-phrasing:
      intent: Check what my subscription covers for a site
      effect: read
      questions:
      - What data does my subscription let me pull for a given website?
      - Which capabilities does my plan include when I look up a domain?
      instructions:
      - text: Check what my subscription can access for {domain_name}.
        slots:
          domain_name: path.domain_name
      - text: Show the account capability overview for the domain {domain_name}.
        slots:
          domain_name: path.domain_name
      method: generated
      generated: '2026-10-01'