Gainsight · OpenAPI Overlay 1.0.0

API Evangelist conversational phrasing for Gainsight PX REST Email Event API

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

What the actions change

x-apievangelist-phrasing

Targets 2

$.info
$.paths['/v1/events/email'].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 Gainsight PX REST Email Event API
  version: 1.0.0
extends: openapi/gainsight-emailevent-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: 1
- target: $.paths['/v1/events/email'].get
  update:
    x-apievangelist-phrasing:
      intent: List email events
      effect: read
      questions:
      - Which email opens and clicks were tracked for my users?
      - Can I filter and sort tracked email events?
      instructions:
      - text: List email events matching {filter}.
        slots:
          filter: query.filter
      - text: Show email events sorted by {sort}.
        slots:
          sort: query.sort
      method: generated
      generated: '2026-09-26'