Optimizely · OpenAPI Overlay 1.0.0

API Evangelist conversational phrasing for Optimizely Impressions Usage API

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

What the actions change

x-apievangelist-phrasing

Targets 3

$.info
$.paths['/billing/usage/{account_id}'].get
$.paths['/billing/usage/{account_id}/summary'].get

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 Optimizely Impressions Usage API
  version: 1.0.0
extends: openapi/optimizely-impressions-usage-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: 2
- target: $.paths['/billing/usage/{account_id}'].get
  update:
    x-apievangelist-phrasing:
      intent: Get impressions usage for a date range
      effect: read
      questions:
      - How many impressions has my account used between two dates?
      - Can I break impressions usage down by platform or search it by experiment or project?
      - What impressions did each experiment consume this billing period?
      instructions:
      - text: Get impressions usage for account {account_id} from {usage_date_from} to {usage_date_to}.
        slots:
          account_id: path.account_id
          usage_date_from: query.usage_date_from
          usage_date_to: query.usage_date_to
      - text: Show impressions usage on account {account_id} between {usage_date_from} and {usage_date_to} for platform {platforms}.
        slots:
          account_id: path.account_id
          usage_date_from: query.usage_date_from
          usage_date_to: query.usage_date_to
          platforms: query.platforms
      - text: Find usage for {query} on account {account_id} from {usage_date_from} to {usage_date_to}.
        slots:
          query: query.query
          account_id: path.account_id
          usage_date_from: query.usage_date_from
          usage_date_to: query.usage_date_to
      method: generated
      generated: '2026-09-26'
- target: $.paths['/billing/usage/{account_id}/summary'].get
  update:
    x-apievangelist-phrasing:
      intent: Get an impressions usage summary
      effect: read
      questions:
      - What is my account's overall impressions usage summary?
      - Am I close to my impressions allowance in total?
      instructions:
      - text: Summarize impressions usage for account {account_id}.
        slots:
          account_id: path.account_id
      - text: Give me the impressions usage totals for account {account_id}.
        slots:
          account_id: path.account_id
      method: generated
      generated: '2026-09-26'