Gainsight · OpenAPI Overlay 1.0.0

API Evangelist conversational phrasing for Gainsight Custom Events API

4 actions 4 updates phrasing extends openapi/gainsight-custom-events-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 4

$.info

$.paths['/custom_events'].post

$.paths['/v1/events/custom'].get

$.paths['/v1/events/custom'].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 Gainsight Custom Events API
  version: 1.0.0
extends: openapi/gainsight-custom-events-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['/custom_events'].post
  update:
    x-apievangelist-phrasing:
      intent: Track a custom event for a user
      effect: write
      questions:
      - How do I send a custom product event, like 'report exported', for one of my users?
      - Can I attach the page URL and custom attributes to a tracked event?
      instructions:
      - text: Send custom event {eventName} for user {identifyId}.
        slots:
          eventName: requestBody.eventName
          identifyId: requestBody.identifyId
      - text: Track event {eventName} for user {identifyId} on account {accountId} with attributes {attributes}.
        slots:
          eventName: requestBody.eventName
          identifyId: requestBody.identifyId
          accountId: requestBody.accountId
          attributes: requestBody.attributes
      method: generated
      generated: '2026-09-26'
- target: $.paths['/v1/events/custom'].get
  update:
    x-apievangelist-phrasing:
      intent: List custom events
      effect: read
      questions:
      - Which custom events has a given user fired in a date range?
      - Can I filter recorded custom events by event name?
      instructions:
      - text: List custom events matching {filter}.
        slots:
          filter: query.filter
      - text: Show custom events recorded between {dateRangeStart} and {dateRangeEnd}.
        slots:
          dateRangeStart: query.dateRangeStart
          dateRangeEnd: query.dateRangeEnd
      method: generated
      generated: '2026-09-26'
- target: $.paths['/v1/events/custom'].post
  update:
    x-apievangelist-phrasing:
      intent: Record a custom event with the v1 API
      effect: write
      questions:
      - What does the v1 endpoint need to record a custom event with a product key and user type?
      - Can I tie a v1 custom event to a specific session?
      instructions:
      - text: Record v1 custom event {eventName} for user {identifyId} of type {userType} under product {propertyKey}.
        slots:
          eventName: requestBody.eventName
          identifyId: requestBody.identifyId
          userType: requestBody.userType
          propertyKey: requestBody.propertyKey
      - text: Create a v1 custom event {eventName} in session {sessionId} for {identifyId} ({userType}, product {propertyKey}).
        slots:
          eventName: requestBody.eventName
          sessionId: requestBody.sessionId
          identifyId: requestBody.identifyId
          userType: requestBody.userType
          propertyKey: requestBody.propertyKey
      method: generated
      generated: '2026-09-26'