Documentation
    Preparing search index...

    Interface CommonProperties

    Schema of common properties of RUM events

    interface CommonProperties {
        _dd: {
            browser_sdk_version?: string;
            configuration?: {
                profiling_sample_rate?: number;
                session_replay_sample_rate?: number;
                session_sample_rate: number;
                [k: string]: unknown;
            };
            format_version: 2;
            sdk_name?: string;
            session?: {
                plan?: 1
                | 2;
                session_precondition?:
                    | "user_app_launch"
                    | "inactivity_timeout"
                    | "max_duration"
                    | "background_launch"
                    | "prewarm"
                    | "from_non_interactive_session"
                    | "explicit_stop";
                [k: string]: unknown;
            };
            [k: string]: unknown;
        };
        account?: { id: string; name?: string; [k: string]: unknown };
        application: { current_locale?: string; id: string; [k: string]: unknown };
        build_id?: string;
        build_version?: string;
        ci_test?: { test_execution_id: string; [k: string]: unknown };
        connectivity?: {
            cellular?: {
                carrier_name?: string;
                technology?: string;
                [k: string]: unknown;
            };
            effective_type?: "slow-2g"
            | "2g"
            | "3g"
            | "4g";
            interfaces?: (
                | "unknown"
                | "bluetooth"
                | "cellular"
                | "ethernet"
                | "none"
                | "wifi"
                | "wimax"
                | "other"
                | "mixed"
            )[];
            status: "connected"
            | "not_connected"
            | "maybe";
            [k: string]: unknown;
        };
        context?: { [k: string]: unknown };
        date: number;
        ddtags?: string;
        device?: {
            architecture?: string;
            battery_level?: number;
            brand?: string;
            brightness_level?: number;
            locale?: string;
            locales?: string[];
            model?: string;
            name?: string;
            power_saving_mode?: boolean;
            time_zone?: string;
            type?:
                | "other"
                | "mobile"
                | "desktop"
                | "tablet"
                | "tv"
                | "gaming_console"
                | "bot";
            [k: string]: unknown;
        };
        display?: {
            viewport?: { height: number; width: number; [k: string]: unknown };
            [k: string]: unknown;
        };
        os?: {
            build?: string;
            name: string;
            version: string;
            version_major: string;
            [k: string]: unknown;
        };
        service?: string;
        session: {
            has_replay?: boolean;
            id: string;
            type: "user"
            | "synthetics"
            | "ci_test";
            [k: string]: unknown;
        };
        source?: | "android"
        | "ios"
        | "browser"
        | "flutter"
        | "react-native"
        | "unity"
        | "kotlin-multiplatform"
        | "roku";
        synthetics?: {
            injected?: boolean;
            result_id: string;
            test_id: string;
            [k: string]: unknown;
        };
        usr?: {
            anonymous_id?: string;
            email?: string;
            id?: string;
            name?: string;
            [k: string]: unknown;
        };
        version?: string;
        view: {
            id: string;
            name?: string;
            referrer?: string;
            url: string;
            [k: string]: unknown;
        };
        [k: string]: unknown;
    }

    Indexable

    • [k: string]: unknown
    Index

    Properties

    _dd account? application build_id? build_version? ci_test? connectivity? context? date ddtags? device? display? os? service? session source? synthetics? usr? version? view

    Properties

    Readonly_dd

    _dd: {
        browser_sdk_version?: string;
        configuration?: {
            profiling_sample_rate?: number;
            session_replay_sample_rate?: number;
            session_sample_rate: number;
            [k: string]: unknown;
        };
        format_version: 2;
        sdk_name?: string;
        session?: {
            plan?: 1
            | 2;
            session_precondition?:
                | "user_app_launch"
                | "inactivity_timeout"
                | "max_duration"
                | "background_launch"
                | "prewarm"
                | "from_non_interactive_session"
                | "explicit_stop";
            [k: string]: unknown;
        };
        [k: string]: unknown;
    }

    Internal properties

    Type declaration

    • [k: string]: unknown
    • Optional Readonlybrowser_sdk_version?: string

      Browser SDK version

    • Optional Readonlyconfiguration?: {
          profiling_sample_rate?: number;
          session_replay_sample_rate?: number;
          session_sample_rate: number;
          [k: string]: unknown;
      }

      Subset of the SDK configuration options in use during its execution

      • Optional Readonlyprofiling_sample_rate?: number

        The percentage of views profiled

      • Optional Readonlysession_replay_sample_rate?: number

        The percentage of sessions with RUM & Session Replay pricing tracked

      • Readonlysession_sample_rate: number

        The percentage of sessions tracked

    • Readonlyformat_version: 2

      Version of the RUM event format

    • Optional Readonlysdk_name?: string

      SDK name (e.g. 'logs', 'rum', 'rum-slim', etc.)

    • Optionalsession?: {
          plan?: 1 | 2;
          session_precondition?:
              | "user_app_launch"
              | "inactivity_timeout"
              | "max_duration"
              | "background_launch"
              | "prewarm"
              | "from_non_interactive_session"
              | "explicit_stop";
          [k: string]: unknown;
      }

      Session-related internal properties

      • Optionalplan?: 1 | 2

        Session plan: 1 is the plan without replay, 2 is the plan with replay (deprecated)

      • Optional Readonlysession_precondition?:
            | "user_app_launch"
            | "inactivity_timeout"
            | "max_duration"
            | "background_launch"
            | "prewarm"
            | "from_non_interactive_session"
            | "explicit_stop"

        The precondition that led to the creation of the session

    account?: { id: string; name?: string; [k: string]: unknown }

    Account properties

    Type declaration

    • [k: string]: unknown
    • Readonlyid: string

      Identifier of the account

    • Optional Readonlyname?: string

      Name of the account

    application: { current_locale?: string; id: string; [k: string]: unknown }

    Application properties

    Type declaration

    • [k: string]: unknown
    • Optional Readonlycurrent_locale?: string

      The user's current locale as a language tag (language + region), computed from their preferences and the app's supported languages, e.g. 'es-FR'.

    • Readonlyid: string

      UUID of the application

    build_id?: string

    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?: string

    The build version for this application

    ci_test?: { test_execution_id: string; [k: string]: unknown }

    CI Visibility properties

    Type declaration

    • [k: string]: unknown
    • Readonlytest_execution_id: string

      The identifier of the current CI Visibility test execution

    connectivity?: {
        cellular?: {
            carrier_name?: string;
            technology?: string;
            [k: string]: unknown;
        };
        effective_type?: "slow-2g"
        | "2g"
        | "3g"
        | "4g";
        interfaces?: (
            | "unknown"
            | "bluetooth"
            | "cellular"
            | "ethernet"
            | "none"
            | "wifi"
            | "wimax"
            | "other"
            | "mixed"
        )[];
        status: "connected"
        | "not_connected"
        | "maybe";
        [k: string]: unknown;
    }

    Device connectivity properties

    Type declaration

    • [k: string]: unknown
    • Optional Readonlycellular?: { carrier_name?: string; technology?: string; [k: string]: unknown }

      Cellular connectivity properties

      • Optional Readonlycarrier_name?: string

        The name of the SIM carrier

      • Optional Readonlytechnology?: string

        The type of a radio technology used for cellular connection

    • Optional Readonlyeffective_type?: "slow-2g" | "2g" | "3g" | "4g"

      Cellular connection type reflecting the measured network performance

    • Optional Readonlyinterfaces?: (
          | "unknown"
          | "bluetooth"
          | "cellular"
          | "ethernet"
          | "none"
          | "wifi"
          | "wimax"
          | "other"
          | "mixed"
      )[]

      The list of available network interfaces

    • Readonlystatus: "connected" | "not_connected" | "maybe"

      Status of the device connectivity

    context?: { [k: string]: unknown }

    User provided context

    date: number

    Start of the event in ms from epoch

    ddtags?: string

    Tags of the event in key:value format, separated by commas (e.g. 'env:prod,version:1.2.3')

    device?: {
        architecture?: string;
        battery_level?: number;
        brand?: string;
        brightness_level?: number;
        locale?: string;
        locales?: string[];
        model?: string;
        name?: string;
        power_saving_mode?: boolean;
        time_zone?: string;
        type?:
            | "other"
            | "mobile"
            | "desktop"
            | "tablet"
            | "tv"
            | "gaming_console"
            | "bot";
        [k: string]: unknown;
    }

    Device properties

    Type declaration

    • [k: string]: unknown
    • Optional Readonlyarchitecture?: string

      The CPU architecture of the device that is reporting the error

    • Optional Readonlybattery_level?: number

      Current battery level of the device (0.0 to 1.0).

    • Optional Readonlybrand?: string

      Device marketing brand, e.g. Apple, OPPO, Xiaomi, etc.

    • Optional Readonlybrightness_level?: number

      Current screen brightness level (0.0 to 1.0).

    • Optional Readonlylocale?: string

      The user’s locale as a language tag combining language and region, e.g. 'en-US'.

    • Optional Readonlylocales?: string[]

      Ordered list of the user’s preferred system languages as IETF language tags.

    • Optional Readonlymodel?: string

      Device SKU model, e.g. Samsung SM-988GN, etc. Quite often name and model can be the same.

    • Optional Readonlyname?: string

      Device marketing name, e.g. Xiaomi Redmi Note 8 Pro, Pixel 5, etc.

    • Optional Readonlypower_saving_mode?: boolean

      Whether the device is in power saving mode.

    • Optional Readonlytime_zone?: string

      The device’s current time zone identifier, e.g. 'Europe/Berlin'.

    • Optional Readonlytype?: "other" | "mobile" | "desktop" | "tablet" | "tv" | "gaming_console" | "bot"

      Device type info

    display?: {
        viewport?: { height: number; width: number; [k: string]: unknown };
        [k: string]: unknown;
    }

    Display properties

    Type declaration

    • [k: string]: unknown
    • Optional Readonlyviewport?: { height: number; width: number; [k: string]: unknown }

      The viewport represents the rectangular area that is currently being viewed. Content outside the viewport is not visible onscreen until scrolled into view.

      • Readonlyheight: number

        Height of the viewport (in pixels)

      • Readonlywidth: number

        Width of the viewport (in pixels)

    os?: {
        build?: string;
        name: string;
        version: string;
        version_major: string;
        [k: string]: unknown;
    }

    Operating system properties

    Type declaration

    • [k: string]: unknown
    • Optional Readonlybuild?: string

      Operating system build number, e.g. 15D21

    • Readonlyname: string

      Operating system name, e.g. Android, iOS

    • Readonlyversion: string

      Full operating system version, e.g. 8.1.1

    • Readonlyversion_major: string

      Major operating system version, e.g. 8

    service?: string

    The service name for this application

    session: {
        has_replay?: boolean;
        id: string;
        type: "user" | "synthetics" | "ci_test";
        [k: string]: unknown;
    }

    Session properties

    Type declaration

    • [k: string]: unknown
    • Optional Readonlyhas_replay?: boolean

      Whether this session has a replay

    • Readonlyid: string

      UUID of the session

    • Readonlytype: "user" | "synthetics" | "ci_test"

      Type of the session

    source?:
        | "android"
        | "ios"
        | "browser"
        | "flutter"
        | "react-native"
        | "unity"
        | "kotlin-multiplatform"
        | "roku"

    The source of this event

    synthetics?: {
        injected?: boolean;
        result_id: string;
        test_id: string;
        [k: string]: unknown;
    }

    Synthetics properties

    Type declaration

    • [k: string]: unknown
    • Optional Readonlyinjected?: boolean

      Whether the event comes from a SDK instance injected by Synthetics

    • Readonlyresult_id: string

      The identifier of the current Synthetics test results

    • Readonlytest_id: string

      The identifier of the current Synthetics test

    usr?: {
        anonymous_id?: string;
        email?: string;
        id?: string;
        name?: string;
        [k: string]: unknown;
    }

    User properties

    Type declaration

    • [k: string]: unknown
    • Optional Readonlyanonymous_id?: string

      Identifier of the user across sessions

    • Optional Readonlyemail?: string

      Email of the user

    • Optional Readonlyid?: string

      Identifier of the user

    • Optional Readonlyname?: string

      Name of the user

    version?: string

    The version for this application

    view: {
        id: string;
        name?: string;
        referrer?: string;
        url: string;
        [k: string]: unknown;
    }

    View properties

    Type declaration

    • [k: string]: unknown
    • Readonlyid: string

      UUID of the view

    • Optionalname?: string

      User defined name of the view

    • Optionalreferrer?: string

      URL that linked to the initial view of the page

    • url: string

      URL of the view

    Settings

    On This Page

    Properties