Sendcloud · OpenAPI Overlay 1.0.0

API Evangelist conversational phrasing for Analytics Products API

3 actions 3 updates phrasing extends openapi/sendcloud-products-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['/insights/products/series'].get
$.paths['/insights/products/buckets'].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 Analytics Products API
  version: 1.0.0
extends: openapi/sendcloud-products-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['/insights/products/series'].get
  update:
    x-apievangelist-phrasing:
      intent: Chart shipped product volume over time
      effect: read
      questions:
      - How many products did I ship per week this quarter?
      - Can I see shipped quantities of one SKU over time?
      instructions:
      - text: Show product counts per {granularity} from {start_date} to {end_date}.
        slots:
          granularity: query.granularity
          start_date: query.start_date
          end_date: query.end_date
      - text: Chart SKU {product_sku} shipped per {granularity} between {start_date} and {end_date}.
        slots:
          product_sku: query.product_sku
          granularity: query.granularity
          start_date: query.start_date
          end_date: query.end_date
      method: generated
      generated: '2026-10-01'
- target: $.paths['/insights/products/buckets'].get
  update:
    x-apievangelist-phrasing:
      intent: Group shipped products by a category
      effect: read
      questions:
      - Which products do I ship most to each country?
      - Can I break down shipped products by destination for a period?
      instructions:
      - text: Group shipped products from {start_date} to {end_date} by {group_by}.
        slots:
          start_date: query.start_date
          end_date: query.end_date
          group_by: query.group_by
      - text: Show the top {size} product buckets by {group_by} between {start_date} and {end_date}.
        slots:
          size: query.size
          group_by: query.group_by
          start_date: query.start_date
          end_date: query.end_date
      method: generated
      generated: '2026-10-01'