Outbrain · OpenAPI Overlay 1.0.0

API Evangelist conversational phrasing for Outbrain Amplify Multiple Conversions API

6 actions 6 updates phrasing extends openapi/outbrain-multiple-conversions-api-openapi.yml
Generated by API Evangelist Written by API Evangelist tooling for Outbrain's API. It is a proposal applied on top of the contract, not a document Outbrain publishes.
View Overlay File View on GitHub Overlay Specification

What the actions change

x-apievangelist-phrasing

Targets 6

$.info
$.paths['/conversionEvents/{id}'].get
$.paths['/conversionEvents/{id}'].put
$.paths['/marketers/{marketerId}/conversionEvents'].post
$.paths['/marketers/{id}/conversionEvents'].get
$.paths['/marketers/{id}/engagementMetrics'].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 Outbrain Amplify Multiple Conversions API
  version: 1.0.0
extends: openapi/outbrain-multiple-conversions-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: 5
- target: $.paths['/conversionEvents/{id}'].get
  update:
    x-apievangelist-phrasing:
      intent: Retrieve a conversion event definition
      effect: read
      questions:
      - How is one of my conversion events configured?
      - What type and name does a given conversion event have?
      instructions:
      - text: Show conversion event {id}.
        slots:
          id: path.id
      - text: Get the settings for conversion event {id}.
        slots:
          id: path.id
      method: generated
      generated: '2026-09-26'
- target: $.paths['/conversionEvents/{id}'].put
  update:
    x-apievangelist-phrasing:
      intent: Update a conversion event definition
      effect: write
      questions:
      - How do I rename or reconfigure an existing conversion event?
      - Can I change a conversion event after it's been set up?
      instructions:
      - text: Rename conversion event {id} to Checkout Complete.
        slots:
          id: path.id
      - text: Update the configuration of conversion event {id}.
        slots:
          id: path.id
      method: generated
      generated: '2026-09-26'
- target: $.paths['/marketers/{marketerId}/conversionEvents'].post
  update:
    x-apievangelist-phrasing:
      intent: Create a conversion event for a marketer
      effect: write
      questions:
      - How do I define a new conversion event to track sign-ups?
      - Can I set up multiple conversion events on one marketer?
      instructions:
      - text: Create a conversion event named Sign Up for marketer {marketerId}.
        slots:
          marketerId: path.marketerId
      - text: Add a purchase conversion definition to marketer {marketerId}.
        slots:
          marketerId: path.marketerId
      method: generated
      generated: '2026-09-26'
- target: $.paths['/marketers/{id}/conversionEvents'].get
  update:
    x-apievangelist-phrasing:
      intent: List a marketer's conversion events
      effect: read
      questions:
      - Which conversion events are defined on my marketer?
      - Where do I see every conversion event I'm tracking?
      instructions:
      - text: List all conversion events for marketer {id}.
        slots:
          id: path.id
      - text: Show me the names and types of every conversion event on marketer {id}.
        slots:
          id: path.id
      method: generated
      generated: '2026-09-26'
- target: $.paths['/marketers/{id}/engagementMetrics'].get
  update:
    x-apievangelist-phrasing:
      intent: List engagement metrics for bid optimization
      effect: read
      questions:
      - Which Google Analytics engagement metrics can I optimize bids toward?
      - Do I have engagement metrics available for Engagement Bid Strategy?
      instructions:
      - text: List engagement metrics available to marketer {id}.
        slots:
          id: path.id
      - text: Show the EBS optimization metrics from my analytics integration for marketer {id}.
        slots:
          id: path.id
      method: generated
      generated: '2026-09-26'