Postmark · OpenAPI Overlay 1.0.0

API Evangelist conversational phrasing for Postmark Locations API

2 actions 2 updates phrasing extends openapi/postmark-locations-api-openapi.yml

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

View Overlay File View on GitHub Overlay Specification

What the actions change

x-apievangelist-phrasing

Targets 2

$.info

$.paths['/stats/outbound/clicks/location'].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 Postmark Locations API
  version: 1.0.0
extends: openapi/postmark-locations-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: 1
- target: $.paths['/stats/outbound/clicks/location'].get
  update:
    x-apievangelist-phrasing:
      intent: Compare clicks in HTML versus text parts
      effect: read
      questions:
      - Are recipients clicking links in the HTML part or the plain text part of my emails?
      - Which body location gets more clicks for a given tag?
      instructions:
      - text: Show clicks by HTML versus text body location since {fromdate}.
        slots:
          fromdate: query.fromdate
      - text: Compare where in the email body links were clicked for tag {tag}.
        slots:
          tag: query.tag
      method: generated
      generated: '2026-10-01'