Cvent · OpenAPI Overlay 1.0.0

API Evangelist conversational phrasing for Cvent REST Attendee Insights API

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

Generated by API Evangelist Written by API Evangelist tooling for Cvent's API. It is a proposal applied on top of the contract, not a document Cvent 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-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 we set up across events?
      - Can I list attendee insights created after a date?
      instructions:
      - text: List engagement scores matching {filter}.
        slots:
          filter: query.filter
      - text: Show attendee insights created after {after}.
        slots:
          after: query.after
      method: generated
      generated: '2026-09-26'
- target: $.paths['/attendee-insights/{id}'].get
  update:
    x-apievangelist-phrasing:
      intent: Get an engagement score definition
      effect: read
      questions:
      - How is a particular engagement score configured?
      - What event is a given attendee insight tied to?
      instructions:
      - text: Get engagement score {id}.
        slots:
          id: path.id
      - text: Show the setup 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 according to an engagement score?
      - Can I see each attendee's score for an insight?
      instructions:
      - text: List attendee scores for engagement score {id}.
        slots:
          id: path.id
      - text: Show attendee scores on 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
      effect: read
      questions:
      - What is the overall distribution of engagement for an event?
      - Can I get summary stats rather than per-attendee scores?
      instructions:
      - text: Get summary stats for engagement score {id}.
        slots:
          id: path.id
      - text: Summarize how attendees scored on insight {id}.
        slots:
          id: path.id
      method: generated
      generated: '2026-09-26'