Leadping · OpenAPI Overlay 1.0.0

API Evangelist conversational phrasing for Leadping User Data Exports API

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

What the actions change

x-apievangelist-phrasing

Targets 4

$.info
$.paths['/reports/exports/my'].post
$.paths['/reports/exports/{exportId}'].get
$.paths['/reports/exports/{exportId}/download'].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 Leadping User Data Exports API
  version: 1.0.0
extends: openapi/leadping-userdataexports-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: 3
- target: $.paths['/reports/exports/my'].post
  update:
    x-apievangelist-phrasing:
      intent: Request a data export
      effect: write
      questions:
      - How do I get a copy of all my account, lead and event data?
      - Can I request an export of my personal data?
      instructions:
      - text: Request an export of my data.
      - text: Start generating my account data export report.
      method: generated
      generated: '2026-09-26'
- target: $.paths['/reports/exports/{exportId}'].get
  update:
    x-apievangelist-phrasing:
      intent: Check a data export's status
      effect: read
      questions:
      - Is my data export ready to download yet?
      - When does my export expire?
      instructions:
      - text: Check the status of export {exportId}.
        slots:
          exportId: path.exportId
      - text: Tell me if data export {exportId} is ready to download.
        slots:
          exportId: path.exportId
      method: generated
      generated: '2026-09-26'
- target: $.paths['/reports/exports/{exportId}/download'].get
  update:
    x-apievangelist-phrasing:
      intent: Download a data export
      effect: read
      questions:
      - How do I download the file from a finished data export?
      - What do I need besides the export ID to download my report?
      instructions:
      - text: Download export {exportId} using token {token}.
        slots:
          exportId: path.exportId
          token: query.token
      - text: Get the file for data export {exportId} with download token {token}.
        slots:
          exportId: path.exportId
          token: query.token
      method: generated
      generated: '2026-09-26'