# Generated by API Evangelist (build-phrasing.py). Our phrasing, not observed demand.
overlay: 1.0.0
info:
  title: API Evangelist conversational phrasing for Campaigns Advertisers API
  version: 1.0.0
extends: openapi/mediamath-advertisers-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: 8
- target: $.paths['/advertisers'].get
  update:
    x-apievangelist-phrasing:
      intent: List advertisers
      effect: read
      questions:
      - Which advertisers do I have access to in MediaMath?
      - Can I search advertisers by name and page through the results?
      instructions:
      - text: List all my advertisers.
      - text: Find advertisers matching {q}.
        slots:
          q: query.q
      - text: List advertisers sorted by {sort_by}.
        slots:
          sort_by: query.sort_by
      method: generated
      generated: '2026-10-01'
- target: $.paths['/advertisers'].post
  update:
    x-apievangelist-phrasing:
      intent: Create an advertiser
      effect: write
      questions:
      - How do I set up a new advertiser under my agency?
      - What's needed to create an advertiser account?
      instructions:
      - text: Create a new advertiser.
      - text: Add an advertiser record for a new brand under my agency.
      method: generated
      generated: '2026-10-01'
- target: $.paths['/advertisers/{advertiser_id}'].get
  update:
    x-apievangelist-phrasing:
      intent: Get an advertiser
      effect: read
      questions:
      - How do I look up one advertiser's details by ID?
      - Can I get extended details for a single advertiser?
      instructions:
      - text: Get advertiser {advertiser_id}.
        slots:
          advertiser_id: path.advertiser_id
      - text: Show extended details for advertiser {advertiser_id}.
        slots:
          advertiser_id: path.advertiser_id
      method: generated
      generated: '2026-10-01'
- target: $.paths['/advertisers/{advertiser_id}'].post
  update:
    x-apievangelist-phrasing:
      intent: Update an advertiser
      effect: write
      questions:
      - How do I change an existing advertiser's settings?
      - Can I edit an advertiser after it has been created?
      instructions:
      - text: Update advertiser {advertiser_id}.
        slots:
          advertiser_id: path.advertiser_id
      - text: Change the settings on advertiser {advertiser_id}.
        slots:
          advertiser_id: path.advertiser_id
      method: generated
      generated: '2026-10-01'
- target: $.paths['/advertisers/{advertiser_id}/history'].get
  update:
    x-apievangelist-phrasing:
      intent: View an advertiser's change history
      effect: read
      questions:
      - Who changed this advertiser and when?
      - Is there an audit trail of edits to one advertiser?
      instructions:
      - text: Show the change history for advertiser {advertiser_id}.
        slots:
          advertiser_id: path.advertiser_id
      - text: Get the audit log for advertiser {advertiser_id}.
        slots:
          advertiser_id: path.advertiser_id
      method: generated
      generated: '2026-10-01'
- target: $.paths['/advertisers/{advertiser_id}/pixel_targeting_advertisers'].get
  update:
    x-apievangelist-phrasing:
      intent: List sibling advertisers sharing pixels
      effect: read
      questions:
      - Which sibling advertisers can share pixels when cross-advertiser pixels are enabled?
      - How do I find the advertisers under the same agency allowed for pixel targeting?
      instructions:
      - text: List sibling advertisers available for pixel targeting from advertiser {advertiser_id}.
        slots:
          advertiser_id: path.advertiser_id
      - text: Show cross-advertiser pixel siblings of advertiser {advertiser_id}.
        slots:
          advertiser_id: path.advertiser_id
      method: generated
      generated: '2026-10-01'
- target: $.paths['/advertisers/{advertiser_id}/permissions'].get
  update:
    x-apievangelist-phrasing:
      intent: List user permissions for an advertiser
      effect: read
      questions:
      - Which users have permission to access this advertiser?
      - Can I audit who can see a specific advertiser?
      instructions:
      - text: List the user permissions on advertiser {advertiser_id}.
        slots:
          advertiser_id: path.advertiser_id
      - text: Show which users can access advertiser {advertiser_id}.
        slots:
          advertiser_id: path.advertiser_id
      method: generated
      generated: '2026-10-01'
- target: $.paths['/audit_log/advertisers'].post
  update:
    x-apievangelist-phrasing:
      intent: View change history for several advertisers
      effect: read
      questions:
      - Can I pull the audit log for many advertisers in one request?
      - How do I see recent changes across a batch of advertisers?
      instructions:
      - text: Get the audit log for advertisers {id}.
        slots:
          id: requestBody.id
      - text: Show the change history for advertiser IDs {id} together.
        slots:
          id: requestBody.id
      method: generated
      generated: '2026-10-01'