Qualified · OpenAPI Overlay 1.0.0

API Evangelist conversational phrasing for Qualified Enterprise Sessions API

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

What the actions change

x-apievangelist-phrasing

Targets 3

$.info
$.paths['/v2/sessions'].get
$.paths['/v2/sessions/{id}'].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 Qualified Enterprise Sessions API
  version: 1.0.0
extends: openapi/qualified-com-sessions-api-openapi.yml
actions:
- target: $.info
  update:
    x-apievangelist-phrasing:
      method: generated
      generated: '2026-10-01'
      generator: build-phrasing.py
      label: Generated by API Evangelist
      operations: 2
- target: $.paths['/v2/sessions'].get
  update:
    x-apievangelist-phrasing:
      intent: List website visitor sessions
      effect: read
      questions:
      - How do I list website sessions that ended in a given time window?
      - Can I see every website visit for one visitor, even before they were identified?
      - What is the delay before a finished session appears in the sessions list?
      instructions:
      - text: List sessions that ended between {ended_after} and {ended_before}.
        slots:
          ended_after: query.ended_after
          ended_before: query.ended_before
      - text: Show all website sessions for visitor {visitor_id}.
        slots:
          visitor_id: query.visitor_id
      method: generated
      generated: '2026-10-01'
- target: $.paths['/v2/sessions/{id}'].get
  update:
    x-apievangelist-phrasing:
      intent: Get one website session by id
      effect: read
      questions:
      - Can I get the latest data for a single website session by id?
      - Does reading one session by id skip the list's 30-minute delay?
      instructions:
      - text: Get session {id}.
        slots:
          id: path.id
      - text: Show the details of website session {id}.
        slots:
          id: path.id
      method: generated
      generated: '2026-10-01'