Talon.One · OpenAPI Overlay 1.0.0

API Evangelist conversational phrasing for Management Analytics API

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

What the actions change

x-apievangelist-phrasing

Targets 3

$.info
$.paths['/v1/applications/{applicationId}/export_effects'].get
$.paths['/v1/applications/{applicationId}/export_customer_sessions'].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 Management Analytics API
  version: 1.0.0
extends: openapi/talon-one-analytics-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: 2
- target: $.paths['/v1/applications/{applicationId}/export_effects'].get
  update:
    x-apievangelist-phrasing:
      intent: Export triggered effects to CSV
      effect: read
      questions:
      - Can I download every discount and effect my rules triggered last month?
      - Is it possible to export triggered effects for just one campaign?
      instructions:
      - text: Export the triggered effects of application {applicationId}.
        slots:
          applicationId: path.applicationId
      - text: Download effects triggered by campaign {campaignId} in application {applicationId} after {createdAfter}.
        slots:
          campaignId: query.campaignId
          applicationId: path.applicationId
          createdAfter: query.createdAfter
      method: generated
      generated: '2026-09-26'
- target: $.paths['/v1/applications/{applicationId}/export_customer_sessions'].get
  update:
    x-apievangelist-phrasing:
      intent: Export customer sessions to CSV
      effect: read
      questions:
      - How do I download all closed sessions for analysis?
      - Can archived customer sessions be exported?
      instructions:
      - text: Export customer sessions of application {applicationId}.
        slots:
          applicationId: path.applicationId
      - text: Download sessions in state {customerSessionState} created after {createdAfter} in application {applicationId}.
        slots:
          customerSessionState: query.customerSessionState
          createdAfter: query.createdAfter
          applicationId: path.applicationId
      - text: Export the sessions of customer {profileIntegrationId} in application {applicationId}.
        slots:
          profileIntegrationId: query.profileIntegrationId
          applicationId: path.applicationId
      method: generated
      generated: '2026-09-26'