Cvent Registration · OpenAPI Overlay 1.0.0

API Evangelist conversational phrasing for Cvent REST Attendee Insights API

5 actions 5 updates phrasing extends openapi/cvent-registration-attendee-insights-api-openapi.yml

Generated by API Evangelist Written by API Evangelist tooling for Cvent Registration's API. It is a proposal applied on top of the contract, not a document Cvent Registration publishes.

View Overlay File View on GitHub Overlay Specification

What the actions change

x-apievangelist-phrasing

Targets 5

$.info

$.paths['/attendee-insights'].get

$.paths['/attendee-insights/{id}'].get

$.paths['/attendee-insights/{id}/scores'].get

$.paths['/attendee-insights/{id}/stats'].get

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 Cvent REST Attendee Insights API
  version: 1.0.0
extends: openapi/cvent-registration-attendee-insights-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: 4
- target: $.paths['/attendee-insights'].get
  update:
    x-apievangelist-phrasing:
      intent: List engagement scores
      effect: read
      questions:
      - Which engagement scores have been set up for my events?
      - Where do I find the attendee insight IDs to pull scores?
      instructions:
      - text: List engagement scores and their events.
      - text: List attendee insights matching {filter}.
        slots:
          filter: query.filter
      method: generated
      generated: '2026-09-26'
- target: $.paths['/attendee-insights/{id}'].get
  update:
    x-apievangelist-phrasing:
      intent: Get an engagement score's configuration
      effect: read
      questions:
      - How is a particular engagement score configured?
      - What details does one attendee insight record hold?
      instructions:
      - text: Get engagement score {id}.
        slots:
          id: path.id
      - text: Show the configuration of attendee insight {id}.
        slots:
          id: path.id
      method: generated
      generated: '2026-09-26'
- target: $.paths['/attendee-insights/{id}/scores'].get
  update:
    x-apievangelist-phrasing:
      intent: List attendees' engagement scores
      effect: read
      questions:
      - Which attendees were most engaged at my event?
      - Can I filter attendee scores for one engagement score?
      instructions:
      - text: List each attendee's score for engagement score {id}.
        slots:
          id: path.id
      - text: List attendee scores for insight {id} matching {filter}.
        slots:
          id: path.id
          filter: query.filter
      method: generated
      generated: '2026-09-26'
- target: $.paths['/attendee-insights/{id}/stats'].get
  update:
    x-apievangelist-phrasing:
      intent: Summarize an engagement score's statistics
      effect: read
      questions:
      - What does the overall score distribution look like for an engagement score?
      - Can I get summary stats rather than per-attendee scores?
      instructions:
      - text: Summarize the stats for engagement score {id}.
        slots:
          id: path.id
      - text: Give me the score summary for attendee insight {id}.
        slots:
          id: path.id
      method: generated
      generated: '2026-09-26'