MoEngage · OpenAPI Overlay 1.0.0

API Evangelist conversational phrasing for MoEngage Segments Filter Segments API

5 actions 5 updates phrasing extends openapi/moengage-filter-segments-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 5

$.info
$.paths['/v3/custom-segments'].get
$.paths['/v3/custom-segments'].post
$.paths['/v3/custom-segments/{id}'].get
$.paths['/v3/custom-segments/{id}'].patch

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 Segments Filter Segments API
  version: 1.0.0
extends: openapi/moengage-filter-segments-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: 4
- target: $.paths['/v3/custom-segments'].get
  update:
    x-apievangelist-phrasing:
      intent: List user segments
      effect: read
      questions:
      - What custom segments exist in my MoEngage workspace?
      - Can I find a segment by its exact name?
      instructions:
      - text: List all my segments.
      - text: Find the segment named exactly {name}.
        slots:
          name: query.name
      method: generated
      generated: '2026-10-01'
- target: $.paths['/v3/custom-segments'].post
  update:
    x-apievangelist-phrasing:
      intent: Create a segment from filter conditions
      effect: write
      questions:
      - How do I create a segment of users who match a set of filters?
      - Can I define a segment by conditions instead of uploading a file?
      instructions:
      - text: Create filter segment {name} with filters {included_filters}.
        slots:
          name: requestBody.name
          included_filters: requestBody.included_filters
      - text: Build a new rule-based segment called {name} using {included_filters}.
        slots:
          name: requestBody.name
          included_filters: requestBody.included_filters
      method: generated
      generated: '2026-10-01'
- target: $.paths['/v3/custom-segments/{id}'].get
  update:
    x-apievangelist-phrasing:
      intent: Get a segment by ID
      effect: read
      questions:
      - How do I look up one segment's details by its ID?
      - Does fetching a segment by ID work for both file and filter segments?
      instructions:
      - text: Get segment {id}.
        slots:
          id: path.id
      - text: Show me the definition of segment {id}.
        slots:
          id: path.id
      method: generated
      generated: '2026-10-01'
- target: $.paths['/v3/custom-segments/{id}'].patch
  update:
    x-apievangelist-phrasing:
      intent: Change a filter segment's conditions
      effect: write
      questions:
      - How do I change the filter conditions of an existing filter segment?
      - Can I rename a filter segment while updating its rules?
      instructions:
      - text: Update filter segment {id} to use filters {included_filters}.
        slots:
          id: path.id
          included_filters: requestBody.included_filters
      - text: Rename segment {id} to {name} with filters {included_filters}.
        slots:
          id: path.id
          name: requestBody.name
          included_filters: requestBody.included_filters
      method: generated
      generated: '2026-10-01'