MoEngage · OpenAPI Overlay 1.0.0

API Evangelist conversational phrasing for Personalize Experiences API

3 actions 3 updates phrasing extends openapi/moengage-experiences-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 3

$.info
$.paths['/experiences/fetch'].post
$.paths['/experiences/metadata'].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 Personalize Experiences API
  version: 1.0.0
extends: openapi/moengage-experiences-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['/experiences/fetch'].post
  update:
    x-apievangelist-phrasing:
      intent: Get the right experience variation for a user
      effect: read
      questions:
      - How do I fetch which personalization variation a user should see server-side?
      - Can I pass the user's IP address and user agent so targeting rules evaluate correctly?
      instructions:
      - text: Fetch experience {experience_key} for user {identifiers}.
        slots:
          experience_key: requestBody.experience_key
          identifiers: requestBody.identifiers
      - text: Get the variation of {experience_key} for a visitor from IP {USER_IP_ADDRESS}.
        slots:
          experience_key: requestBody.experience_key
          USER_IP_ADDRESS: requestBody.USER_IP_ADDRESS
      method: generated
      generated: '2026-10-01'
- target: $.paths['/experiences/metadata'].get
  update:
    x-apievangelist-phrasing:
      intent: List active, scheduled and paused experiences
      effect: read
      questions:
      - What personalization experiences are currently live in my workspace?
      - Can I list only paused or scheduled experiences?
      instructions:
      - text: List all active experiences.
      - text: Show experiences with status {status}.
        slots:
          status: query.status
      method: generated
      generated: '2026-10-01'