Rybbit · OpenAPI Overlay 1.0.0

API Evangelist conversational phrasing for Rybbit Analytics API

6 actions 6 updates phrasing extends openapi/rybbit-analytics-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 6

$.info

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

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

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

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

$.paths['/api/sites/{site}/journeys'].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 Analytics API
  version: 1.0.0
extends: openapi/rybbit-analytics-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: 5
- target: $.paths['/api/sites/{site}/users'].get
  update:
    x-apievangelist-phrasing:
      intent: List the visitors tracked on a site
      effect: read
      questions:
      - Can I page through every user Rybbit has recorded for one of my sites?
      - Is there a way to narrow my site's user list to visitors from one country or browser?
      - Who are the people visiting my website, one row per user?
      instructions:
      - text: List the users on site {site}.
        slots:
          site: path.site
      - text: Show page {page} of users for site {site}, {limit} per page.
        slots:
          page: query.page
          site: path.site
          limit: query.limit
      - text: List users on site {site} matching the filters {filters}.
        slots:
          site: path.site
          filters: query.filters
      method: generated
      generated: '2026-10-01'
- target: $.paths['/api/sites/{site}/users/{userId}'].get
  update:
    x-apievangelist-phrasing:
      intent: Look up one visitor's profile
      effect: read
      questions:
      - How do I pull up the profile of a single visitor by their user ID?
      - What does my analytics know about one specific user on my site?
      instructions:
      - text: Get user {userId} on site {site}.
        slots:
          userId: path.userId
          site: path.site
      - text: Show me the profile for visitor {userId} of site {site}.
        slots:
          userId: path.userId
          site: path.site
      method: generated
      generated: '2026-10-01'
- target: $.paths['/api/sites/{site}/users/{userId}/sessions'].get
  update:
    x-apievangelist-phrasing:
      intent: List every visit made by one user
      effect: read
      questions:
      - Which visits has one particular user made to my site over time?
      - Can I see the session history belonging to a single known visitor?
      instructions:
      - text: List the sessions belonging to user {userId} on site {site}.
        slots:
          userId: path.userId
          site: path.site
      - text: Show the visit history of user {userId} for site {site}.
        slots:
          userId: path.userId
          site: path.site
      method: generated
      generated: '2026-10-01'
- target: $.paths['/api/sites/{site}/users/session-count'].get
  update:
    x-apievangelist-phrasing:
      intent: Count sessions per user on a site
      effect: read
      questions:
      - How many times has each user come back to my site?
      - Can I get a session tally per visitor, filtered by device or traffic source?
      instructions:
      - text: Get the number of sessions each user has had on site {site}.
        slots:
          site: path.site
      - text: Count sessions per user on site {site} using filters {filters}.
        slots:
          site: path.site
          filters: query.filters
      method: generated
      generated: '2026-10-01'
- target: $.paths['/api/sites/{site}/journeys'].get
  update:
    x-apievangelist-phrasing:
      intent: See common navigation paths through a site
      effect: read
      questions:
      - What paths do visitors usually take from page to page on my site?
      - Which page sequences are most common among mobile visitors?
      - How do I see user journeys through my website in Rybbit?
      instructions:
      - text: Show the most common user journeys on site {site}.
        slots:
          site: path.site
      - text: Get navigation paths for site {site} limited to filters {filters}.
        slots:
          site: path.site
          filters: query.filters
      method: generated
      generated: '2026-10-01'