Sentry

Sentry Replays API

Manage session replays

Documentation GitHub OpenAPI

Operations 5

Each operation below carries the questions people ask an LLM about it and the instructions they give an agent to run it. Generated by API Evangelist overlay

GET /organizations/{organization_id_or_slug}/replays/ List session replays · Sentry List an organization's replays #

Ask an LLM

“How do I find session replays from the last day?”

“Can I filter replays by project and environment and sort them?”

Tell an agent

List replays in organization {org}.

Find replays matching {query} in project {project} over {statsPeriod}, sorted by {sort}.

GET /projects/{organization_id_or_slug}/{project_id_or_slug}/replays/{replay_id}/ Get a session replay · Sentry Retrieve a replay instance #

Ask an LLM

“What happened during a specific session replay?”

“Can I look up a replay's metadata by ID?”

Tell an agent

Show replay {replay_id} in project {project} of {org}.

Fetch details for session replay {replay_id}.

DELETE /projects/{organization_id_or_slug}/{project_id_or_slug}/replays/{replay_id}/ Delete a session replay · Sentry Delete a replay instance #

Ask an LLM

“How do I delete a replay that captured sensitive data?”

“Can a session replay be removed permanently?”

Tell an agent destructive · confirm first

Delete replay {replay_id} from project {project} in {org}.

Remove session replay {replay_id}.

GET /projects/{organization_id_or_slug}/{project_id_or_slug}/replays/{replay_id}/viewed-by/ List who viewed a replay · Sentry List users who have viewed a replay #

Ask an LLM

“Who on my team has already watched this replay?”

“Can I see the viewers of a session replay?”

Tell an agent

List users who viewed replay {replay_id} in project {project} of {org}.

Show viewers of replay {replay_id}.

GET /organizations/{organization_id_or_slug}/replay-count/ Count replays for issues or transactions · Sentry Retrieve a count of replays for a given issue or transaction #

Ask an LLM

“How many replays are attached to an issue?”

“Is there a replay count per transaction for the last week?”

Tell an agent

Count replays in {org} for {query}.

Count replays for {query} in project {project} over {statsPeriod}.

Documentation

https://docs.sentry.io/api/

https://docs.sentry.io/api/auth/

https://docs.sentry.io/api/guides/create-auth-token/

https://docs.sentry.io/api/ratelimits/

https://docs.sentry.io/api/events/

https://docs.sentry.io/api/organizations/

https://docs.sentry.io/api/projects/

https://docs.sentry.io/api/teams/

https://docs.sentry.io/api/releases/

https://docs.sentry.io/api/crons/

https://docs.sentry.io/api/dashboards/

https://docs.sentry.io/api/discover/

https://docs.sentry.io/api/environments/

https://docs.sentry.io/api/explore/

https://docs.sentry.io/api/integration/

https://docs.sentry.io/api/integrations/

https://docs.sentry.io/api/mobile-builds/

https://docs.sentry.io/api/monitors/

https://docs.sentry.io/api/replays/

https://docs.sentry.io/api/scim/

https://docs.sentry.io/api/seer/

https://docs.sentry.io/api/users/

Specifications

https://raw.githubusercontent.com/api-evangelist/sentry-system/refs/heads/main/openapi/sentry-system-replays-api-openapi.yml

Schemas & Data

https://raw.githubusercontent.com/api-evangelist/sentry-system/refs/heads/main/json-schema/sentry-organization-schema.json

https://raw.githubusercontent.com/api-evangelist/sentry-system/refs/heads/main/json-schema/sentry-project-schema.json

https://raw.githubusercontent.com/api-evangelist/sentry-system/refs/heads/main/json-schema/sentry-issue-schema.json

https://raw.githubusercontent.com/api-evangelist/sentry-system/refs/heads/main/json-schema/sentry-event-schema.json

https://raw.githubusercontent.com/api-evangelist/sentry-system/refs/heads/main/json-schema/sentry-team-schema.json

https://raw.githubusercontent.com/api-evangelist/sentry-system/refs/heads/main/json-schema/sentry-release-schema.json

https://raw.githubusercontent.com/api-evangelist/sentry-system/refs/heads/main/json-schema/sentry-alert-rule-schema.json

