Listrak · OpenAPI Overlay 1.0.0

API Evangelist conversational phrasing for Listrak Email REST Transactional Message Activity API

2 actions 2 updates phrasing extends openapi/listrak-transactionalmessageactivity-api-openapi.yml

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

View Overlay File View on GitHub Overlay Specification

What the actions change

x-apievangelist-phrasing

Targets 2

$.info

$.paths['/v1/List/{listId}/TransactionalMessage/{transactionalMessageId}/Activity'].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 Listrak Email REST Transactional Message Activity API
  version: 1.0.0
extends: openapi/listrak-transactionalmessageactivity-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['/v1/List/{listId}/TransactionalMessage/{transactionalMessageId}/Activity'].get
  update:
    x-apievangelist-phrasing:
      intent: Get activity for a transactional email
      effect: read
      questions:
      - Did a customer open or click a transactional email I sent them?
      - Can I filter transactional email activity by type or date?
      instructions:
      - text: Get activity for transactional email {transactionalMessageId} on list {listId}.
        slots:
          transactionalMessageId: path.transactionalMessageId
          listId: path.listId
      - text: Show what {emailAddress} did with transactional email {transactionalMessageId} on list {listId}.
        slots:
          emailAddress: query.emailAddress
          transactionalMessageId: path.transactionalMessageId
          listId: path.listId
      method: generated
      generated: '2026-09-26'