Impact · OpenAPI Overlay 1.0.0

API Evangelist conversational phrasing for Brand API - Actions Action Updates API

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

What the actions change

x-apievangelist-phrasing

Targets 3

$.info
$.paths['/Advertisers/{AccountSID}/ActionUpdates'].get
$.paths['/Advertisers/{AccountSID}/ActionUpdates/{ActionUpdateId}'].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 Brand API - Actions Action Updates API
  version: 1.0.0
extends: openapi/impact-action-updates-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['/Advertisers/{AccountSID}/ActionUpdates'].get
  update:
    x-apievangelist-phrasing:
      intent: List the changelog of a brand's actions
      effect: read
      questions:
      - Which actions in my program changed state or amount recently?
      - Is there a maximum date range when listing action updates?
      instructions:
      - text: List action updates for program {campaign} in account {account} from {start} to {end}.
        slots:
          account: path.AccountSID
          campaign: query.CampaignId
          start: query.StartDate
          end: query.EndDate
      - text: Show action changes in program {campaign}, account {account}, with state {state}.
        slots:
          account: path.AccountSID
          campaign: query.CampaignId
          state: query.State
      method: generated
      generated: '2026-09-26'
- target: $.paths['/Advertisers/{AccountSID}/ActionUpdates/{ActionUpdateId}'].get
  update:
    x-apievangelist-phrasing:
      intent: Get one action update record
      effect: read
      questions:
      - What exactly changed in one specific action update?
      - Can I retrieve an action update by its ID?
      instructions:
      - text: Get action update {update} in account {account}.
        slots:
          account: path.AccountSID
          update: path.ActionUpdateId
      - text: Show the change recorded in action update {update}, account {account}.
        slots:
          account: path.AccountSID
          update: path.ActionUpdateId
      method: generated
      generated: '2026-09-26'