Northbeam · OpenAPI Overlay 1.0.0

API Evangelist conversational phrasing for DATA EXPORT - V1 Breakdowns API

2 actions 2 updates phrasing extends openapi/northbeam-breakdowns-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 2

$.info

$.paths['/breakdowns'].get

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 DATA EXPORT - V1 Breakdowns API
  version: 1.0.0
extends: openapi/northbeam-breakdowns-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: 1
- target: $.paths['/breakdowns'].get
  update:
    x-apievangelist-phrasing:
      intent: List labels available for breakdowns
      effect: read
      questions:
      - What breakdown labels can I split my Northbeam data by?
      - Which dimensions are available to break down exported results?
      instructions:
      - text: List all labels available for breakdown.
      - text: Show me the breakdown dimensions I can group exported data by.
      method: generated
      generated: '2026-10-01'