GetResponse · OpenAPI Overlay 1.0.0

API Evangelist conversational phrasing for GetResponse APIv3 Ecommerce API

3 actions 3 updates phrasing extends openapi/getresponse-ecommerce-api-openapi.yml
Generated by API Evangelist Written by API Evangelist tooling for GetResponse's API. It is a proposal applied on top of the contract, not a document GetResponse publishes.
View Overlay File View on GitHub Overlay Specification

What the actions change

x-apievangelist-phrasing

Targets 3

$.info
$.paths['/statistics/ecommerce/revenue'].get
$.paths['/statistics/ecommerce/performance'].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 GetResponse APIv3 Ecommerce API
  version: 1.0.0
extends: openapi/getresponse-ecommerce-api-openapi.yml
actions:
- target: $.info
  update:
    x-apievangelist-phrasing:
      method: generated
      generated: '2026-09-26'
      generator: build-phrasing.py
      label: Generated by API Evangelist
      operations: 2
- target: $.paths['/statistics/ecommerce/revenue'].get
  update:
    x-apievangelist-phrasing:
      intent: Get ecommerce revenue statistics
      effect: read
      questions:
      - How much revenue did my shops generate from email marketing?
      - Can I see revenue for one shop over a set order date range?
      instructions:
      - text: Show ecommerce revenue for shop {shop}.
        slots:
          shop: query.query[shopId]
      - text: Report revenue for orders between {from} and {to}.
        slots:
          from: query.query[orderDate][from]
          to: query.query[orderDate][to]
      method: generated
      generated: '2026-09-26'
- target: $.paths['/statistics/ecommerce/performance'].get
  update:
    x-apievangelist-phrasing:
      intent: Get ecommerce performance statistics
      effect: read
      questions:
      - What are my overall ecommerce performance metrics like orders and conversions?
      - Which performance numbers can I get for one shop and date range?
      instructions:
      - text: Show general ecommerce performance for shop {shop}.
        slots:
          shop: query.query[shopId]
      - text: Report ecommerce performance for orders from {from} to {to}.
        slots:
          from: query.query[orderDate][from]
          to: query.query[orderDate][to]
      method: generated
      generated: '2026-09-26'