GetResponse · OpenAPI Overlay 1.0.0

API Evangelist conversational phrasing for GetResponse APIv3 Form and Popup API

2 actions 2 updates phrasing extends openapi/getresponse-form-and-popup-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 2

$.info

$.paths['/statistics/popups/{popupId}/performance'].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 GetResponse APIv3 Form and Popup API
  version: 1.0.0
extends: openapi/getresponse-form-and-popup-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: 1
- target: $.paths['/statistics/popups/{popupId}/performance'].get
  update:
    x-apievangelist-phrasing:
      intent: Get a form or popup's performance
      effect: read
      questions:
      - How is a particular form or popup performing on views and signups?
      - Can I filter popup performance by device or location?
      instructions:
      - text: Show performance stats for popup {popup}.
        slots:
          popup: path.popupId
      - text: Report performance of form {popup} from {from} to {to}.
        slots:
          popup: path.popupId
          from: query.query[date][from]
          to: query.query[date][to]
      - text: Show performance of popup {popup} on {device} devices.
        slots:
          popup: path.popupId
          device: query.query[device]
      method: generated
      generated: '2026-09-26'