Retrieve a Replay Instance

GET /api/0/organizations/{organization_id_or_slug}/replays/{replay_id}/

Return details on an individual replay.

Path Parameters

organization_id_or_slug (string)
REQUIRED

The id or slug of the organization the resource belongs to.

replay_id (string)
REQUIRED

The ID of the replay you'd like to retrieve.

Query Parameters:

statsPeriod (string)

This defines the range of the time series, relative to now. The range is given in a <number><unit> format. For example 1d for a one day range. Possible units are m for minutes, h for hours, d for days and w for weeks. You must either provide a statsPeriod, or a start and end.

start (string)

This defines the start of the time series range as an explicit datetime, either in UTC ISO8601 or epoch seconds. Use along with end instead of statsPeriod.

end (string)

This defines the inclusive end of the time series range as an explicit datetime, either in UTC ISO8601 or epoch seconds. Use along with start instead of statsPeriod.

field (array(string))
choices:
  • activity
  • browser
  • count_dead_clicks
  • count_errors
  • count_rage_clicks
  • count_segments
  • count_urls
  • device
  • dist
  • duration
  • environment
  • error_ids
  • finished_at
  • id
  • is_archived
  • os
  • platform
  • project_id
  • releases
  • sdk
  • started_at
  • tags
  • trace_ids
  • urls
  • user
  • clicks
  • info_ids
  • warning_ids
  • count_warnings
  • count_infos
  • has_viewed

Specifies a field that should be marshaled in the output. Invalid fields will be rejected.

project (array(integer))

The ID of the projects to filter by.

environment (string)

The environment to filter by.

sort (string)

The field to sort the output by.

query (string)

A structured query string to filter the output by.

per_page (integer)

Limit the number of rows to return in the result.

cursor (string)

The cursor parameter is used to paginate results. See here for how to use this query parameter

Scopes

<auth_token> requires one of the following scopes:
  • org:admin
  • org:read
  • org:write
curl https://sentry.io/api/0/organizations/{organization_id_or_slug}/replays/{replay_id}/ \
 -H 'Authorization: Bearer <auth_token>'
RESPONSESCHEMA
{
  "activity": 5,
  "browser": {
    "name": "Chome",
    "version": "103.0.38"
  },
  "count_dead_clicks": 6,
  "count_rage_clicks": 1,
  "count_errors": 1,
  "count_segments": 0,
  "count_urls": 1,
  "device": {
    "brand": "Apple",
    "family": "iPhone",
    "model": "11",
    "name": "iPhone 11"
  },
  "dist": null,
  "duration": 576,
  "environment": "production",
  "error_ids": [
    "7e07485f-12f9-416b-8b14-26260799b51f"
  ],
  "finished_at": "2022-07-07T14:15:33.201019",
  "has_viewed": true,
  "id": "7e07485f-12f9-416b-8b14-26260799b51f",
  "is_archived": null,
  "os": {
    "name": "iOS",
    "version": "16.2"
  },
  "platform": "Sentry",
  "project_id": "639195",
  "releases": [
    "version@1.4"
  ],
  "sdk": {
    "name": "Thundercat",
    "version": "27.1"
  },
  "started_at": "2022-07-07T14:05:57.909921",
  "tags": {
    "hello": [
      "world",
      "Lionel Richie"
    ]
  },
  "trace_ids": [
    "7e07485f-12f9-416b-8b14-26260799b51f"
  ],
  "urls": [
    "/organizations/abc123/issues"
  ],
  "user": {
    "display_name": "John Doe",
    "email": "john.doe@example.com",
    "id": "30246326",
    "ip": "213.164.1.114",
    "username": "John Doe"
  }
}