MoEngage · OpenAPI Overlay 1.0.0

API Evangelist conversational phrasing for Moengage Get Campaign Details API

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

What the actions change

x-apievangelist-phrasing

Targets 7

$.info
$.paths['/v5/campaigns/{campaign_id}'].get
$.paths['/v5/campaigns/search'].post
$.paths['/v5/campaigns/meta'].post
$.paths['/campaigns/search'].post
$.paths['/campaigns/meta'].post
$.paths['/campaigns/{parent_campaign_id}/executions'].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 Moengage Get Campaign Details API
  version: 1.0.0
extends: openapi/moengage-get-campaign-details-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: 6
- target: $.paths['/v5/campaigns/{campaign_id}'].get
  update:
    x-apievangelist-phrasing:
      intent: Get one campaign's configuration (V5)
      effect: read
      questions:
      - How do I get the full configuration and current status of a single campaign?
      - What's the status of one specific campaign right now?
      instructions:
      - text: Get campaign {campaign_id}.
        slots:
          campaign_id: path.campaign_id
      - text: Show the full V5 setup of campaign {campaign_id}.
        slots:
          campaign_id: path.campaign_id
      method: generated
      generated: '2026-10-01'
- target: $.paths['/v5/campaigns/search'].post
  update:
    x-apievangelist-phrasing:
      intent: Search campaigns with full payloads (V5)
      effect: read
      questions:
      - How do I search campaigns by channel, status or tag and get their full V5 details?
      - Can I include archived and child campaigns in a V5 campaign search?
      instructions:
      - text: Search V5 campaigns, page {page}, {limit} per page.
        slots:
          page: requestBody.page
          limit: requestBody.limit
      - text: Find V5 campaigns matching {campaign_fields}, archived included, page {page} limit {limit}.
        slots:
          campaign_fields: requestBody.campaign_fields
          page: requestBody.page
          limit: requestBody.limit
      method: generated
      generated: '2026-10-01'
- target: $.paths['/v5/campaigns/meta'].post
  update:
    x-apievangelist-phrasing:
      intent: Get lightweight campaign metadata (V5)
      effect: read
      questions:
      - Can I get just summary metadata for campaigns without their full configuration?
      - What's the fastest V5 way to list basic info for many campaigns?
      instructions:
      - text: Get V5 campaign metadata, page {page} with {limit} results.
        slots:
          page: requestBody.page
          limit: requestBody.limit
      - text: Fetch lightweight V5 meta for campaigns matching {campaign_fields}, page {page} limit {limit}.
        slots:
          campaign_fields: requestBody.campaign_fields
          page: requestBody.page
          limit: requestBody.limit
      method: generated
      generated: '2026-10-01'
- target: $.paths['/campaigns/search'].post
  update:
    x-apievangelist-phrasing:
      intent: Search Push, Email or SMS campaigns (legacy)
      effect: read
      questions:
      - How do I search SMS campaigns along with Push and Email on the older search endpoint?
      - Can the legacy campaign search filter by several fields at once?
      instructions:
      - text: Search legacy campaigns with request {request_id}, page {page}, limit {limit}.
        slots:
          request_id: requestBody.request_id
          page: requestBody.page
          limit: requestBody.limit
      - text: Find SMS campaigns matching {campaign_fields} using request {request_id}, page {page} limit {limit}.
        slots:
          campaign_fields: requestBody.campaign_fields
          request_id: requestBody.request_id
          page: requestBody.page
          limit: requestBody.limit
      method: generated
      generated: '2026-10-01'
- target: $.paths['/campaigns/meta'].post
  update:
    x-apievangelist-phrasing:
      intent: Get scheduled campaign reachability (legacy)
      effect: read
      questions:
      - How do I see reachability for my scheduled campaigns?
      - Which legacy endpoint gives campaign meta with reachability info?
      instructions:
      - text: Get legacy meta and reachability for scheduled campaigns, request {request_id}, page {page}, limit {limit}.
        slots:
          request_id: requestBody.request_id
          page: requestBody.page
          limit: requestBody.limit
      - text: Show reachability for scheduled campaigns matching {campaign_fields} with request {request_id}, page {page} limit {limit}.
        slots:
          campaign_fields: requestBody.campaign_fields
          request_id: requestBody.request_id
          page: requestBody.page
          limit: requestBody.limit
      method: generated
      generated: '2026-10-01'
- target: $.paths['/campaigns/{parent_campaign_id}/executions'].post
  update:
    x-apievangelist-phrasing:
      intent: List executions of a recurring campaign
      effect: read
      questions:
      - How do I see each run of a periodic campaign?
      - Can I track the child executions of a business event-triggered campaign?
      instructions:
      - text: List child executions of campaign {parent_campaign_id}, request {request_id}, page {page} limit {limit}.
        slots:
          parent_campaign_id: path.parent_campaign_id
          request_id: requestBody.request_id
          page: requestBody.page
          limit: requestBody.limit
      - text: Show the run history of periodic campaign {parent_campaign_id}.
        slots:
          parent_campaign_id: path.parent_campaign_id
      method: generated
      generated: '2026-10-01'