Bugsnag · OpenAPI Overlay 1.0.0

API Evangelist conversational phrasing for Bugsnag Data Access Pivots API

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

What the actions change

x-apievangelist-phrasing

Targets 3

$.info
$.paths['/projects/{project_id}/pivots'].get
$.paths['/projects/{project_id}/pivots/{pivot_id}/values'].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 Bugsnag Data Access Pivots API
  version: 1.0.0
extends: openapi/bugsnag-pivots-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['/projects/{project_id}/pivots'].get
  update:
    x-apievangelist-phrasing:
      intent: List a project's pivot dimensions
      effect: read
      questions:
      - Which dimensions like browser or OS can I group my project's errors by?
      - What pivots are available for breaking down errors in a project?
      instructions:
      - text: List the pivot dimensions for project {project_id}.
        slots:
          project_id: path.project_id
      - text: Show what I can pivot errors on in project {project_id}.
        slots:
          project_id: path.project_id
      method: generated
      generated: '2026-09-26'
- target: $.paths['/projects/{project_id}/pivots/{pivot_id}/values'].get
  update:
    x-apievangelist-phrasing:
      intent: List values seen for a pivot
      effect: read
      questions:
      - Which browser names or OS versions have shown up in my errors?
      - Can I page through all the values recorded for one pivot?
      instructions:
      - text: List the values of pivot {pivot_id} in project {project_id}.
        slots:
          pivot_id: path.pivot_id
          project_id: path.project_id
      - text: Show {per_page} values per page for pivot {pivot_id} in project {project_id}.
        slots:
          per_page: query.per_page
          pivot_id: path.pivot_id
          project_id: path.project_id
      method: generated
      generated: '2026-09-26'