Rybbit · OpenAPI Overlay 1.0.0

API Evangelist conversational phrasing for Rybbit Event Tracking API

2 actions 2 updates phrasing extends openapi/rybbit-event-tracking-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 2

$.info
$.paths['/api/track'].post

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 Rybbit Event Tracking API
  version: 1.0.0
extends: openapi/rybbit-event-tracking-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: 1
- target: $.paths['/api/track'].post
  update:
    x-apievangelist-phrasing:
      intent: Record a pageview or custom event
      effect: write
      questions:
      - How do I send a pageview to Rybbit from my server instead of the tracking script?
      - Can I record a custom event with my own properties attached?
      - Do I need an API key just to send tracking events?
      instructions:
      - text: Record a {type} event for site {site_id}.
        slots:
          type: requestBody.type
          site_id: requestBody.site_id
      - text: Track a pageview of {pathname} on {hostname} for site {site_id} with type {type}.
        slots:
          pathname: requestBody.pathname
          hostname: requestBody.hostname
          site_id: requestBody.site_id
          type: requestBody.type
      - text: Send custom event {event_name} with properties {properties} to site {site_id} as type {type}.
        slots:
          event_name: requestBody.event_name
          properties: requestBody.properties
          site_id: requestBody.site_id
          type: requestBody.type
      method: generated
      generated: '2026-10-01'