lemlist · OpenAPI Overlay 1.0.0

API Evangelist conversational phrasing for lemlist Stats API

3 actions 3 updates phrasing extends openapi/lemlist-stats-api-openapi.yml
Generated by API Evangelist Written by API Evangelist tooling for lemlist's API. It is a proposal applied on top of the contract, not a document lemlist publishes.
View Overlay File View on GitHub Overlay Specification

What the actions change

x-apievangelist-phrasing

Targets 3

$.info
$.paths['/campaigns/{campaignId}/stats'].get
$.paths['/v2/campaigns/{campaignId}/stats'].get

OpenAPI Overlay

Raw ↑ 
# Generated by API Evangelist (build-phrasing.py). Our phrasing, not observed demand.
overlay: 1.0.0
info:
  title: API Evangelist conversational phrasing for lemlist Stats API
  version: 1.0.0
extends: openapi/lemlist-stats-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: 2
- target: $.paths['/campaigns/{campaignId}/stats'].get
  update:
    x-apievangelist-phrasing:
      intent: Get a campaign's stats (original version)
      effect: read
      questions:
      - Can I still get campaign stats from the original v1 endpoint with a timezone?
      - Which legacy call returns a campaign's totals for a date window in my timezone?
      instructions:
      - text: Using the original stats endpoint, get campaign {campaignId} stats from {startDate} to {endDate} in {timezone}.
        slots:
          campaignId: path.campaignId
          startDate: query.startDate
          endDate: query.endDate
          timezone: query.timezone
      - text: Pull legacy v1 stats for campaign {campaignId}.
        slots:
          campaignId: path.campaignId
      method: generated
      generated: '2026-10-01'
- target: $.paths['/v2/campaigns/{campaignId}/stats'].get
  update:
    x-apievangelist-phrasing:
      intent: Get a campaign's stats by channel and A/B version
      effect: read
      questions:
      - How do I break down a campaign's v2 stats by sender or channel?
      - Can I compare A/B versions in the newer campaign stats?
      instructions:
      - text: Get v2 stats for campaign {campaignId} on channels {channels}.
        slots:
          campaignId: path.campaignId
          channels: query.channels
      - text: Show campaign {campaignId} v2 results for sender {sendUser}, version {ABSelected}, {startDate} to {endDate}.
        slots:
          campaignId: path.campaignId
          sendUser: query.sendUser
          ABSelected: query.ABSelected
          startDate: query.startDate
          endDate: query.endDate
      method: generated
      generated: '2026-10-01'