Optimizely · OpenAPI Overlay 1.0.0

API Evangelist conversational phrasing for Admin API V1 Telemetry API

3 actions 3 updates phrasing extends openapi/optimizely-telemetry-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['/api/v1/admin/telemetry/track-event'].post

$.paths['/api/v1/admin/telemetry/screen-event'].post

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 Admin API V1 Telemetry API
  version: 1.0.0
extends: openapi/optimizely-telemetry-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['/api/v1/admin/telemetry/track-event'].post
  update:
    x-apievangelist-phrasing:
      intent: Send a custom telemetry event
      effect: write
      questions:
      - How do I record a named usage event from the admin console in telemetry?
      - Can I attach extra properties to a tracked telemetry event?
      instructions:
      - text: Track telemetry event {eventName}.
        slots:
          eventName: requestBody.eventName
      - text: Track event {eventName} with properties {properties}.
        slots:
          eventName: requestBody.eventName
          properties: requestBody.properties
      method: generated
      generated: '2026-09-26'
- target: $.paths['/api/v1/admin/telemetry/screen-event'].post
  update:
    x-apievangelist-phrasing:
      intent: Record a screen view in telemetry
      effect: write
      questions:
      - How do I log that an admin user viewed a particular screen?
      - Can a screen-view telemetry event carry extra properties?
      instructions:
      - text: Record a screen view for {screenName}.
        slots:
          screenName: requestBody.screenName
      - text: Log screen {screenName} as viewed with properties {properties}.
        slots:
          screenName: requestBody.screenName
          properties: requestBody.properties
      method: generated
      generated: '2026-09-26'