Listrak · OpenAPI Overlay 1.0.0

API Evangelist conversational phrasing for Listrak Email REST Conversation Message Link Clicker API

2 actions 2 updates phrasing extends openapi/listrak-conversationmessagelinkclicker-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}/Conversation/{conversationId}/Message/{conversationMessageId}/Link/{conversationMessageLinkId}/Clicker'].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 Conversation Message Link Clicker API
  version: 1.0.0
extends: openapi/listrak-conversationmessagelinkclicker-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}/Conversation/{conversationId}/Message/{conversationMessageId}/Link/{conversationMessageLinkId}/Clicker'].get
  update:
    x-apievangelist-phrasing:
      intent: List who clicked a conversation message link
      effect: read
      questions:
      - Which contacts clicked a specific link in a conversation message?
      - Can I limit conversation link clickers to a date range?
      instructions:
      - text: List contacts who clicked link {conversationMessageLinkId} in message {conversationMessageId}, conversation {conversationId}, list {listId}.
        slots:
          conversationMessageLinkId: path.conversationMessageLinkId
          conversationMessageId: path.conversationMessageId
          conversationId: path.conversationId
          listId: path.listId
      - text: 'Show clickers of link {conversationMessageLinkId} since {startDate}: message {conversationMessageId}, conversation {conversationId}, list {listId}.'
        slots:
          conversationMessageLinkId: path.conversationMessageLinkId
          conversationMessageId: path.conversationMessageId
          conversationId: path.conversationId
          listId: path.listId
          startDate: query.startDate
      method: generated
      generated: '2026-09-26'