Rybbit · OpenAPI Overlay 1.0.0

API Evangelist conversational phrasing for Rybbit Sessions API

5 actions 5 updates phrasing extends openapi/rybbit-sessions-api-openapi.yml

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

View Overlay File View on GitHub Overlay Specification

What the actions change

x-apievangelist-phrasing

Targets 5

$.info

$.paths['/api/sites/{site}/sessions'].get

$.paths['/api/sites/{site}/sessions/{sessionId}'].get

$.paths['/api/sites/{site}/session-locations'].get

$.paths['/api/sites/{site}/retention'].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 Rybbit Sessions API
  version: 1.0.0
extends: openapi/rybbit-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: 4
- target: $.paths['/api/sites/{site}/sessions'].get
  update:
    x-apievangelist-phrasing:
      intent: List sessions on a site
      effect: read
      questions:
      - How do I list all the visits to my site between two dates?
      - Can I show only sessions from identified users, not anonymous ones?
      - What sessions happened on my site last week in my own time zone?
      instructions:
      - text: List sessions on site {site} from {start_date} to {end_date}.
        slots:
          site: path.site
          start_date: query.start_date
          end_date: query.end_date
      - text: Show page {page} of site {site}'s sessions, {limit} at a time, in time zone {time_zone}.
        slots:
          page: query.page
          site: path.site
          limit: query.limit
          time_zone: query.time_zone
      - text: List only identified-user sessions on site {site} where identified_only is {identified_only}.
        slots:
          site: path.site
          identified_only: query.identified_only
      - text: Filter site {site}'s session list by user_id {user_id} and filters {filters}.
        slots:
          site: path.site
          user_id: query.user_id
          filters: query.filters
      method: generated
      generated: '2026-10-01'
- target: $.paths['/api/sites/{site}/sessions/{sessionId}'].get
  update:
    x-apievangelist-phrasing:
      intent: Replay the pageviews and events of one session
      effect: read
      questions:
      - What pages did a visitor view, in order, during one specific session?
      - Can I see the ordered events that happened inside a single visit?
      instructions:
      - text: Get session {sessionId} on site {site}.
        slots:
          sessionId: path.sessionId
          site: path.site
      - text: Show the pageviews and events of session {sessionId} for site {site}.
        slots:
          sessionId: path.sessionId
          site: path.site
      method: generated
      generated: '2026-10-01'
- target: $.paths['/api/sites/{site}/session-locations'].get
  update:
    x-apievangelist-phrasing:
      intent: Map where a site's sessions come from
      effect: read
      questions:
      - Where in the world are my site's visits coming from?
      - Can I get geographic session data to plot on a map?
      instructions:
      - text: List session locations for site {site}.
        slots:
          site: path.site
      - text: Get the geographic spread of sessions on site {site} with filters {filters}.
        slots:
          site: path.site
          filters: query.filters
      method: generated
      generated: '2026-10-01'
- target: $.paths['/api/sites/{site}/retention'].get
  update:
    x-apievangelist-phrasing:
      intent: Analyze cohort retention for a site
      effect: read
      questions:
      - How many visitors come back after their first visit, grouped by cohort?
      - What does retention look like for users who first arrived in a given date range?
      - How do I get a cohort retention table from Rybbit?
      instructions:
      - text: Get cohort retention for site {site}.
        slots:
          site: path.site
      - text: Show retention for site {site} between {start_date} and {end_date}.
        slots:
          site: path.site
          start_date: query.start_date
          end_date: query.end_date
      method: generated
      generated: '2026-10-01'