Home > @datadog/browser-rum > CommonProperties
Schema of common properties of RUM events
Signature:
export interface CommonProperties
| Property | Modifiers | Type | Description |
|---|---|---|---|
| _dd | `readonly` | { readonly format_version: 2; session?: { plan?: 1 | 2; readonly session_precondition?: 'user_app_launch' | 'inactivity_timeout' | 'max_duration' | 'background_launch' | 'prewarm' | 'from_non_interactive_session' | 'explicit_stop'; [k: string]: unknown; }; readonly configuration?: { readonly session_sample_rate: number; readonly session_replay_sample_rate?: number; [k: string]: unknown; }; readonly browser_sdk_version?: string; [k: string]: unknown; } | Internal properties |
| account? | `readonly` | { readonly id: string; readonly name?: string; [k: string]: unknown; } | (Optional) Account properties |
| application | `readonly` | { readonly id: string; [k: string]: unknown; } | Application properties |
| build_id? | `readonly` | string | (Optional) Generated unique ID of the application build. Unlike version or build_version this field is not meant to be coming from the user, but rather generated by the tooling for each build. |
| build_version? | `readonly` | string | (Optional) The build version for this application |
| ci_test? | `readonly` | { readonly test_execution_id: string; [k: string]: unknown; } | (Optional) CI Visibility properties |
| connectivity? | { readonly status: 'connected' | 'not_connected' | 'maybe'; readonly interfaces?: ('bluetooth' | 'cellular' | 'ethernet' | 'wifi' | 'wimax' | 'mixed' | 'other' | 'unknown' | 'none')[]; readonly effective_type?: 'slow-2g' | '2g' | '3g' | '4g'; readonly cellular?: { readonly technology?: string; readonly carrier_name?: string; [k: string]: unknown; }; [k: string]: unknown; } | (Optional) Device connectivity properties | |
| context? | { [k: string]: unknown; } | (Optional) User provided context | |
| date | `readonly` | number | Start of the event in ms from epoch |
| device? | { readonly type: 'mobile' | 'desktop' | 'tablet' | 'tv' | 'gaming_console' | 'bot' | 'other'; readonly name?: string; readonly model?: string; readonly brand?: string; readonly architecture?: string; [k: string]: unknown; } | (Optional) Device properties | |
| display? | { readonly viewport?: { readonly width: number; readonly height: number; [k: string]: unknown; }; [k: string]: unknown; } | (Optional) Display properties | |
| os? | { readonly name: string; readonly version: string; readonly build?: string; readonly version_major: string; [k: string]: unknown; } | (Optional) Operating system properties | |
| service? | string | (Optional) The service name for this application | |
| session | `readonly` | { readonly id: string; readonly type: 'user' | 'synthetics' | 'ci_test'; readonly has_replay?: boolean; [k: string]: unknown; } | Session properties |
| source? | `readonly` | 'android' | 'ios' | 'browser' | 'flutter' | 'react-native' | 'roku' | 'unity' | 'kotlin-multiplatform' | (Optional) The source of this event |
| synthetics? | `readonly` | { readonly test_id: string; readonly result_id: string; readonly injected?: boolean; [k: string]: unknown; } | (Optional) Synthetics properties |
| usr? | `readonly` | { readonly id?: string; readonly name?: string; readonly email?: string; readonly anonymous_id?: string; [k: string]: unknown; } | (Optional) User properties |
| version? | string | (Optional) The version for this application | |
| view | `readonly` | { readonly id: string; referrer?: string; url: string; name?: string; [k: string]: unknown; } | View properties |