https://raw.githubusercontent.com/api-evangelist/sentry-system/refs/heads/main/json-schema/sentry-monitor-schema.json

https://raw.githubusercontent.com/api-evangelist/sentry-system/refs/heads/main/json-schema/sentry-replay-schema.json

Other Resources

https://docs.sentry.io/platforms/

PostmanCollection

https://www.postman.com/sentryio/sentry-api-collection/documentation/xtzhckg/sentry-api-collection

https://docs.sentry.io/organization/integrations/integration-platform/webhooks/

https://docs.sentry.io/api/pagination/

https://docs.sentry.io/api/permissions/

https://docs.sentry.io/api/requests/

https://raw.githubusercontent.com/api-evangelist/sentry-system/refs/heads/main/json-ld/sentry-context.jsonld

Work with this as data

Every API here is available over the APIs.io API and to AI agents over MCP.

MCP server

One button, every client — Claude, Cursor, VS Code and the rest.

https://apis.io/mcp

Tools for apis

7 MCP tools reach this

find_apisBrowse and filter every API in the catalog.
get_api_artifactsOne API's artifacts, grouped by type.
get_openapiThe primary OpenAPI for this API.
find_similar_apisAPIs that look like this one.
apis_io_searchSTART HERE — APIs, providers and tags for one query, each with its total.
resolveTurn a domain, URL or GitHub org into the provider it belongs to.
find_cohortsEvery scored population of providers in the catalog.

All 92 tools →

Call it yourself

curl for this page

This API

curl "https://apis.io/api/v1/apis/sentry-system:sentry-system-replays-api"

All apis

curl "https://apis.io/api/v1/apis?limit=25"

Discovery needs no key. Ratings and market analysis are Pro.

Get an API key

Free tier, no form to fill in. Signing in shares your email address with us — we store it to create your key and to recognise you if you sign in with another provider. See our Privacy Policy and Terms.

GitHub Google LinkedIn

A second provider on the same verified email joins the account you already have.

OpenAPI Specification

openapi: 3.2.0
info:
  title: Sentry Replays API
  description: The Replays API provides endpoints for managing session replays in Sentry, including listing, retrieving, and deleting replay instances, accessing recording segments, listing clicked nodes and selectors, and retrieving replay counts for issues or transactions.
  version: 0.0.1
  contact:
    name: Sentry Support
    url: https://sentry.io/support/
    email: support@sentry.io
servers:
- url: https://sentry.io/api/0
  description: Sentry Production API
security:
- BearerAuth: []
tags:
- name: Replays
  description: Manage session replays
