User sessions aggregate user events into sessions, providing a comprehensive view of a user's journey through the application. A user session—also known as a "visit," "journey," or "clickpath"—is a sequence of user actions that are performed by the same user in your application during a limited period of time. A single session typically includes multiple page or view loads, third-party content requests, service requests, and user actions such as clicks or taps. Each user session includes at least one user navigation or one user action.
The session provides a summary of the user events and interactions with your application, as well as errors, properties, and other metadata. It does this by monitoring all events and generating aggregates from them.
A user session—also known as a "visit," "journey," or "clickpath"—is a sequence of user actions that are performed by the same user in your application during a limited period of time. A single session typically includes multiple page or view loads, third-party content requests, service requests, and user actions such as clicks or taps. Each user session includes at least one user navigation or one user action.
Searches for all user sessions.
fetch user.sessions
| Attribute | Type | Description | Examples |
|---|---|---|---|
duration | duration | stable Display name: DurationThe difference between start_time and end_time in nanoseconds. | 42 |
end_reason | string | experimental The reason why the user session was closed. | timeout |
end_time | timestamp | stable Display name: End timeEnd time of a data point. Value is a UNIX Epoch time in nanoseconds and greater than or equal to the start_time. Time correction is applied. | 1649822520123123165 |
navigation_count | long | experimental The number of navigation events. | 6 |
page_summary_count | long | experimental The number of page summary events. | 12 |
request_count | long | experimental The number of request events. | 56 |
start_time | timestamp | stable Display name: Start timeStart time of the user event. The value is a UNIX Epoch time in nanoseconds and less than or equal to the end_time. Time correction is applied. | 1649822520123123123 |
user_action_count | long | experimental The number of user action events. | 124 |
user_interaction_count | long | experimental The number of user interaction events. | 112 |
view_summary_count | long | experimental The number of view summary events. | 12 |
end_reason MUST be one of the following:
| Value | Description |
|---|---|
duration | The user session reached the maximum duration |
synthetic_execution_finished | The synthetic execution finished |
timeout | The user session timed out |
| Attribute | Type | Description | Examples |
|---|---|---|---|
experience.score | double | experimental Weighted average Experience Score for the user session, computed from all events with experience.level set. Calculated as sum(level_value × weight) / sum(weights) where satisfied = 1, tolerating = 0.5, and frustrated = 0. Values range from 0 (all frustrated) to 1 (all satisfied). | 0.94; 0.75; 0.42 |
experience.score.band | string | experimental Predefined quality band derived from experience.score. Maps the numeric score to a human-readable category: excellent (≥ 0.94), good (≥ 0.85), fair (≥ 0.70), poor (≥ 0.50), unacceptable (< 0.50). Omitted when experience.score is absent. | excellent; good; fair; poor; unacceptable |
experience.score.band MUST be one of the following:
| Value | Description | Display name |
|---|---|---|
excellent | excellent | Excellent |
fair | fair | Fair |
good | good | Good |
poor | poor | Poor |
unacceptable | unacceptable | Unacceptable |
| Attribute | Type | Description | Examples |
|---|---|---|---|
user.identifier | string | stable The user identifier for identifying individual users across different browsers, devices, and user sessions. Tags: sensitive-user-events | john.doe@dynatrace.com |
| Attribute | Type | Description | Examples |
|---|---|---|---|
session_properties.__property_name__ | any | stable Contains the value for the session property named __property_name__ defined by the event and session property configuration. The data type of the value depends on the definition; default is data type string. | session_properties.patientid:DFTR123455; session_properties.customers_cohort: premium |
| Attribute | Type | Description | Examples |
|---|---|---|---|
characteristics.has_replay | boolean | experimental If set to true, at least part of the user session was recorded with Session Replay and can be replayed. | true |
characteristics.is_invalid | boolean | deprecated Primary characteristic: If set to true, the user event was marked invalid during validation. | false |
| Attribute | Type | Description | Examples |
|---|---|---|---|
error.anr_count | long | experimental The number of ANR (Application Not Responding) errors. | 12 |
error.count | long | experimental The overall number of errors. | 1 |
error.csp_violation_count | long | experimental Display name: Error CSP violation countThe number of CSP rule violations. | 1 |
error.exception_count | long | experimental Display name: Error exception countThe total number of exceptions that are observed, including exceptions that are not captured. | 1 |
error.has_crash | boolean | experimentaltrue indicates that the user session contains a crash. It only counts for mobile applications. | true |
error.http_4xx_count | long | experimental Display name: Error HTTP 4xx countThe number of HTTP request errors with an http.response.status_code of 400-499. | 1 |
error.http_5xx_count | long | experimental Display name: Error HTTP 5xx countThe number of HTTP request errors with an http.response.status_code of 500-599. | 1 |
| Attribute | Type | Description | Examples |
|---|---|---|---|
app.short_version | string | resource stable Display name: App versionThe application's publicly visible version number, as, for example, displayed in App Store or Google Play. Usually this is just the major and minor version with no patch number. | 5.23 |
app.version | string | resource stable Display name: App build versionThe application's internal build number, which can include information such as patch number and build number. | 5.23.15789; 143542 |
| Attribute | Type | Description | Examples |
|---|---|---|---|
browser.name | string | resource stable Display name: Browser nameThe browser name. | Chrome |
browser.version | string | resource stable Display name: Browser versionThe browser version. | Version 142.0.7444.176 |
browser.window.height | long | stable Display name: Browser window heightThe browser window's inner height, in pixels. | 384 |
browser.window.width | long | stable Display name: Browser window widthThe browser window's inner width, in pixels. | 2048 |
| Attribute | Type | Description | Examples |
|---|---|---|---|
os.name | string | resource stable Display name: OS nameThe OS name in a short, human-readable format. | iOS |
os.version | string | resource stable Display name: OS versionThe complete OS version, including patch, build, and other information. | 15.3.1; Ubuntu 16.04.7 LTS (Xenial Xerus) (kernel 4.15.0-206-generic); Windows Server 2022 Datacenter 21H2 2009, ver. 10.0.20348 |
| Attribute | Type | Description | Examples |
|---|---|---|---|
device.is_rooted | boolean | resource stable Display name: Device is rootedIf set to true, the device is rooted or jailbroken. | false |
device.manufacturer | string | resource stable Display name: Device manufacturerThe device manufacturer. | Apple |
device.model.identifier | string | resource stable Display name: Device model identifierThe device model identifier. | iPhone 17 Max Pro |
device.screen.height | long | resource stable Display name: Device screen heightThe device's screen height in its natural orientation. | 1152 |
device.screen.width | long | resource stable Display name: Device screen widthThe device's screen width in its natural orientation. | 2048 |
| Attribute | Type | Description | Examples |
|---|---|---|---|
client.ip | ipAddress | experimental Display name: Client IP addressThe IP address of the client that makes the request. This can be IPv4 or IPv6. Tags: sensitive-spans sensitive-user-events | 194.232.104.141; 2a01:468:1000:9::140 |
client.isp | string | experimental Display name: Client ISP nameThe name of the Internet Service Provider (ISP) associated with the client's IP address. | Internet Service Provider Name |
| Attribute | Type | Description | Examples |
|---|---|---|---|
dt.rum.application.entities | array | experimental The entity IDs of type APPLICATION or MOBILE_APPLICATION based on dt.rum.application.entity.Tags: entity-id | ['APPLICATION-EA7C4B59F27D43EB', 'MOBILE_APPLICATION-E8A8751A60D5BCE8'] |
dt.rum.application.type | string | experimental The application type determined based on dt.rum.agent.type. | web |
dt.rum.instance.id | string | resource stable Display name: RUM instance IDA persistent pseudonymous identifier representing the same device (browser user agent or mobile app installation) across multiple user sessions. Used to analyze returning users and long-term journeys. Formerly known as "Visitor ID" or "internal user ID." For information on the real user identity, see user.identifier. | 3735928559; 1742973444821E7E6Q3E3SG28ATQPAGTT6T8HU92VFRFQ |
dt.rum.session.id | string | stable Display name: User session IDA unique identifier for a user session. Use this field to join user events with user sessions in DQL queries. | HOPCPWKILUKHFHWRRQGBHHPAFLUJUOSH-0; 23626166142035610_1-0 |
dt.rum.user_type | string | resource experimental Display name: User typeThe RUM user type. | real_user |
dt.rum.application.type MUST be one of the following:
| Value | Description |
|---|---|
hybrid | A hybrid application |
mobile | A mobile application |
web | A web application |
dt.rum.user_type MUST be one of the following:
| Value | Description | Display name |
|---|---|---|
real_user | The user event was produced by a real user. | Real User |
robot | The user event was produced by a bot user. | Robot |
synthetic | The user event was produced by a synthetic test. | Synthetic |
| Attribute | Type | Description | Examples |
|---|---|---|---|
dt.retain.size | long | experimental Display name: Retain sizeThe size of the retained data point in bytes. | 2005 |
| Attribute | Type | Description | Examples |
|---|---|---|---|
geo.country.iso_code | string | resource stable Display name: Country ISO codeThe two-letter country code. The format complies with ISO 3166-1 alpha-2. | CA; GB |
| Attribute | Type | Description | Examples |
|---|---|---|---|
dt.openpipeline.source | string | resource experimental Display name: OpenPipeline ingest sourceIdentifies the source (such as API endpoints or OneAgent) used for ingesting the record into OpenPipeline. | /platform/ingest/v1/events; oneagent |
User session synthetic fields are available only when dt.rum.user_type is SYNTHETIC.
| Attribute | Type | Description | Examples |
|---|---|---|---|
dt.entity.synthetic_location | string | resource deprecatedThis field is deprecated and will be removed in the future. Use dt.smartscape.synthetic_location instead.Display name: Synthetic locationAn entity ID of an entity of type SYNTHETIC_LOCATION. Tags: entity-id | SYNTHETIC_LOCATION-D140F3B85BCCBD1A |
dt.entity.synthetic_test | string | resource deprecatedThis field is deprecated and will be removed in the future. Use dt.smartscape.browser_monitor instead.Display name: Synthetic testAn entity ID of an entity of type SYNTHETIC_TEST. Tags: entity-id | SYNTHETIC_TEST-A140F3B85BCCBD1A |
dt.entity.synthetic_test_step | string | resource deprecatedThis field is deprecated and will be removed in the future. Use dt.smartscape.browser_monitor_step instead.Display name: Synthetic test stepAn entity ID of an entity of type SYNTHETIC_TEST_STEP. Tags: entity-id | SYNTHETIC_TEST_STEP-A140F3B85BCCBD1A |
dt.entity.synthetic_test_step | string[] | resource deprecatedThis field is deprecated and will be removed in the future. Use dt.smartscape.browser_monitor_step instead.Display name: Synthetic test stepAn array of entity IDs of an entity of type SYNTHETIC_TEST_STEP. Tags: entity-id | ['SYNTHETIC_TEST_STEP-A140F3B85BCCBD1A', 'SYNTHETIC_TEST_STEP-6349B98E1CD87352'] |
dt.security_context | string | resource stable Display name: DT security contextThe security context is used in access permissions to limit the visibility. Learn more about the Dynatrace permission model Tags: permission | |
dt.smartscape.browser_monitor | smartscapeId | resource stable Display name: Browser monitor IDSmartscape ID referencing a browser monitor entity. Tags: smartscape-id | BROWSER_MONITOR-A140F3B85BCCBD1A |
dt.smartscape.browser_monitor_step | smartscapeId | resource stable Display name: Browser monitor step IDSmartscape ID referencing a browser monitor step entity. Tags: smartscape-id | BROWSER_MONITOR_STEP-A140F3B85BCCBD1A |
dt.synthetic.monitor.id | string | resource experimental Display name: Synthetic monitor IDThe identifier of the monitor. | HTTP_CHECK-6349B98E1CD87352 |
dt.synthetic.monitor.name | string | experimental The name of the monitor. | Monitor name |
dt.synthetic.monitor.smartscape.id | smartscapeId | resource experimental The Smartscape ID of the monitor. | HTTP_MONITOR-017198AD253CBD63 |
dt.synthetic.monitored_entity_ids | string[] | resource experimental Display name: Synthetic monitored entity idsIDs of monitored entities. | ['APPLICATION-EA7C4B59F27D43EB'] |
dt.synthetic.monitored_smartscape_ids | smartscapeId[] | resource experimental Display name: Synthetic monitored entity Smartscape idsThe Smartscape IDs of monitored entities. | [['FRONTEND-E0D8F94D9065F24F']] |
dt.synthetic.step.id | string | resource experimental Display name: Synthetic step IDThe identifier of the monitor step. | HTTP_CHECK_STEP-5349B98E1CD87352 |
dt.synthetic.step.name | string | experimental The name of the step. | Step name |
dt.synthetic.step.sequence_number | long | experimental The sequence number of the step within the synthetic browser monitor, indicating the order of execution of the steps. | 42; 5; 1 |
dt.synthetic.step.smartscape.id | smartscapeId | resource experimental The Smartscape ID of the monitor step. | HTTP_MONITOR_STEP-6349B98E1CD87352 |
dt.synthetic_engine.processing.end_timestamp | timestamp | experimental Display name: Synthetic engine processing end timestampThe end timestamp of the step/monitor execution as reported by executor. | 1629891693487 |
dt.synthetic_engine.processing.start_timestamp | timestamp | experimental Display name: Synthetic engine processing start timestampThe start timestamp of the step/monitor execution as reported by executor. | 1529891693487 |
event.id | string | stable Display name: Event IDUnique identifier string of an event; is stable across multiple refreshes and updates. | 5547782627070661074_1647601320000 |
primary_tags.__key__ | string | resource experimental Display name: Primary tagPrimary Grail tags are used to tag a resource in a meaningful way. __key__ is populated with the tag name, for example, primary_tags.ownership. In case of single-value tags, the value is a string. In case of multi-value tags, the value is an array of strings. | team-alpha; team-bravo |