Skip to main content
POST
List session replay segments

Restrictions

Usage

  • When url_mode is false (default), the response streams application/x-ndjson — one decompressed replay segment JSON object per line — and is not wrapped in the standard envelope. The pagination cursor for the next call is returned in the X-Search-After-Ctx response header instead of a body field. A segment that cannot be read is skipped silently.
  • When url_mode is true, the response is a normal JSON envelope containing presigned download URLs (valid 1 hour) for the zlib-compressed segment objects.
  • Pass ts (without search_after_ctx) to start from the last full-snapshot segment at or before that time, searching up to 4 hours back; if none is found, paging starts from the beginning.
  • A cursor is returned whenever a page is full (limit segments), so the last page can be empty.
  • limit accepts 1-99; values of 100 or more are rejected.
  • If the session belongs to a private application the caller cannot access, the call returns AccessDenied (“You do not have permission to access this application”).
  • A page with no segments returns an empty result. Segments uploaded moments ago may not be indexed yet; the call then returns ResourceNotFound (“Replay segments are not available yet. Please retry shortly”), so retry after a short wait.

Authorizations

app_key
string
query
required

APP Key created in the Flashduty console under My → APP Key. Send it as the app_key query parameter or in the Fd-App-Key request header. Its effective access is the intersection of the key's permission scope and the creator's current role permissions. Keep it secret.

Body

application/json

Page through the recorded replay segments of a session, or a single view within it.

session_id
string
required

RUM session ID (the session.id attribute on RUM events).

limit
integer
default:20

Maximum number of segments to return. 1-99, default 20.

Required range: 1 <= x <= 99
search_after_ctx
string

Pagination cursor from a previous call. Take it from the search_after_ctx field (URL mode) or the X-Search-After-Ctx response header (streaming mode).

ts
integer<int64>

Unix timestamp in milliseconds. When set and search_after_ctx is empty, paging starts at the last full-snapshot segment at or before this time (searching up to 4 hours back); if none is found, paging starts from the beginning.

url_mode
boolean

When true, return presigned download URLs as a JSON envelope instead of streaming segment bytes. Defaults to false.

view_id
string

Restrict results to segments belonging to this view. Omit to page through the entire session.

Response

Success. Shape depends on url_mode — see Usage.

Success response envelope. On every 2xx response, request_id identifies the call (also mirrored in the Flashcat-Request-Id header) and data holds the endpoint-specific payload. Failure responses use a different shape — see ErrorResponse.

request_id
string
required

Unique ID for this request. Mirrored in the Flashcat-Request-Id response header. Include it when reporting issues.

Example:

"01HK8XQE3Z7JM2NTFQ5YJ8P9R4"

data
object

Presigned segment URLs, returned only when url_mode is true.