paths:
  /organizations/{organization_id_or_slug}/replays/:
    get:
      operationId: listOrganizationReplays
      summary: Sentry List an organization's replays
      description: Returns a list of replays for the given organization.
      tags:
      - Replays
      parameters:
      - $ref: '#/components/parameters/OrganizationIdOrSlug'
      - name: cursor
        in: query
        description: Pagination cursor.
        schema:
          type: string
      - name: query
        in: query
        description: A search query to filter replays.
        schema:
          type: string
      - name: statsPeriod
        in: query
        description: Stats period (e.g., 24h, 14d).
        schema:
          type: string
      - name: project
        in: query
        description: Project IDs to filter by.
        schema:
          type: array
          items:
            type: integer
      - name: environment
        in: query
        description: Environment to filter by.
        schema:
          type: string
      - name: sort
        in: query
        description: Sort order for results.
        schema:
          type: string
      responses:
        '200':
          description: A list of replays.
          content:
            application/json:
              schema:
                type: object
                properties:
                  data:
                    type: array
                    items:
                      $ref: '#/components/schemas/Replay'
        '401':
          description: Unauthorized.
        '403':
          description: Forbidden.
  /projects/{organization_id_or_slug}/{project_id_or_slug}/replays/{replay_id}/:
    get:
      operationId: retrieveReplay
      summary: Sentry Retrieve a replay instance
      description: Returns details for a specific session replay.
      tags:
      - Replays
      parameters:
      - $ref: '#/components/parameters/OrganizationIdOrSlug'
      - $ref: '#/components/parameters/ProjectIdOrSlug'
      - $ref: '#/components/parameters/ReplayId'
      responses:
        '200':
          description: Replay details.
          content:
            application/json:
              schema:
                type: object
                properties:
                  data:
                    $ref: '#/components/schemas/Replay'
        '401':
          description: Unauthorized.
        '404':
          description: Replay not found.
    delete:
      operationId: deleteReplay
      summary: Sentry Delete a replay instance
      description: Deletes a session replay.
      tags:
      - Replays
      parameters:
      - $ref: '#/components/parameters/OrganizationIdOrSlug'
      - $ref: '#/components/parameters/ProjectIdOrSlug'
      - $ref: '#/components/parameters/ReplayId'
      responses:
        '204':
          description: Replay deleted.
        '401':
          description: Unauthorized.
        '404':
          description: Replay not found.
  /projects/{organization_id_or_slug}/{project_id_or_slug}/replays/{replay_id}/viewed-by/:
    get:
      operationId: listReplayViewers
      summary: Sentry List users who have viewed a replay
      description: Returns a list of users who have viewed a specific replay.
      tags:
      - Replays
      parameters:
      - $ref: '#/components/parameters/OrganizationIdOrSlug'
      - $ref: '#/components/parameters/ProjectIdOrSlug'
      - $ref: '#/components/parameters/ReplayId'
      responses:
        '200':
          description: A list of users who have viewed the replay.
          content:
            application/json:
              schema:
                type: object
                properties:
                  data:
                    type: array
                    items:
                      type: object
                      properties:
                        id:
                          type: string
                        name:
                          type: string
                        email:
                          type: string
                        dateViewed:
                          type: string
                          format: date-time
        '401':
          description: Unauthorized.
        '404':
          description: Replay not found.
  /organizations/{organization_id_or_slug}/replay-count/:
    get:
      operationId: getReplayCount
      summary: Sentry Retrieve a count of replays for a given issue or transaction
      description: Returns the count of replays associated with specified issues or transactions.
      tags:
      - Replays
      parameters:
      - $ref: '#/components/parameters/OrganizationIdOrSlug'
      - name: query
        in: query
        description: The search query (e.g., issue.id or transaction).
        schema:
          type: string
      - name: statsPeriod
        in: query
        description: Stats period.
        schema:
          type: string
      - name: project
        in: query
        description: Project IDs.
        schema:
          type: array
          items:
            type: integer
      responses:
        '200':
          description: Replay counts.
          content:
            application/json:
              schema:
                type: object
                additionalProperties:
                  type: integer
        '401':
          description: Unauthorized.
components:
  parameters:
    ReplayId:
      name: replay_id
      in: path
      required: true
      description: The ID of the replay.
      schema:
        type: string
        format: uuid
    ProjectIdOrSlug:
      name: project_id_or_slug
      in: path
      required: true
      description: The ID or slug of the project.
      schema:
        type: string
    OrganizationIdOrSlug:
      name: organization_id_or_slug
      in: path
      required: true
      description: The ID or slug of the organization.
      schema:
        type: string
  schemas:
    Replay:
      type: object
      properties:
        id:
          type: string
          format: uuid
        title:
          type: string
        projectId:
          type: string
        duration:
          type: integer
          description: Duration in seconds.
        countErrors:
          type: integer
        countSegments:
          type: integer
        countUrls:
          type: integer
        startedAt:
          type: string
          format: date-time
        finishedAt:
          type: string
          format: date-time
        platform:
          type: string
        environment:
          type: string
        urls:
          type: array
          items:
            type: string
        user:
          type: object
          properties:
            id:
              type: string
            name:
              type: string
            email:
              type: string
            ip_address:
              type: string
        browser:
          type: object
          properties:
            name:
              type: string
            version:
              type: string
        os:
          type: object
          properties:
            name:
              type: string
            version:
              type: string
        device:
          type: object
          properties:
            name:
              type: string
            brand:
              type: string
            model:
              type: string
            family:
              type: string
        tags:
          type: object
          additionalProperties:
            type: array
            items:
              type: string
      required:
      - id
      - startedAt
      - finishedAt
  securitySchemes:
    BearerAuth:
      type: http
      scheme: bearer
      description: Authentication token for the Sentry API.