GetResponse · OpenAPI Overlay 1.0.0

API Evangelist conversational phrasing for GetResponse APIv3 Custom Reports API

4 actions 4 updates phrasing extends openapi/getresponse-custom-reports-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 4

$.info

$.paths['/custom-reports/{customReportId}'].get

$.paths['/custom-reports'].get

$.paths['/custom-reports'].post

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 GetResponse APIv3 Custom Reports API
  version: 1.0.0
extends: openapi/getresponse-custom-reports-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: 3
- target: $.paths['/custom-reports/{customReportId}'].get
  update:
    x-apievangelist-phrasing:
      intent: Get a custom report's data
      effect: read
      questions:
      - Can I see the results of one scheduled custom report?
      - What data and settings does a specific custom report include?
      instructions:
      - text: Get custom report {report}.
        slots:
          report: path.customReportId
      - text: Show the data from custom report {report}.
        slots:
          report: path.customReportId
      method: generated
      generated: '2026-09-26'
- target: $.paths['/custom-reports'].get
  update:
    x-apievangelist-phrasing:
      intent: List custom reports
      effect: read
      questions:
      - Which custom reports have I scheduled?
      - Can I sort my custom reports by when they were last generated?
      instructions:
      - text: List my custom reports.
      - text: Find custom reports named {name}.
        slots:
          name: query.query[name]
      method: generated
      generated: '2026-09-26'
- target: $.paths['/custom-reports'].post
  update:
    x-apievangelist-phrasing:
      intent: Schedule a custom report
      effect: write
      questions:
      - How do I schedule a recurring report for a specific time period?
      - What report types can I schedule as a custom report?
      instructions:
      - text: Create a custom report {name} of type {type} with schedule {scheduling}.
        slots:
          name: requestBody.name
          type: requestBody.type
          scheduling: requestBody.scheduling
      - text: Schedule report {name} as a {type} report.
        slots:
          name: requestBody.name
          type: requestBody.type
      method: generated
      generated: '2026-09-26'