monitor-api - v1.8.0
    Preparing search index...

    Interface WebVitalsCollectorConfig

    Configuration for the Web Vitals collector.

    interface WebVitalsCollectorConfig {
        attribution?: boolean;
        maxHistory: number;
        reportAllChanges: boolean;
        softNavigations?: boolean;
    }
    Index

    Properties

    attribution? maxHistory reportAllChanges softNavigations?

    Properties

    attribution?: boolean

    Adds a diagnostic breakdown to each metric, such as the LCP element or the interaction that caused INP. Loads the larger web-vitals/attribution build on demand. Defaults to false.

    maxHistory: number

    Maximum number of metric reports to retain.

    reportAllChanges: boolean

    Whether to report metric updates as values change. Defaults to true.

    softNavigations?: boolean

    Reports metrics separately for each soft navigation (an interaction that changes the URL and paints), in browsers that detect them (Chromium 151+). The latest value of each metric then belongs to the newest navigation; earlier ones stay in entries. Defaults to false.

    Settings

    Member Visibility

    On This Page

    Properties