Northbeam · OpenAPI Overlay 1.0.0

API Evangelist conversational phrasing for V1 Spend API

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

What the actions change

x-apievangelist-phrasing

Targets 4

$.info
$.paths['/spend'].get
$.paths['/spend'].post
$.paths['/spend'].delete

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 V1 Spend API
  version: 1.0.0
extends: openapi/northbeam-spend-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['/spend'].get
  update:
    x-apievangelist-phrasing:
      intent: List daily spend records
      effect: read
      questions:
      - What ad spend have I recorded for a given day?
      - Can I filter daily spend records by campaign or ad set?
      - How do I page through a large list of daily spend entries?
      instructions:
      - text: List daily spend records from {date_start} to {date_end}.
        slots:
          date_start: query.date_start
          date_end: query.date_end
      - text: Show daily spend for campaign {campaign_id} on {date}.
        slots:
          campaign_id: query.campaign_id
          date: query.date
      - text: Get daily spend for ad {ad_id}, page {page} with {page_size} per page.
        slots:
          ad_id: query.ad_id
          page: query.page
          page_size: query.page_size
      method: generated
      generated: '2026-10-01'
- target: $.paths['/spend'].post
  update:
    x-apievangelist-phrasing:
      intent: Upsert daily spend records
      effect: write
      questions:
      - How do I upload daily ad spend for a platform that isn't connected?
      - Can I update daily spend records I already sent?
      instructions:
      - text: 'Upsert these daily spend records: {data}.'
        slots:
          data: requestBody.data
      - text: Load daily ad spend {data} into the account.
        slots:
          data: requestBody.data
      method: generated
      generated: '2026-10-01'
- target: $.paths['/spend'].delete
  update:
    x-apievangelist-phrasing:
      intent: Delete a daily spend record
      effect: destructive
      questions:
      - How do I remove a daily spend entry I uploaded by mistake?
      - Can I delete a wrong daily spend record?
      instructions:
      - text: Delete the daily spend record {data}.
        slots:
          data: requestBody.data
      - text: Remove the mistaken daily spend entry {data}.
        slots:
          data: requestBody.data
      method: generated
      generated: '2026-10-01'