SimilarWeb · OpenAPI Overlay 1.0.0

API Evangelist conversational phrasing for SimilarWeb Batch Credits API

2 actions 2 updates phrasing extends openapi/similarweb-credits-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['/v3/batch/credits'].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 Batch Credits API
  version: 1.0.0
extends: openapi/similarweb-credits-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['/v3/batch/credits'].get
  update:
    x-apievangelist-phrasing:
      intent: Check remaining data credits
      effect: read
      questions:
      - How many data credits remain on my account?
      - Do I have enough credits left before running another batch job?
      instructions:
      - text: Show my remaining data credits.
      - text: Check the current data credit balance before I request more reports.
      method: generated
      generated: '2026-10-01'