Taboola · OpenAPI Overlay 1.0.0

API Evangelist conversational phrasing for Taboola Backstage Reports API

4 actions 4 updates phrasing extends openapi/taboola-reports-api-openapi.yml

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

View Overlay File View on GitHub Overlay Specification

What the actions change

x-apievangelist-phrasing

Targets 4

$.info

$.paths['/{account_id}/reports/campaign-summary/dimensions/{dimension}'].get

$.paths['/{account_id}/reports/top-campaign-content/dimensions/item_breakdown'].get

$.paths['/{account_id}/reports/realtime-ads'].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 Taboola Backstage Reports API
  version: 1.0.0
extends: openapi/taboola-reports-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: 3
- target: $.paths['/{account_id}/reports/campaign-summary/dimensions/{dimension}'].get
  update:
    x-apievangelist-phrasing:
      intent: Get campaign performance by dimension
      effect: read
      questions:
      - How did my campaigns perform day by day last month?
      - Can I break down campaign spend and clicks by country or site?
      - Can I limit the summary report to just one campaign?
      instructions:
      - text: Get the campaign summary for account {account_id} by {dimension} from {start_date} to {end_date}.
        slots:
          dimension: path.dimension
          start_date: query.start_date
          end_date: query.end_date
          account_id: path.account_id
      - text: Show performance for campaign {campaign} by {dimension} between {start_date} and {end_date}.
        slots:
          campaign: query.campaign
          dimension: path.dimension
          start_date: query.start_date
          end_date: query.end_date
      method: generated
      generated: '2026-09-26'
- target: $.paths['/{account_id}/reports/top-campaign-content/dimensions/item_breakdown'].get
  update:
    x-apievangelist-phrasing:
      intent: Get top performing ad items
      effect: read
      questions:
      - Which of my ads performed best over a date range?
      - Can I see a breakdown of top creatives by item?
      instructions:
      - text: Get the top campaign content for account {account_id} from {start_date} to {end_date}.
        slots:
          start_date: query.start_date
          end_date: query.end_date
          account_id: path.account_id
      - text: Show my best performing creatives between {start_date} and {end_date}.
        slots:
          start_date: query.start_date
          end_date: query.end_date
      method: generated
      generated: '2026-09-26'
- target: $.paths['/{account_id}/reports/realtime-ads'].get
  update:
    x-apievangelist-phrasing:
      intent: Get a near real-time ads performance snapshot
      effect: read
      questions:
      - How are my ads performing right now?
      - Is there a near real-time view of ad performance?
      instructions:
      - text: Get the real-time ads report for account {account_id}.
        slots:
          account_id: path.account_id
      - text: Show a live performance snapshot of my ads in {account_id}.
        slots:
          account_id: path.account_id
      method: generated
      generated: '2026-09-26'