Settings API - Session aggregation settings schema table

  • Published Sep 25, 2025

Session aggregation settings (builtin:session.aggregation)

Session aggregation settings

Schema IDSchema groupsScope
builtin:session.aggregation-
environment
GETManagedhttps://{your-domain}/e/{your-environment-id}/api/v2/settings/schemas/builtin:session.aggregation
SaaShttps://{your-environment-id}.live.dynatrace.com/api/v2/settings/schemas/builtin:session.aggregation
Environment ActiveGatehttps://{your-activegate-domain}/e/{your-environment-id}/api/v2/settings/schemas/builtin:session.aggregation

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
Cookieless Mode
cookielessMode		boolean

Enables/Disables the cookieless mode for sessions. If disabled, no session will be generated.

required
Max duration in hours
maxDuration		integer

Max session duration in hours. After the duration is reached, the session is considered as finished.

required
Max amount of session properties
maxSessionProperties		integer

Max amount of sessions properties to be aggregated. If the limit is reached, new properties will be discarded.

required
Session timeout in minutes
sessionTimeout		integer

Session timeout in minutes. If no event is received during the amount of minutes configured, the session will be finished.

required
Age of offline events
ageOfOfflineEvents		integer

Age of offline events in minutes. Events received out of the session time range, will still be aggregated if they are received X minutes after it was finished.

required