Documentation - v6.31.0
    Preparing search index...

    Type Alias RumViewEvent

    RumViewEvent: CommonProperties & ViewContainerSchema & StreamSchema & ViewProperties & {
        _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;
        };
        type: "view";
        view: {
            action: { [k: string]: unknown };
            error: { [k: string]: unknown };
            resource: { [k: string]: unknown };
            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

    • Readonlytype: "view"

      RUM event type

    • view: {
          action: { [k: string]: unknown };
          error: { [k: string]: unknown };
          resource: { [k: string]: unknown };
          time_spent: number;
          [k: string]: unknown;
      }