Sentry · OpenAPI Overlay 1.0.0

API Evangelist conversational phrasing for Sentry Explore API

3 actions 3 updates phrasing extends openapi/sentry-system-explore-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}/events/'].get
$.paths['/organizations/{organization_id_or_slug}/events-stats/'].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 Explore API
  version: 1.0.0
extends: openapi/sentry-system-explore-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}/events/'].get
  update:
    x-apievangelist-phrasing:
      intent: Query events as a table
      effect: read
      questions:
      - How do I slice my events by fields and aggregates in a table?
      - Can I query event counts per transaction over the last 24 hours?
      - Is there a page size limit on Explore table queries?
      instructions:
      - text: Query events in {org} with fields {field} over {statsPeriod}.
        slots:
          org: path.organization_id_or_slug
          field: query.field
          statsPeriod: query.statsPeriod
      - text: Show a table of {field} for events matching {query}, sorted by {sort}.
        slots:
          field: query.field
          query: query.query
          sort: query.sort
      - text: Return {per_page} rows of {field} for project {project} in {environment}.
        slots:
          per_page: query.per_page
          field: query.field
          project: query.project
          environment: query.environment
      method: generated
      generated: '2026-09-26'
- target: $.paths['/organizations/{organization_id_or_slug}/events-stats/'].get
  update:
    x-apievangelist-phrasing:
      intent: Query events as a time series
      effect: read
      questions:
      - Can I chart an event metric over time?
      - What interval can I bucket event data into for graphs?
      instructions:
      - text: Chart {yAxis} for events in {org} over {statsPeriod}.
        slots:
          yAxis: query.yAxis
          org: path.organization_id_or_slug
          statsPeriod: query.statsPeriod
      - text: Plot {yAxis} in {interval} buckets for events matching {query}.
        slots:
          yAxis: query.yAxis
          interval: query.interval
          query: query.query
      method: generated
      generated: '2026-09-26'