Sendcloud · OpenAPI Overlay 1.0.0

API Evangelist conversational phrasing for Analytics API

3 actions 3 updates phrasing extends openapi/sendcloud-analytics-api-openapi.yml

Generated by API Evangelist Written by API Evangelist tooling for Sendcloud's API. It is a proposal applied on top of the contract, not a document Sendcloud publishes.

View Overlay File View on GitHub Overlay Specification

What the actions change

x-apievangelist-phrasing

Targets 3

$.info

$.paths['/analytics/transit-times/carriers'].get

$.paths['/analytics/transit-times/shipping-options'].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 Analytics API
  version: 1.0.0
extends: openapi/sendcloud-analytics-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['/analytics/transit-times/carriers'].get
  update:
    x-apievangelist-phrasing:
      intent: Get transit-time statistics for a carrier
      effect: read
      questions:
      - How long does a carrier typically take to deliver my parcels?
      - Can I see a carrier's average transit time between two countries over a date range?
      instructions:
      - text: Show transit-time stats for carrier {carrier_code}.
        slots:
          carrier_code: query.carrier_code
      - text: Get transit times for carrier {carrier_code} from {from_country_code} to {to_country_code}.
        slots:
          carrier_code: query.carrier_code
          from_country_code: query.from_country_code
          to_country_code: query.to_country_code
      method: generated
      generated: '2026-10-01'
- target: $.paths['/analytics/transit-times/shipping-options'].get
  update:
    x-apievangelist-phrasing:
      intent: Get transit-time statistics for a shipping option
      effect: read
      questions:
      - How fast is a specific shipping option delivering compared to what I expected?
      - What are the aggregated transit times for one shipping option since a given date?
      instructions:
      - text: Show transit-time stats for shipping option {shipping_option_code}.
        slots:
          shipping_option_code: query.shipping_option_code
      - text: Get transit times for shipping option {shipping_option_code} between {start_date} and {end_date}.
        slots:
          shipping_option_code: query.shipping_option_code
          start_date: query.start_date
          end_date: query.end_date
      method: generated
      generated: '2026-10-01'