Settings API - Session Replay state cookie schema table

  • Published Apr 06, 2026

Session Replay state cookie (builtin:sessionreplay.cookie)

This flag must be enabled to ensure Session Replay consistency in scenarios where a single RUM session can include different sub-domains. Enabling it causes some Session Replay data to be stored in a dtSR cookie so that it will be accessible from all pages. Otherwise this data is stored in browser's Local Storage.

Schema IDSchema groupsScope
builtin:sessionreplay.cookie
  • group:web-and-mobile-monitoring.web-applications
  • group:web-and-mobile-monitoring
environment
Retrieve schema via Settings API
GETManagedhttps://{your-domain}/e/{your-environment-id}/api/v2/settings/schemas/builtin:sessionreplay.cookie
GETSaaShttps://{your-environment-id}.live.dynatrace.com/api/v2/settings/schemas/builtin:sessionreplay.cookie
GETEnvironment ActiveGatehttps://{your-activegate-domain}/e/{your-environment-id}/api/v2/settings/schemas/builtin:sessionreplay.cookie

Authentication

To execute this request, you need an access token with Read settings (settings.read) scope. To learn how to obtain and use it, see Tokens and authentication.

Parameters

PropertyTypeDescriptionRequired
Store Session Replay state in cookies
stateCookieEnabled		boolean-Required