Sentry · OpenAPI Overlay 1.0.0

API Evangelist conversational phrasing for Sentry Replays Interactions API

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

What the actions change

x-apievangelist-phrasing

Targets 3

$.info
$.paths['/organizations/{organization_id_or_slug}/replays/selectors/'].get
$.paths['/organizations/{organization_id_or_slug}/replays/{replay_id}/clicks/'].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 Sentry Replays Interactions API
  version: 1.0.0
extends: openapi/sentry-system-interactions-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: 2
- target: $.paths['/organizations/{organization_id_or_slug}/replays/selectors/'].get
  update:
    x-apievangelist-phrasing:
      intent: List DOM selectors seen in replays
      effect: read
      questions:
      - Which page elements do users click on most across replays?
      - Can I see tracked DOM selectors for one project over the last week?
      instructions:
      - text: List DOM selectors tracked across replays in {org}.
        slots:
          org: path.organization_id_or_slug
      - text: Show selectors for project {project} over {statsPeriod}.
        slots:
          project: query.project
          statsPeriod: query.statsPeriod
      method: generated
      generated: '2026-09-26'
- target: $.paths['/organizations/{organization_id_or_slug}/replays/{replay_id}/clicks/'].get
  update:
    x-apievangelist-phrasing:
      intent: List nodes clicked in a replay
      effect: read
      questions:
      - What did a user click on during a session replay?
      - Can I get the clicked DOM nodes for one recording?
      instructions:
      - text: List clicked nodes in replay {replay_id} for {org}.
        slots:
          replay_id: path.replay_id
          org: path.organization_id_or_slug
      - text: Show what was clicked during replay {replay_id}.
        slots:
          replay_id: path.replay_id
      method: generated
      generated: '2026-09-26'