Impact · OpenAPI Overlay 1.0.0

API Evangelist conversational phrasing for Agency Compliance Content API

4 actions 4 updates phrasing extends openapi/impact-compliance-content-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 4

$.info
$.paths['/Agencies/{AccountSID}/Compliance/Content'].post
$.paths['/Agencies/{AccountSID}/Compliance/Content/ComplianceAPISubmissions/{Id}'].get
$.paths['/Agencies/{AccountSID}/Compliance/Content/ComplianceAPISubmissions/Response/{Id}'].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 Agency Compliance Content API
  version: 1.0.0
extends: openapi/impact-compliance-content-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['/Agencies/{AccountSID}/Compliance/Content'].post
  update:
    x-apievangelist-phrasing:
      intent: Submit content for compliance monitoring
      effect: write
      questions:
      - How can my agency send partner web pages to be checked for brand compliance?
      - Is compliance content processed right away or queued as a job?
      instructions:
      - text: 'Agency {account}: check {url} ({type}) for brand {advertiser}, program {campaign}; context {context}, reason {reason}, source {source}, items {contents}.'
        slots:
          account: path.AccountSID
          url: requestBody.Url
          type: requestBody.Type
          advertiser: requestBody.AdvertiserId
          campaign: requestBody.CampaignId
          context: requestBody.Context
          reason: requestBody.Reason
          source: requestBody.Source
          contents: requestBody.Contents
      - text: Queue compliance review of {contents} for advertiser {advertiser} in agency account {account}.
        slots:
          account: path.AccountSID
          contents: requestBody.Contents
          advertiser: requestBody.AdvertiserId
      method: generated
      generated: '2026-09-26'
- target: $.paths['/Agencies/{AccountSID}/Compliance/Content/ComplianceAPISubmissions/{Id}'].get
  update:
    x-apievangelist-phrasing:
      intent: Check a compliance submission's status
      effect: read
      questions:
      - Has my compliance content submission finished processing?
      - Where do I find the results URI once a compliance job is COMPLETED?
      instructions:
      - text: Check the processing status of compliance submission {id} for agency {account}.
        slots:
          account: path.AccountSID
          id: path.Id
      - text: Is compliance job {id} in account {account} done yet — poll its status.
        slots:
          account: path.AccountSID
          id: path.Id
      method: generated
      generated: '2026-09-26'
- target: $.paths['/Agencies/{AccountSID}/Compliance/Content/ComplianceAPISubmissions/Response/{Id}'].get
  update:
    x-apievangelist-phrasing:
      intent: Get per-item compliance results
      effect: read
      questions:
      - Which items in my compliance submission passed or failed?
      - Can I read the per-item compliance findings for a completed job?
      instructions:
      - text: Get the per-item compliance results for submission {id} in agency account {account}.
        slots:
          account: path.AccountSID
          id: path.Id
      - text: Show findings for completed compliance submission {id}, account {account}.
        slots:
          account: path.AccountSID
          id: path.Id
      method: generated
      generated: '2026-09-26'