Scope3 · OpenAPI Overlay 1.0.0

API Evangelist conversational phrasing for Scope3 Buyer Event Sources API

4 actions 4 updates phrasing extends openapi/scope3-event-sources-api-openapi.yml

Generated by API Evangelist Written by API Evangelist tooling for Scope3's API. It is a proposal applied on top of the contract, not a document Scope3 publishes.

View Overlay File View on GitHub Overlay Specification

What the actions change

x-apievangelist-phrasing

Targets 4

$.info

$.paths['/advertisers/{advertiserId}/event-sources'].get

$.paths['/advertisers/{advertiserId}/event-sources/sync'].post

$.paths['/advertisers/{advertiserId}/log-event'].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 Scope3 Buyer Event Sources API
  version: 1.0.0
extends: openapi/scope3-event-sources-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: 3
- target: $.paths['/advertisers/{advertiserId}/event-sources'].get
  update:
    x-apievangelist-phrasing:
      intent: List an advertiser's conversion event sources
      effect: read
      questions:
      - Which conversion data pipelines are set up for an advertiser?
      - What event sources can my optimization goals reference?
      instructions:
      - text: List event sources for advertiser {advertiser_id}.
        slots:
          advertiser_id: path.advertiserId
      - text: Show the next {take} event sources for advertiser {advertiser_id}, skipping {skip}.
        slots:
          take: query.take
          advertiser_id: path.advertiserId
          skip: query.skip
      method: generated
      generated: '2026-10-01'
- target: $.paths['/advertisers/{advertiserId}/event-sources/sync'].post
  update:
    x-apievangelist-phrasing:
      intent: Sync event source configurations to an advertiser
      effect: write
      questions:
      - How do I push my event source configuration to an advertiser?
      - Can a sync remove event sources I left out of the request?
      instructions:
      - text: Sync event sources {event_sources} for account {account} to advertiser {advertiser_id}.
        slots:
          event_sources: requestBody.event_sources
          account: requestBody.account
          advertiser_id: path.advertiserId
      - text: Replace advertiser {advertiser_id}'s event sources with {event_sources} for account {account}, deleting missing ones ({delete_missing}).
        slots:
          advertiser_id: path.advertiserId
          event_sources: requestBody.event_sources
          account: requestBody.account
          delete_missing: requestBody.delete_missing
      method: generated
      generated: '2026-10-01'
- target: $.paths['/advertisers/{advertiserId}/log-event'].post
  update:
    x-apievangelist-phrasing:
      intent: Log conversion events for an advertiser
      effect: write
      questions:
      - How many conversion events can I send in a single call?
      - Can I send test conversion events without them counting as real ones?
      instructions:
      - text: Log these conversion events {events} to event source {event_source_id} for advertiser {advertiser_id}.
        slots:
          events: requestBody.events
          event_source_id: requestBody.event_source_id
          advertiser_id: path.advertiserId
      - text: Send test events {events} to source {event_source_id} for advertiser {advertiser_id} with test code {test_code}.
        slots:
          events: requestBody.events
          event_source_id: requestBody.event_source_id
          advertiser_id: path.advertiserId
          test_code: requestBody.test_event_code
      method: generated
      generated: '2026-10-01'