SimilarWeb · OpenAPI Overlay 1.0.0

API Evangelist conversational phrasing for SimilarWeb REST Lead Enrichment API

2 actions 2 updates phrasing extends openapi/similarweb-lead-enrichment-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['/v1/website/{domain_name}/lead-enrichment/all'].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 Lead Enrichment API
  version: 1.0.0
extends: openapi/similarweb-lead-enrichment-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['/v1/website/{domain_name}/lead-enrichment/all'].get
  update:
    x-apievangelist-phrasing:
      intent: Enrich a company domain with firmographics and traffic
      effect: read
      questions:
      - What's the employee range, revenue and headquarters for a company's domain?
      - Can I get firmographics plus web traffic for a prospect in one lookup?
      - Which countries and channels drive a lead's website traffic?
      instructions:
      - text: Enrich the lead {domain_name} with company and traffic data.
        slots:
          domain_name: path.domain_name
      - text: Pull firmographic and web analytics for {domain_name} in {country}.
        slots:
          domain_name: path.domain_name
          country: query.country
      method: generated
      generated: '2026-10-01'