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.
Semantic conventions for the user session model. The experimental label of some fields indicates that they're not yet stable and may change in the future. Also, this data model may evolve in the future by adding new fields. Times are cluster times; this is the time in the cluster's clock when the event was created.
Searches for all user sessions.
fetch user.sessions
| Attribute | Type | Description | Examples |
|---|---|---|---|
duration | duration | experimental The 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 | experimental End 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 | experimental Start 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_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 |
|---|---|---|---|
session_properties.__property_name__ | record | experimental 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 | experimental 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 The number of CSP rule violations. | 1 |
error.exception_count | long | experimental The 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 The number of HTTP request errors with an http.response.status_code of 400-499. | 1 |
error.http_5xx_count | long | experimental The number of HTTP request errors with an http.response.status_code of 500-599. | 1 |
| Attribute | Type | Description | Examples |
|---|---|---|---|
app.short_version | string | resource experimental The 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 experimental The 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 experimental The browser name. | Chrome |
browser.version | string | resource experimental The browser version. | Version 142.0.7444.176 |
browser.window.height | long | experimental The browser window's inner height, in pixels. | 384 |
browser.window.width | long | experimental The browser window's inner width, in pixels. | 2048 |
| Attribute | Type | Description | Examples |
|---|---|---|---|
os.name | string | resource experimental The OS name in a short, human-readable format. | iOS |
os.version | string | resource experimental The 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 experimental If set to true, the device is rooted or jailbroken. | false |
device.manufacturer | string | resource experimental The device manufacturer. | Apple |
device.model.identifier | string | resource experimental The device model identifier. | iPhone 17 Max Pro |
device.screen.height | long | resource experimental The device's screen height in its natural orientation. | 1152 |
device.screen.width | long | resource experimental The device's screen width in its natural orientation. | 2048 |
device.type | string | resource experimental The type of the device. | mobile |
device.type MUST be one of the following:
| Value | Description |
|---|---|
desktop | Desktop device, for example, a PC or a game console. |
mobile | Mobile device, for example, a smartphone or a tablet. |
| Attribute | Type | Description | Examples |
|---|---|---|---|
client.ip | ipAddress | experimental The 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 The 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 experimental The RUM application instance ID. (This was formerly called the "Visitor id", "internal user ID", and "rxVisitor cookie value".) | 3735928559; 1742973444821E7E6Q3E3SG28ATQPAGTT6T8HU92VFRFQ |
dt.rum.session.id | string | experimental A unique ID that represents the user session. | HOPCPWKILUKHFHWRRQGBHHPAFLUJUOSH-0; 23626166142035610_1-0 |
dt.rum.user_type | string | resource experimental The 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 |
|---|---|
real_user | The user event was produced by a real user. |
robot | The user event was produced by a bot user. |
synthetic | The user event was produced by a synthetic test. |
| Attribute | Type | Description | Examples |
|---|---|---|---|
dt.retain.size | long | experimental The size of the retained data point in bytes. | 2005 |
| Attribute | Type | Description | Examples |
|---|---|---|---|
geo.country.iso_code | string | resource experimental The 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 Identifies the source (such as API endpoints or OneAgent) used for ingesting the record into OpenPipeline. | /platform/ingest/v1/events; oneagent |