# 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 Reports API
  version: 1.0.0
extends: openapi/similarweb-reports-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: 6
- target: $.paths['/batch/v4/request-report'].post
  update:
    x-apievangelist-phrasing:
      intent: Submit a batch data report request
      effect: write
      questions:
      - How do I order a bulk data extract delivered to Snowflake or S3?
      - Can I request a batch report with specific tables, metrics and date ranges?
      instructions:
      - text: Submit a batch report for {report_query} delivered via {delivery_information}.
        slots:
          report_query: requestBody.report_query
          delivery_information: requestBody.delivery_information
      - text: Request a download-link report using query {report_query} and delivery {delivery_information}.
        slots:
          report_query: requestBody.report_query
          delivery_information: requestBody.delivery_information
      method: generated
      generated: '2026-10-01'
- target: $.paths['/batch/v4/request-status'].get
  update:
    x-apievangelist-phrasing:
      intent: Check the status of a batch report
      effect: read
      questions:
      - Is my submitted batch report finished yet?
      - What state is a report request in after I submit it?
      instructions:
      - text: Check the status of report {report_id}.
        slots:
          report_id: query.report_id
      - text: Tell me whether batch report {report_id} has completed.
        slots:
          report_id: query.report_id
      method: generated
      generated: '2026-10-01'
- target: $.paths['/batch/v4/request-validate'].post
  update:
    x-apievangelist-phrasing:
      intent: Estimate a batch report's credit cost
      effect: read
      questions:
      - How many credits will a batch report cost before I submit it?
      - Can I check a batch query for errors without running it?
      instructions:
      - text: Validate report query {report_query} with delivery {delivery_information} and estimate its credits.
        slots:
          report_query: requestBody.report_query
          delivery_information: requestBody.delivery_information
      - text: Dry-run {report_query} to see what it would cost.
        slots:
          report_query: requestBody.report_query
      method: generated
      generated: '2026-10-01'
- target: $.paths['/batch/v4/report-history'].get
  update:
    x-apievangelist-phrasing:
      intent: List past batch report requests
      effect: read
      questions:
      - What batch reports have we requested in the past?
      - Can I page through older report requests on the account?
      instructions:
      - text: Show my batch report history.
      - text: List {limit} past report requests starting at {offset}.
        slots:
          limit: query.limit
          offset: query.offset
      method: generated
      generated: '2026-10-01'
- target: $.paths['/batch/v4/retry-request'].post
  update:
    x-apievangelist-phrasing:
      intent: Retry a failed batch report
      effect: write
      questions:
      - How do I rerun a batch report that failed?
      - How many times can a failed report request be retried?
      instructions:
      - text: Retry the failed report {report_id}.
        slots:
          report_id: requestBody.report_id
      - text: Resubmit batch report {report_id} after its failure.
        slots:
          report_id: requestBody.report_id
      method: generated
      generated: '2026-10-01'
- target: $.paths['/batch/v4/tables-describe'].get
  update:
    x-apievangelist-phrasing:
      intent: Describe the tables available for batch reports
      effect: read
      questions:
      - Which tables can I query in a batch report?
      - What metrics, filters and date limits does each batch table support?
      instructions:
      - text: List the queryable batch tables with their metrics and filters.
      - text: Describe the date range constraints for every batch table.
      method: generated
      generated: '2026-10-01'