List all cookie names that Dynatrace Real User Monitoring uses with the RUM API, for example to configure consent tools or allowlists.
| GET | SaaS | https://{your-environment-id}.apps.dynatrace.com/platform/rum/v1/cookie-names |
You use this operation to list every cookie name that Dynatrace Real User Monitoring sets in your users' browsers. It takes no parameters and returns all RUM cookie names with a 200 response. Typical usage is configuring cookie consent tools, firewalls, or allowlists so RUM can work as expected.
To execute this request, you need a platform token or OAuth access token with rum:cookie-names:read scope. To learn how to obtain and use it, see Tokens and authentication.
The request doesn't provide any configurable parameters.
| Code | Type | Description |
|---|---|---|
| 200 | Cookie | Success. The response contains all RUM cookie names |
| 4XX | Error | Client error. |
| 5XX | Error | Server error. |
CookieNames objectThe list of all cookie names.
| Element | Type | Description |
|---|---|---|
| domainValidationCookieName | string | The name of the domain validation cookie. |
| latencyCookieName | string | The name of the latency cookie. |
| pageContextCookieName | string | The name of the page context cookie. |
| sessionCookieName | string | The name of the session cookie. |
| sessionReplayCookieName | string | The name of the session replay cookie. |
| sessionReplayViewIdCookieName | string | The name of the session replay view ID cookie. |
| sessionTimeoutCookieName | string | The name of the session timeout cookie. |
| sourceActionCookieName | string | The name of the source action cookie. |
| visitorCookieName | string | The name of the visitor cookie. |
ErrorEnvelope object| Element | Type | Description |
|---|---|---|
| error | Error | - |
Error object| Element | Type | Description |
|---|---|---|
| code | integer | The HTTP status code |
| constraintViolations | Constraint | A list of constraint violations |
| message | string | The error message |
ConstraintViolation objectA list of constraint violations
| Element | Type | Description |
|---|---|---|
| location | string | - |
| message | string | - |
| parameterLocation | string | -The element can hold these values
|
| path | string | - |
{"domainValidationCookieName": "dtValidationCookie","latencyCookieName": "dtLatC","pageContextCookieName": "dtPC","sessionCookieName": "dtCookie","sessionReplayCookieName": "dtSR","sessionReplayViewIdCookieName": "dtsrVID","sessionTimeoutCookieName": "rxvt","sourceActionCookieName": "dtSA","visitorCookieName": "rxVisitor"}
{"error": {"code": 1,"constraintViolations": [{"location": "string","message": "string","parameterLocation": "HEADER","path": "string"}],"message": "string"}}