Listrak · OpenAPI Overlay 1.0.0

API Evangelist conversational phrasing for Listrak Email REST Split Test API

4 actions 4 updates phrasing extends openapi/listrak-split-test-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 4

$.info

$.paths['/v1/List/{listId}/SplitTest'].get

$.paths['/v1/List/{listId}/SplitTest/{splitTestId}'].get

$.paths['/v1/List/{listId}/SplitTest/{splitTestId}/Message'].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 Split Test API
  version: 1.0.0
extends: openapi/listrak-split-test-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: 3
- target: $.paths['/v1/List/{listId}/SplitTest'].get
  update:
    x-apievangelist-phrasing:
      intent: List split tests on a list
      effect: read
      questions:
      - What A/B split tests have I run on a list?
      - Can I see split tests from a certain date range?
      instructions:
      - text: List split tests on list {listId}.
        slots:
          listId: path.listId
      - text: Show split tests on list {listId} between {startDate} and {endDate}.
        slots:
          listId: path.listId
          startDate: query.startDate
          endDate: query.endDate
      method: generated
      generated: '2026-10-01'
- target: $.paths['/v1/List/{listId}/SplitTest/{splitTestId}'].get
  update:
    x-apievangelist-phrasing:
      intent: Get a split test
      effect: read
      questions:
      - How do I look up one A/B split test?
      - What are the settings of a specific split test?
      instructions:
      - text: Get split test {splitTestId} on list {listId}.
        slots:
          splitTestId: path.splitTestId
          listId: path.listId
      - text: Show details of A/B test {splitTestId} from list {listId}.
        slots:
          splitTestId: path.splitTestId
          listId: path.listId
      method: generated
      generated: '2026-10-01'
- target: $.paths['/v1/List/{listId}/SplitTest/{splitTestId}/Message'].get
  update:
    x-apievangelist-phrasing:
      intent: List the variant messages in a split test
      effect: read
      questions:
      - Which message variants were sent in a split test?
      - Can I get each version of the email used in an A/B test?
      instructions:
      - text: List the messages in split test {splitTestId} on list {listId}.
        slots:
          splitTestId: path.splitTestId
          listId: path.listId
      - text: Show each variant email in A/B test {splitTestId}, list {listId}.
        slots:
          splitTestId: path.splitTestId
          listId: path.listId
      method: generated
      generated: '2026-10-01'