Outbrain · OpenAPI Overlay 1.0.0

API Evangelist conversational phrasing for Teads Advertiser Conversion Conversions API

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

$.info
$.paths['/capi/event'].post
$.paths['/capi/event/batch'].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 Teads Advertiser Conversion Conversions API
  version: 1.0.0
extends: openapi/outbrain-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: 2
- target: $.paths['/capi/event'].post
  update:
    x-apievangelist-phrasing:
      intent: Send a server-side conversion event
      effect: write
      questions:
      - How do I send a purchase conversion from my backend without a browser pixel?
      - Can I pass an event ID so a server conversion is deduplicated?
      - What fields are required for a single server-side conversion event?
      instructions:
      - text: Send a {event_name} conversion for pixel {pixel_id} that happened at {event_time}.
        slots:
          event_name: requestBody.event_name
          pixel_id: requestBody.pixel_id
          event_time: requestBody.event_time
      - text: Record a lead conversion on pixel {pixel_id} at {event_time} with event ID {event_id}.
        slots:
          pixel_id: requestBody.pixel_id
          event_time: requestBody.event_time
          event_id: requestBody.event_id
      method: generated
      generated: '2026-09-26'
- target: $.paths['/capi/event/batch'].post
  update:
    x-apievangelist-phrasing:
      intent: Send a batch of conversion events
      effect: write
      questions:
      - Can I upload many conversions from my server in one request?
      - What is the maximum number of events per conversion batch?
      instructions:
      - text: 'Send these conversion events as one batch: {events}.'
        slots:
          events: requestBody.events
      - text: Upload yesterday's purchase conversions in a single batch call of up to 1000 events.
      method: generated
      generated: '2026-09-26'