Facebook Business Manager · OpenAPI Overlay 1.0.0

API Evangelist conversational phrasing for Facebook Business Manager Facebook Marketing Insights API

3 actions 3 updates phrasing extends openapi/facebook-business-manager-insights-api-openapi.yml

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

View Overlay File View on GitHub Overlay Specification

What the actions change

x-apievangelist-phrasing

Targets 3

$.info

$.paths['/act_{ad_account_id}/insights'].get

$.paths['/{campaign_id}/insights'].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 Facebook Business Manager Facebook Marketing Insights API
  version: 1.0.0
extends: openapi/facebook-business-manager-insights-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: 2
- target: $.paths['/act_{ad_account_id}/insights'].get
  update:
    x-apievangelist-phrasing:
      intent: Report ad performance across an ad account
      effect: read
      questions:
      - How is my whole ad account performing this month?
      - Can I break down account-wide ad results by age, gender or country?
      - Is it possible to roll account performance up by campaign, ad set or ad level?
      instructions:
      - text: Get performance insights for ad account {ad_account_id} between {time_range}.
        slots:
          ad_account_id: path.ad_account_id
          time_range: query.time_range
      - text: Break down ad account {ad_account_id} results by {breakdowns} at the {level} level.
        slots:
          ad_account_id: path.ad_account_id
          breakdowns: query.breakdowns
          level: query.level
      - text: Show daily account results for {ad_account_id} in increments of {time_increment}.
        slots:
          ad_account_id: path.ad_account_id
          time_increment: query.time_increment
      method: generated
      generated: '2026-10-01'
- target: $.paths['/{campaign_id}/insights'].get
  update:
    x-apievangelist-phrasing:
      intent: Report one campaign's performance
      effect: read
      questions:
      - How many clicks and how much spend has a single campaign generated?
      - Can I see one campaign's conversions for a specific date range?
      instructions:
      - text: Show performance for campaign {campaign_id}.
        slots:
          campaign_id: path.campaign_id
      - text: Get impressions, clicks and spend for campaign {campaign_id} over {time_range}.
        slots:
          campaign_id: path.campaign_id
          time_range: query.time_range
      method: generated
      generated: '2026-10-01'