Loops · OpenAPI Overlay 1.0.0

API Evangelist conversational phrasing for Loops OpenAPI Spec Audience segments API

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

What the actions change

x-apievangelist-phrasing

Targets 4

$.info
$.paths['/v1/audience-segments/{audienceSegmentId}'].get
$.paths['/v1/audience-segments'].get
$.paths['/v1/audience-segments'].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 Loops OpenAPI Spec Audience segments API
  version: 1.0.0
extends: openapi/loops-audience-segments-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: 3
- target: $.paths['/v1/audience-segments/{audienceSegmentId}'].get
  update:
    x-apievangelist-phrasing:
      intent: Get an audience segment
      effect: read
      questions:
      - How do I look up the details of one audience segment?
      - What filter conditions does a particular segment use?
      instructions:
      - text: Show me audience segment {audienceSegmentId}.
        slots:
          audienceSegmentId: path.audienceSegmentId
      - text: Get the filter behind segment {audienceSegmentId}.
        slots:
          audienceSegmentId: path.audienceSegmentId
      method: generated
      generated: '2026-09-26'
- target: $.paths['/v1/audience-segments'].get
  update:
    x-apievangelist-phrasing:
      intent: List audience segments
      effect: read
      questions:
      - What audience segments have we set up?
      - Can I page through all my segments, newest first?
      instructions:
      - text: List my audience segments.
      - text: Show the next page of segments after cursor {cursor}, {perPage} per page.
        slots:
          cursor: query.cursor
          perPage: query.perPage
      method: generated
      generated: '2026-09-26'
- target: $.paths['/v1/audience-segments'].post
  update:
    x-apievangelist-phrasing:
      intent: Create an audience segment
      effect: write
      questions:
      - How do I create a saved audience segment from filter conditions?
      - Does a new segment name have to be unique?
      instructions:
      - text: Create a segment named {name} using filter {filter}.
        slots:
          name: requestBody.name
          filter: requestBody.filter
      - text: Save a new audience segment {name} described as {description} with conditions {filter}.
        slots:
          name: requestBody.name
          description: requestBody.description
          filter: requestBody.filter
      method: generated
      generated: '2026-09-26'