Documentation
    Preparing search index...
    RumViewEvent: CommonProperties & ViewContainerSchema & {
        _dd: {
            cls?: { device_pixel_ratio?: number; [k: string]: unknown };
            configuration?: {
                start_session_replay_recording_manually?: boolean;
                [k: string]: unknown;
            };
            document_version: number;
            page_states?: {
                start: number;
                state: "active"
                | "passive"
                | "hidden"
                | "frozen"
                | "terminated";
                [k: string]: unknown;
            }[];
            profiling?: ProfilingInternalContextSchema;
            replay_stats?: {
                records_count?: number;
                segments_count?: number;
                segments_total_raw_size?: number;
                [k: string]: unknown;
            };
            [k: string]: unknown;
        };
        display?: {
            scroll?: {
                max_depth: number;
                max_depth_scroll_top: number;
                max_scroll_height: number;
                max_scroll_height_time: number;
                [k: string]: unknown;
            };
            [k: string]: unknown;
        };
        feature_flags?: { [k: string]: unknown };
        privacy?: {
            replay_level: "allow" | "mask" | "mask-user-input";
            [k: string]: unknown;
        };
        session?: {
            is_active?: boolean;
            sampled_for_replay?: boolean;
            [k: string]: unknown;
        };
        type: "view";
        view: {
            accessibility?: ViewAccessibilityProperties;
            action: { count: number; [k: string]: unknown };
            cpu_ticks_count?: number;
            cpu_ticks_per_second?: number;
            crash?: { count: number; [k: string]: unknown };
            cumulative_layout_shift?: number;
            cumulative_layout_shift_target_selector?: string;
            cumulative_layout_shift_time?: number;
            custom_timings?: { [k: string]: number };
            dom_complete?: number;
            dom_content_loaded?: number;
            dom_interactive?: number;
            error: { count: number; [k: string]: unknown };
            first_byte?: number;
            first_contentful_paint?: number;
            first_input_delay?: number;
            first_input_target_selector?: string;
            first_input_time?: number;
            flutter_build_time?: RumPerfMetric;
            flutter_raster_time?: RumPerfMetric;
            freeze_rate?: number;
            frozen_frame?: { count: number; [k: string]: unknown };
            frustration?: { count: number; [k: string]: unknown };
            in_foreground_periods?: {
                duration: number;
                start: number;
                [k: string]: unknown;
            }[];
            interaction_to_next_paint?: number;
            interaction_to_next_paint_target_selector?: string;
            interaction_to_next_paint_time?: number;
            interaction_to_next_view_time?: number;
            is_active?: boolean;
            is_slow_rendered?: boolean;
            js_refresh_rate?: RumPerfMetric;
            largest_contentful_paint?: number;
            largest_contentful_paint_target_selector?: string;
            load_event?: number;
            loading_time?: number;
            loading_type?: | "initial_load"
            | "route_change"
            | "activity_display"
            | "activity_redisplay"
            | "fragment_display"
            | "fragment_redisplay"
            | "view_controller_display"
            | "view_controller_redisplay";
            long_task?: { count: number; [k: string]: unknown };
            memory_average?: number;
            memory_max?: number;
            network_settled_time?: number;
            performance?: ViewPerformanceData;
            refresh_rate_average?: number;
            refresh_rate_min?: number;
            resource: { count: number; [k: string]: unknown };
            slow_frames?: { duration: number; start: number; [k: string]: unknown }[];
            slow_frames_rate?: number;
            time_spent: number;
            [k: string]: unknown;
        };
        [k: string]: unknown;
    }

    Schema of all properties of a View event

    Type declaration

    • [k: string]: unknown
    • Readonly_dd: {
          cls?: { device_pixel_ratio?: number; [k: string]: unknown };
          configuration?: {
              start_session_replay_recording_manually?: boolean;
              [k: string]: unknown;
          };
          document_version: number;
          page_states?: {
              start: number;
              state: "active"
              | "passive"
              | "hidden"
              | "frozen"
              | "terminated";
              [k: string]: unknown;
          }[];
          profiling?: ProfilingInternalContextSchema;
          replay_stats?: {
              records_count?: number;
              segments_count?: number;
              segments_total_raw_size?: number;
              [k: string]: unknown;
          };
          [k: string]: unknown;
      }

      Internal properties

      • Optional Readonlycls?: { device_pixel_ratio?: number; [k: string]: unknown }

        Additional information of the reported Cumulative Layout Shift

        • Optional Readonlydevice_pixel_ratio?: number

          Pixel ratio of the device where the layout shift was reported

      • Optional Readonlyconfiguration?: { start_session_replay_recording_manually?: boolean; [k: string]: unknown }

        Subset of the SDK configuration options in use during its execution

        • Optional Readonlystart_session_replay_recording_manually?: boolean

          Whether session replay recording configured to start manually

      • Readonlydocument_version: number

        Version of the update of the view event

      • Optional Readonlypage_states?: {
            start: number;
            state: "active" | "passive" | "hidden" | "frozen" | "terminated";
            [k: string]: unknown;
        }[]

        List of the page states during the view

      • Optionalprofiling?: ProfilingInternalContextSchema

        Profiling context

      • Optionalreplay_stats?: {
            records_count?: number;
            segments_count?: number;
            segments_total_raw_size?: number;
            [k: string]: unknown;
        }

        Debug metadata for Replay Sessions

        • Optionalrecords_count?: number

          The number of records produced during this view lifetime

        • Optionalsegments_count?: number

          The number of segments sent during this view lifetime

        • Optionalsegments_total_raw_size?: number

          The total size in bytes of the segments sent during this view lifetime

    • Optional Readonlydisplay?: {
          scroll?: {
              max_depth: number;
              max_depth_scroll_top: number;
              max_scroll_height: number;
              max_scroll_height_time: number;
              [k: string]: unknown;
          };
          [k: string]: unknown;
      }

      Display properties

      • Optional Readonlyscroll?: {
            max_depth: number;
            max_depth_scroll_top: number;
            max_scroll_height: number;
            max_scroll_height_time: number;
            [k: string]: unknown;
        }

        Scroll properties

        • Readonlymax_depth: number

          Distance between the top and the lowest point reached on this view (in pixels)

        • Readonlymax_depth_scroll_top: number

          Page scroll top (scrolled distance) when the maximum scroll depth was reached for this view (in pixels)

        • Readonlymax_scroll_height: number

          Maximum page scroll height (total height) for this view (in pixels)

        • Readonlymax_scroll_height_time: number

          Duration between the view start and the time the max scroll height was reached for this view (in nanoseconds)

    • Optional Readonlyfeature_flags?: { [k: string]: unknown }

      Feature flags properties

    • Optional Readonlyprivacy?: { replay_level: "allow" | "mask" | "mask-user-input"; [k: string]: unknown }

      Privacy properties

      • Readonlyreplay_level: "allow" | "mask" | "mask-user-input"

        The replay privacy level

    • Optional Readonlysession?: { is_active?: boolean; sampled_for_replay?: boolean; [k: string]: unknown }

      Session properties

      • Optional Readonlyis_active?: boolean

        Whether this session is currently active. Set to false to manually stop a session

      • Optional Readonlysampled_for_replay?: boolean

        Whether this session has been sampled for replay

    • Readonlytype: "view"

      RUM event type

    • Readonlyview: {
          accessibility?: ViewAccessibilityProperties;
          action: { count: number; [k: string]: unknown };
          cpu_ticks_count?: number;
          cpu_ticks_per_second?: number;
          crash?: { count: number; [k: string]: unknown };
          cumulative_layout_shift?: number;
          cumulative_layout_shift_target_selector?: string;
          cumulative_layout_shift_time?: number;
          custom_timings?: { [k: string]: number };
          dom_complete?: number;
          dom_content_loaded?: number;
          dom_interactive?: number;
          error: { count: number; [k: string]: unknown };
          first_byte?: number;
          first_contentful_paint?: number;
          first_input_delay?: number;
          first_input_target_selector?: string;
          first_input_time?: number;
          flutter_build_time?: RumPerfMetric;
          flutter_raster_time?: RumPerfMetric;
          freeze_rate?: number;
          frozen_frame?: { count: number; [k: string]: unknown };
          frustration?: { count: number; [k: string]: unknown };
          in_foreground_periods?: {
              duration: number;
              start: number;
              [k: string]: unknown;
          }[];
          interaction_to_next_paint?: number;
          interaction_to_next_paint_target_selector?: string;
          interaction_to_next_paint_time?: number;
          interaction_to_next_view_time?: number;
          is_active?: boolean;
          is_slow_rendered?: boolean;
          js_refresh_rate?: RumPerfMetric;
          largest_contentful_paint?: number;
          largest_contentful_paint_target_selector?: string;
          load_event?: number;
          loading_time?: number;
          loading_type?: | "initial_load"
          | "route_change"
          | "activity_display"
          | "activity_redisplay"
          | "fragment_display"
          | "fragment_redisplay"
          | "view_controller_display"
          | "view_controller_redisplay";
          long_task?: { count: number; [k: string]: unknown };
          memory_average?: number;
          memory_max?: number;
          network_settled_time?: number;
          performance?: ViewPerformanceData;
          refresh_rate_average?: number;
          refresh_rate_min?: number;
          resource: { count: number; [k: string]: unknown };
          slow_frames?: { duration: number; start: number; [k: string]: unknown }[];
          slow_frames_rate?: number;
          time_spent: number;
          [k: string]: unknown;
      }

      View properties

      • Optionalaccessibility?: ViewAccessibilityProperties

        Accessibility properties of the view

      • Readonlyaction: { count: number; [k: string]: unknown }

        Properties of the actions of the view

        • Readonlycount: number

          Number of actions that occurred on the view

      • Optional Readonlycpu_ticks_count?: number

        Total number of cpu ticks during the view’s lifetime

      • Optional Readonlycpu_ticks_per_second?: number

        Average number of cpu ticks per second during the view’s lifetime

      • Optional Readonlycrash?: { count: number; [k: string]: unknown }

        Properties of the crashes of the view

        • Readonlycount: number

          Number of crashes that occurred on the view

      • Optional Readonlycumulative_layout_shift?: number

        Total layout shift score that occurred on the view (deprecated in favor of view.performance.cls.score)

      • Optional Readonlycumulative_layout_shift_target_selector?: string

        CSS selector path of the first element (in document order) of the largest layout shift contributing to CLS (deprecated in favor of view.performance.cls.target_selector)

      • Optional Readonlycumulative_layout_shift_time?: number

        Duration in ns between start of the view and start of the largest layout shift contributing to CLS (deprecated in favor of view.performance.cls.timestamp)

      • Optional Readonlycustom_timings?: { [k: string]: number }

        User custom timings of the view. As timing name is used as facet path, it must contain only letters, digits, or the characters - _ . @ $

      • Optional Readonlydom_complete?: number

        Duration in ns to the complete parsing and loading of the document and its sub resources

      • Optional Readonlydom_content_loaded?: number

        Duration in ns to the complete parsing and loading of the document without its sub resources

      • Optional Readonlydom_interactive?: number

        Duration in ns to the end of the parsing of the document

      • Readonlyerror: { count: number; [k: string]: unknown }

        Properties of the errors of the view

        • Readonlycount: number

          Number of errors that occurred on the view

      • Optional Readonlyfirst_byte?: number

        Duration in ns to the response start of the document request

      • Optional Readonlyfirst_contentful_paint?: number

        Duration in ns to the first rendering (deprecated in favor of view.performance.fcp.timestamp)

      • Optional Readonlyfirst_input_delay?: number

        Duration in ns of the first input event delay (deprecated in favor of view.performance.fid.duration)

      • Optional Readonlyfirst_input_target_selector?: string

        CSS selector path of the first input target element (deprecated in favor of view.performance.fid.target_selector)

      • Optional Readonlyfirst_input_time?: number

        Duration in ns to the first input (deprecated in favor of view.performance.fid.timestamp)

      • Optionalflutter_build_time?: RumPerfMetric

        Time taken for Flutter 'build' methods.

      • Optionalflutter_raster_time?: RumPerfMetric

        Time taken for Flutter to rasterize the view.

      • Optional Readonlyfreeze_rate?: number

        Rate of freezes during the view’s lifetime (in seconds per hour)

      • Optional Readonlyfrozen_frame?: { count: number; [k: string]: unknown }

        Properties of the frozen frames of the view

        • Readonlycount: number

          Number of frozen frames that occurred on the view

      • Optional Readonlyfrustration?: { count: number; [k: string]: unknown }

        Properties of the frustrations of the view

        • Readonlycount: number

          Number of frustrations that occurred on the view

      • Optional Readonlyin_foreground_periods?: { duration: number; start: number; [k: string]: unknown }[]

        List of the periods of time the user had the view in foreground (focused in the browser)

      • Optional Readonlyinteraction_to_next_paint?: number

        Longest duration in ns between an interaction and the next paint (deprecated in favor of view.performance.inp.duration)

      • Optional Readonlyinteraction_to_next_paint_target_selector?: string

        CSS selector path of the interacted element corresponding to INP (deprecated in favor of view.performance.inp.target_selector)

      • Optional Readonlyinteraction_to_next_paint_time?: number

        Duration in ns between start of the view and start of the INP (deprecated in favor of view.performance.inp.timestamp)

      • Optional Readonlyinteraction_to_next_view_time?: number

        Duration in ns to from the last interaction on previous view to the moment the current view was displayed

      • Optional Readonlyis_active?: boolean

        Whether the View corresponding to this event is considered active

      • Optional Readonlyis_slow_rendered?: boolean

        Whether the View had a low average refresh rate

      • Optionaljs_refresh_rate?: RumPerfMetric

        The JavaScript refresh rate for React Native

      • Optional Readonlylargest_contentful_paint?: number

        Duration in ns to the largest contentful paint (deprecated in favor of view.performance.lcp.timestamp)

      • Optional Readonlylargest_contentful_paint_target_selector?: string

        CSS selector path of the largest contentful paint element (deprecated in favor of view.performance.lcp.target_selector)

      • Optional Readonlyload_event?: number

        Duration in ns to the end of the load event handler execution

      • Optional Readonlyloading_time?: number

        Duration in ns to the view is considered loaded

      • Optional Readonlyloading_type?:
            | "initial_load"
            | "route_change"
            | "activity_display"
            | "activity_redisplay"
            | "fragment_display"
            | "fragment_redisplay"
            | "view_controller_display"
            | "view_controller_redisplay"

        Type of the loading of the view

      • Optional Readonlylong_task?: { count: number; [k: string]: unknown }

        Properties of the long tasks of the view

        • Readonlycount: number

          Number of long tasks that occurred on the view

      • Optional Readonlymemory_average?: number

        Average memory used during the view lifetime (in bytes)

      • Optional Readonlymemory_max?: number

        Peak memory used during the view lifetime (in bytes)

      • Optional Readonlynetwork_settled_time?: number

        Duration in ns from the moment the view was started until all the initial network requests settled

      • Optionalperformance?: ViewPerformanceData

        Performance data. (Web Vitals, etc.)

      • Optional Readonlyrefresh_rate_average?: number

        Average refresh rate during the view’s lifetime (in frames per second)

      • Optional Readonlyrefresh_rate_min?: number

        Minimum refresh rate during the view’s lifetime (in frames per second)

      • Readonlyresource: { count: number; [k: string]: unknown }

        Properties of the resources of the view

        • Readonlycount: number

          Number of resources that occurred on the view

      • Optional Readonlyslow_frames?: { duration: number; start: number; [k: string]: unknown }[]

        List of slow frames during the view’s lifetime

      • Optional Readonlyslow_frames_rate?: number

        Rate of slow frames during the view’s lifetime (in milliseconds per second)

      • Readonlytime_spent: number

        Time spent on the view in ns