Outbrain · OpenAPI Overlay 1.0.0

API Evangelist conversational phrasing for Outbrain Engage Events API

3 actions 3 updates phrasing extends openapi/outbrain-events-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['/report/impression'].post

$.paths['/report/click'].post

OpenAPI Overlay

# Generated by API Evangelist (build-phrasing.py). Our phrasing, not observed demand.
overlay: 1.0.0
info:
  title: API Evangelist conversational phrasing for Outbrain Engage Events API
  version: 1.0.0
extends: openapi/outbrain-events-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['/report/impression'].post
  update:
    x-apievangelist-phrasing:
      intent: Report a widget impression
      effect: write
      questions:
      - How do I tell Outbrain that my widget displayed a set of recommendations?
      - Can I report impressions for several recommendations in one call?
      instructions:
      - text: Report that widget {widget} under publisher key {publisherKey} showed recommendations {recommendationIds}.
        slots:
          widget: requestBody.widgetJSId
          publisherKey: requestBody.publisherKey
          recommendationIds: requestBody.recommendationIds
      - text: Log an impression for recommendations {recommendationIds} rendered on page {permalink}.
        slots:
          recommendationIds: requestBody.recommendationIds
          permalink: requestBody.permalink
      method: generated
      generated: '2026-09-26'
- target: $.paths['/report/click'].post
  update:
    x-apievangelist-phrasing:
      intent: Report a click on a recommendation
      effect: write
      questions:
      - How do I record that a reader clicked one of the recommended links?
      - What do I need to send when a user clicks a recommendation in my widget?
      instructions:
      - text: Report a click on recommendation {recommendationId} in widget {widget} for publisher key {publisherKey}.
        slots:
          recommendationId: requestBody.recommendationId
          widget: requestBody.widgetJSId
          publisherKey: requestBody.publisherKey
      - text: Record that a user clicked recommendation {recommendationId} on page {permalink}.
        slots:
          recommendationId: requestBody.recommendationId
          permalink: requestBody.permalink
      method: generated
      generated: '2026-09-26'