Ortto · OpenAPI Overlay 1.0.0

API Evangelist conversational phrasing for Ortto Campaigns API

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

What the actions change

x-apievangelist-phrasing

Targets 3

$.info
$.paths['/campaign/calendar'].post
$.paths['/campaign/reports/get'].post

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 Ortto Campaigns API
  version: 1.0.0
extends: openapi/ortto-campaigns-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['/campaign/calendar'].post
  update:
    x-apievangelist-phrasing:
      intent: List campaigns scheduled in a time period
      effect: read
      questions:
      - Which journeys and campaigns are running on my marketing calendar this month?
      - Can I filter the campaign calendar by campaign type, state or folder?
      - Is there a way to search campaigns by name within a date range?
      instructions:
      - text: Show my campaign calendar for {type} campaigns in state {state}.
        slots:
          type: requestBody.type
          state: requestBody.state
      - text: List up to {limit} calendar campaigns in folder {folder_id}.
        slots:
          limit: requestBody.limit
          folder_id: requestBody.folder_id
      - text: Find campaigns on the calendar matching {q}.
        slots:
          q: requestBody.q
      method: generated
      generated: '2026-10-01'
- target: $.paths['/campaign/reports/get'].post
  update:
    x-apievangelist-phrasing:
      intent: Get performance report for a campaign or asset
      effect: read
      questions:
      - How did my email campaign perform in Ortto?
      - Can I pull the report for a single asset instead of the whole campaign?
      - Where do I get open and click results for a specific journey?
      instructions:
      - text: Get the performance report for campaign {campaign_id}.
        slots:
          campaign_id: requestBody.campaign_id
      - text: Pull the report for asset {asset_id} in campaign {campaign_id}.
        slots:
          asset_id: requestBody.asset_id
          campaign_id: requestBody.campaign_id
      method: generated
      generated: '2026-10-01'