RUM JavaScript API - 1.347.4
    Preparing search index...

    Interface UserActionEndEventExperimental

    Data provided to the callback of [dynatrace.userActions.subscribe]API.UserActions.subscribe.

    interface UserActionEndEvent {
        end: number;
        metadata: {
            "[eventContextSymbol]"?: EventContext;
            "browser.frame.instance_id"?: string;
            "browser.frame.parent_instance_id"?: string;
            "browser.is_webdriver"?: boolean;
            "browser.tab.instance_id"?: string;
            "browser.window.device_pixel_ratio"?: number;
            "browser.window.height"?: number;
            "browser.window.width"?: number;
            "characteristics.has_user_action": true;
            "characteristics.is_api_reported"?: true;
            "cls.loading_state"?: LoadingState;
            "cls.status": BACKGROUNDED | NOT_SUPPORTED | REPORTED | "disabled";
            "cls.ui_element.shift_time"?: number;
            "cls.ui_element.shift_value"?: number;
            "cls.ui_element.tag_name"?: string;
            "cls.ui_element.xpath"?: string[];
            "cls.update_count"?: number;
            "cls.value"?: number;
            "device.battery.level"?: number;
            "device.orientation"?: string;
            "device.screen.height"?: number;
            "device.screen.width"?: number;
            "dt.rum.adk"?: string;
            "dt.rum.agent.type"?: "javascript";
            "dt.rum.agent.version"?: string;
            "dt.rum.browser.sid"?: string;
            "dt.rum.event.source.type"?: "hybrid";
            "dt.rum.instance.id"?: string;
            "dt.rum.instrumentation.id"?: string;
            "dt.rum.schema_version": "1.0.0";
            "dt.rum.sid"?: string;
            "dt.rum.sn"?: string;
            "dt.rum.sq"?: number;
            "dt.rum.us"?: string;
            "dt.support.api.has_dropped_custom_properties"?: boolean;
            "dt.support.api.has_dropped_properties"?: boolean;
            "dt.support.api.has_enrich_exception"?: boolean;
            "dt.support.api.overridden_fields"?: string[];
            "dt.support.has_nfn_values"?: boolean;
            "dt.support.is_capped_duration"?: boolean;
            "error.csp_violation_count"?: number;
            "error.dropped_exception_count"?: number;
            "error.exception_count"?: number;
            "error.http_4xx_count"?: number;
            "error.http_5xx_count"?: number;
            "error.http_other_count"?: number;
            "fcp.loading_state"?: LoadingState;
            "fcp.status"?:
                | BACKGROUNDED
                | NOT_REPORTED
                | NOT_SUPPORTED
                | REPORTED
                | "disabled";
            "fcp.value"?: number;
            "fid.cancelable"?: boolean;
            "fid.duration"?: number;
            "fid.loading_state"?: LoadingState;
            "fid.name"?: string;
            "fid.processing_end"?: number;
            "fid.processing_start"?: number;
            "fid.start_time"?: number;
            "fid.status": NOT_REPORTED | NOT_SUPPORTED | REPORTED | "disabled";
            "fid.ui_element.tag_name"?: string;
            "fid.ui_element.xpath"?: string[];
            "fp.loading_state"?: LoadingState;
            "fp.status"?:
                | BACKGROUNDED
                | NOT_REPORTED
                | NOT_SUPPORTED
                | REPORTED
                | "disabled";
            "fp.value"?: number;
            "inp.cancelable"?: boolean;
            "inp.duration"?: number;
            "inp.interaction_count"?: number;
            "inp.loading_state"?: LoadingState;
            "inp.name"?: string;
            "inp.processing_end"?: number;
            "inp.processing_start"?: number;
            "inp.start_time"?: number;
            "inp.status":
                | BELOW_THRESHOLD
                | NOT_REPORTED
                | NOT_SUPPORTED
                | REPORTED
                | "disabled";
            "inp.ui_element.tag_name"?: string;
            "inp.ui_element.xpath"?: string[];
            "inp.update_count"?: number;
            "lcp.id"?: string;
            "lcp.load_time"?: number;
            "lcp.render_time"?: number;
            "lcp.resource.load_delay"?: number;
            "lcp.resource.load_duration"?: number;
            "lcp.size"?: number;
            "lcp.start_time"?: number;
            "lcp.status":
                | BACKGROUNDED
                | NOT_REPORTED
                | NOT_SUPPORTED
                | REPORTED
                | "disabled";
            "lcp.ui_element.render_delay"?: number;
            "lcp.ui_element.tag_name"?: string;
            "lcp.ui_element.xpath"?: string[];
            "lcp.update_count"?: number;
            "lcp.url"?: string;
            "long_task.all.avg_duration"?: number;
            "long_task.all.count"?: number;
            "long_task.all.slowest_occurrences"?: SlowLongTaskOccurrence[];
            "long_task.self.avg_duration"?: number;
            "long_task.self.count"?: number;
            "long_task.self.slowest_occurrences"?: SlowLongTaskOccurrence[];
            "long_task.status": LongTaskMetricStatus | "disabled";
            "page.detected_name"?: string;
            "page.instance_id"?: string;
            "page.title"?: string;
            "page.url.full"?: string;
            "ttfb.cache_duration"?: number;
            "ttfb.connection_duration"?: number;
            "ttfb.dns_duration"?: number;
            "ttfb.request_duration"?: number;
            "ttfb.status"?: TTFBMetricStatus | "disabled";
            "ttfb.value"?: number;
            "ttfb.waiting_duration"?: number;
            "user_action.complete_reason": UserActionCompleteReason;
            "user_action.custom_name"?: string;
            "user_action.hard_navigation_count": number;
            "user_action.instance_id": string;
            "user_action.interrupted_by_instance_id"?: string;
            "user_action.interrupted_instance_id"?: string;
            "user_action.mutation_count": number;
            "user_action.requests.count": number;
            "user_action.requests.data_url_request_count": number;
            "user_action.requests.pending_request_count": number;
            "user_action.resources.audio.count"?: number;
            "user_action.resources.beacon.count"?: number;
            "user_action.resources.body.count"?: number;
            "user_action.resources.count": number;
            "user_action.resources.css.count"?: number;
            "user_action.resources.early-hint.count"?: number;
            "user_action.resources.embed.count"?: number;
            "user_action.resources.fetch.count"?: number;
            "user_action.resources.frame.count"?: number;
            "user_action.resources.icon.count"?: number;
            "user_action.resources.iframe.count"?: number;
            "user_action.resources.image.count"?: number;
            "user_action.resources.img.count"?: number;
            "user_action.resources.input.count"?: number;
            "user_action.resources.link.count"?: number;
            "user_action.resources.navigation.count"?: number;
            "user_action.resources.object.count"?: number;
            "user_action.resources.other.count"?: number;
            "user_action.resources.ping.count"?: number;
            "user_action.resources.script.count"?: number;
            "user_action.resources.track.count"?: number;
            "user_action.resources.video.count"?: number;
            "user_action.resources.xmlhttprequest.count"?: number;
            "user_action.soft_navigation_count": number;
            "user_action.source.action.instance_id"?: string;
            "user_action.source.action.type"?: UserActionType;
            "user_action.source.dom_event.is_trusted"?: boolean;
            "user_action.source.interaction.type"?: UserInteraction;
            "user_action.source.is_referrer_mismatch"?: boolean;
            "user_action.source.start_time"?: number;
            "user_action.source.ui_element.custom_name"?: string;
            "user_action.source.ui_element.detected_name"?: string;
            "user_action.source.ui_element.name_origin"?: string;
            "user_action.source.ui_element.tag_name"?: string;
            "user_action.source.view.detected_name"?: string;
            "user_action.source.view.instance_id"?: string;
            "user_action.source.view.url.full"?: string;
            "user_session.inactive"?: boolean;
            "user.identifier"?: string;
            "view.detected_name"?: string;
            "view.instance_id"?: string;
            "view.source.detected_name"?: string;
            "view.source.instance_id"?: string;
            "view.source.url.full"?: string;
            "view.url.full"?: string;
            "visibility.state"?: PageVisibilityState;
            [key: `event_properties.${string}`]: string | number | false | true;
        };
    }
    Index

    Properties

    Properties

    end: number

    The time the user action ended. In case of no activity this will hold the value of the action start time.

    metadata: {
        "[eventContextSymbol]"?: EventContext;
        "browser.frame.instance_id"?: string;
        "browser.frame.parent_instance_id"?: string;
        "browser.is_webdriver"?: boolean;
        "browser.tab.instance_id"?: string;
        "browser.window.device_pixel_ratio"?: number;
        "browser.window.height"?: number;
        "browser.window.width"?: number;
        "characteristics.has_user_action": true;
        "characteristics.is_api_reported"?: true;
        "cls.loading_state"?: LoadingState;
        "cls.status": BACKGROUNDED | NOT_SUPPORTED | REPORTED | "disabled";
        "cls.ui_element.shift_time"?: number;
        "cls.ui_element.shift_value"?: number;
        "cls.ui_element.tag_name"?: string;
        "cls.ui_element.xpath"?: string[];
        "cls.update_count"?: number;
        "cls.value"?: number;
        "device.battery.level"?: number;
        "device.orientation"?: string;
        "device.screen.height"?: number;
        "device.screen.width"?: number;
        "dt.rum.adk"?: string;
        "dt.rum.agent.type"?: "javascript";
        "dt.rum.agent.version"?: string;
        "dt.rum.browser.sid"?: string;
        "dt.rum.event.source.type"?: "hybrid";
        "dt.rum.instance.id"?: string;
        "dt.rum.instrumentation.id"?: string;
        "dt.rum.schema_version": "1.0.0";
        "dt.rum.sid"?: string;
        "dt.rum.sn"?: string;
        "dt.rum.sq"?: number;
        "dt.rum.us"?: string;
        "dt.support.api.has_dropped_custom_properties"?: boolean;
        "dt.support.api.has_dropped_properties"?: boolean;
        "dt.support.api.has_enrich_exception"?: boolean;
        "dt.support.api.overridden_fields"?: string[];
        "dt.support.has_nfn_values"?: boolean;
        "dt.support.is_capped_duration"?: boolean;
        "error.csp_violation_count"?: number;
        "error.dropped_exception_count"?: number;
        "error.exception_count"?: number;
        "error.http_4xx_count"?: number;
        "error.http_5xx_count"?: number;
        "error.http_other_count"?: number;
        "fcp.loading_state"?: LoadingState;
        "fcp.status"?:
            | BACKGROUNDED
            | NOT_REPORTED
            | NOT_SUPPORTED
            | REPORTED
            | "disabled";
        "fcp.value"?: number;
        "fid.cancelable"?: boolean;
        "fid.duration"?: number;
        "fid.loading_state"?: LoadingState;
        "fid.name"?: string;
        "fid.processing_end"?: number;
        "fid.processing_start"?: number;
        "fid.start_time"?: number;
        "fid.status": NOT_REPORTED | NOT_SUPPORTED | REPORTED | "disabled";
        "fid.ui_element.tag_name"?: string;
        "fid.ui_element.xpath"?: string[];
        "fp.loading_state"?: LoadingState;
        "fp.status"?:
            | BACKGROUNDED
            | NOT_REPORTED
            | NOT_SUPPORTED
            | REPORTED
            | "disabled";
        "fp.value"?: number;
        "inp.cancelable"?: boolean;
        "inp.duration"?: number;
        "inp.interaction_count"?: number;
        "inp.loading_state"?: LoadingState;
        "inp.name"?: string;
        "inp.processing_end"?: number;
        "inp.processing_start"?: number;
        "inp.start_time"?: number;
        "inp.status":
            | BELOW_THRESHOLD
            | NOT_REPORTED
            | NOT_SUPPORTED
            | REPORTED
            | "disabled";
        "inp.ui_element.tag_name"?: string;
        "inp.ui_element.xpath"?: string[];
        "inp.update_count"?: number;
        "lcp.id"?: string;
        "lcp.load_time"?: number;
        "lcp.render_time"?: number;
        "lcp.resource.load_delay"?: number;
        "lcp.resource.load_duration"?: number;
        "lcp.size"?: number;
        "lcp.start_time"?: number;
        "lcp.status":
            | BACKGROUNDED
            | NOT_REPORTED
            | NOT_SUPPORTED
            | REPORTED
            | "disabled";
        "lcp.ui_element.render_delay"?: number;
        "lcp.ui_element.tag_name"?: string;
        "lcp.ui_element.xpath"?: string[];
        "lcp.update_count"?: number;
        "lcp.url"?: string;
        "long_task.all.avg_duration"?: number;
        "long_task.all.count"?: number;
        "long_task.all.slowest_occurrences"?: SlowLongTaskOccurrence[];
        "long_task.self.avg_duration"?: number;
        "long_task.self.count"?: number;
        "long_task.self.slowest_occurrences"?: SlowLongTaskOccurrence[];
        "long_task.status": LongTaskMetricStatus | "disabled";
        "page.detected_name"?: string;
        "page.instance_id"?: string;
        "page.title"?: string;
        "page.url.full"?: string;
        "ttfb.cache_duration"?: number;
        "ttfb.connection_duration"?: number;
        "ttfb.dns_duration"?: number;
        "ttfb.request_duration"?: number;
        "ttfb.status"?: TTFBMetricStatus | "disabled";
        "ttfb.value"?: number;
        "ttfb.waiting_duration"?: number;
        "user_action.complete_reason": UserActionCompleteReason;
        "user_action.custom_name"?: string;
        "user_action.hard_navigation_count": number;
        "user_action.instance_id": string;
        "user_action.interrupted_by_instance_id"?: string;
        "user_action.interrupted_instance_id"?: string;
        "user_action.mutation_count": number;
        "user_action.requests.count": number;
        "user_action.requests.data_url_request_count": number;
        "user_action.requests.pending_request_count": number;
        "user_action.resources.audio.count"?: number;
        "user_action.resources.beacon.count"?: number;
        "user_action.resources.body.count"?: number;
        "user_action.resources.count": number;
        "user_action.resources.css.count"?: number;
        "user_action.resources.early-hint.count"?: number;
        "user_action.resources.embed.count"?: number;
        "user_action.resources.fetch.count"?: number;
        "user_action.resources.frame.count"?: number;
        "user_action.resources.icon.count"?: number;
        "user_action.resources.iframe.count"?: number;
        "user_action.resources.image.count"?: number;
        "user_action.resources.img.count"?: number;
        "user_action.resources.input.count"?: number;
        "user_action.resources.link.count"?: number;
        "user_action.resources.navigation.count"?: number;
        "user_action.resources.object.count"?: number;
        "user_action.resources.other.count"?: number;
        "user_action.resources.ping.count"?: number;
        "user_action.resources.script.count"?: number;
        "user_action.resources.track.count"?: number;
        "user_action.resources.video.count"?: number;
        "user_action.resources.xmlhttprequest.count"?: number;
        "user_action.soft_navigation_count": number;
        "user_action.source.action.instance_id"?: string;
        "user_action.source.action.type"?: UserActionType;
        "user_action.source.dom_event.is_trusted"?: boolean;
        "user_action.source.interaction.type"?: UserInteraction;
        "user_action.source.is_referrer_mismatch"?: boolean;
        "user_action.source.start_time"?: number;
        "user_action.source.ui_element.custom_name"?: string;
        "user_action.source.ui_element.detected_name"?: string;
        "user_action.source.ui_element.name_origin"?: string;
        "user_action.source.ui_element.tag_name"?: string;
        "user_action.source.view.detected_name"?: string;
        "user_action.source.view.instance_id"?: string;
        "user_action.source.view.url.full"?: string;
        "user_session.inactive"?: boolean;
        "user.identifier"?: string;
        "view.detected_name"?: string;
        "view.instance_id"?: string;
        "view.source.detected_name"?: string;
        "view.source.instance_id"?: string;
        "view.source.url.full"?: string;
        "view.url.full"?: string;
        "visibility.state"?: PageVisibilityState;
        [key: `event_properties.${string}`]: string | number | false | true;
    }

    Metadata about the user action.

    Type Declaration

    • [key: `event_properties.${string}`]: string | number | false | true
    • Optional[eventContextSymbol]?: EventContext
    • Optionalbrowser.frame.instance_id?: string
    • Optionalbrowser.frame.parent_instance_id?: string
    • Optionalbrowser.is_webdriver?: boolean
    • Optionalbrowser.tab.instance_id?: string
    • Optionalbrowser.window.device_pixel_ratio?: number
    • Optionalbrowser.window.height?: number
    • Optionalbrowser.window.width?: number
    • characteristics.has_user_action: true
    • Optionalcharacteristics.is_api_reported?: true
    • Optionalcls.loading_state?: LoadingState
    • cls.status: BACKGROUNDED | NOT_SUPPORTED | REPORTED | "disabled"
    • Optionalcls.ui_element.shift_time?: number
    • Optionalcls.ui_element.shift_value?: number
    • Optionalcls.ui_element.tag_name?: string
    • Optionalcls.ui_element.xpath?: string[]
    • Optionalcls.update_count?: number
    • Optionalcls.value?: number
    • Optionaldevice.battery.level?: number
    • Optionaldevice.orientation?: string
    • Optionaldevice.screen.height?: number
    • Optionaldevice.screen.width?: number
    • Optionaldt.rum.adk?: string
    • Optionaldt.rum.agent.type?: "javascript"
    • Optionaldt.rum.agent.version?: string
    • Optionaldt.rum.browser.sid?: string
    • Optionaldt.rum.event.source.type?: "hybrid"
    • Optionaldt.rum.instance.id?: string
    • Optionaldt.rum.instrumentation.id?: string
    • dt.rum.schema_version: "1.0.0"
    • Optionaldt.rum.sid?: string
    • Optionaldt.rum.sn?: string
    • Optionaldt.rum.sq?: number
    • Optionaldt.rum.us?: string
    • Optionaldt.support.api.has_dropped_custom_properties?: boolean
    • Optionaldt.support.api.has_dropped_properties?: boolean
    • Optionaldt.support.api.has_enrich_exception?: boolean
    • Optionaldt.support.api.overridden_fields?: string[]
    • Optionaldt.support.has_nfn_values?: boolean
    • Optionaldt.support.is_capped_duration?: boolean
    • Optionalerror.csp_violation_count?: number
    • Optionalerror.dropped_exception_count?: number
    • Optionalerror.exception_count?: number
    • Optionalerror.http_4xx_count?: number
    • Optionalerror.http_5xx_count?: number
    • Optionalerror.http_other_count?: number
    • Optionalfcp.loading_state?: LoadingState
    • Optionalfcp.status?: BACKGROUNDED | NOT_REPORTED | NOT_SUPPORTED | REPORTED | "disabled"
    • Optionalfcp.value?: number
    • Optionalfid.cancelable?: boolean
    • Optionalfid.duration?: number
    • Optionalfid.loading_state?: LoadingState
    • Optionalfid.name?: string
    • Optionalfid.processing_end?: number
    • Optionalfid.processing_start?: number
    • Optionalfid.start_time?: number
    • fid.status: NOT_REPORTED | NOT_SUPPORTED | REPORTED | "disabled"
    • Optionalfid.ui_element.tag_name?: string
    • Optionalfid.ui_element.xpath?: string[]
    • Optionalfp.loading_state?: LoadingState
    • Optionalfp.status?: BACKGROUNDED | NOT_REPORTED | NOT_SUPPORTED | REPORTED | "disabled"
    • Optionalfp.value?: number
    • Optionalinp.cancelable?: boolean
    • Optionalinp.duration?: number
    • Optionalinp.interaction_count?: number
    • Optionalinp.loading_state?: LoadingState
    • Optionalinp.name?: string
    • Optionalinp.processing_end?: number
    • Optionalinp.processing_start?: number
    • Optionalinp.start_time?: number
    • inp.status: BELOW_THRESHOLD | NOT_REPORTED | NOT_SUPPORTED | REPORTED | "disabled"
    • Optionalinp.ui_element.tag_name?: string
    • Optionalinp.ui_element.xpath?: string[]
    • Optionalinp.update_count?: number
    • Optionallcp.id?: string
    • Optionallcp.load_time?: number
    • Optionallcp.render_time?: number
    • Optionallcp.resource.load_delay?: number
    • Optionallcp.resource.load_duration?: number
    • Optionallcp.size?: number
    • Optionallcp.start_time?: number
    • lcp.status: BACKGROUNDED | NOT_REPORTED | NOT_SUPPORTED | REPORTED | "disabled"
    • Optionallcp.ui_element.render_delay?: number
    • Optionallcp.ui_element.tag_name?: string
    • Optionallcp.ui_element.xpath?: string[]
    • Optionallcp.update_count?: number
    • Optionallcp.url?: string
    • Optionallong_task.all.avg_duration?: number
    • Optionallong_task.all.count?: number
    • Optionallong_task.all.slowest_occurrences?: SlowLongTaskOccurrence[]
    • Optionallong_task.self.avg_duration?: number
    • Optionallong_task.self.count?: number
    • Optionallong_task.self.slowest_occurrences?: SlowLongTaskOccurrence[]
    • long_task.status: LongTaskMetricStatus | "disabled"
    • Optionalpage.detected_name?: string
    • Optionalpage.instance_id?: string
    • Optionalpage.title?: string
    • Optionalpage.url.full?: string
    • Optionalttfb.cache_duration?: number
    • Optionalttfb.connection_duration?: number
    • Optionalttfb.dns_duration?: number
    • Optionalttfb.request_duration?: number
    • Optionalttfb.status?: TTFBMetricStatus | "disabled"
    • Optionalttfb.value?: number
    • Optionalttfb.waiting_duration?: number
    • user_action.complete_reason: UserActionCompleteReason
    • Optionaluser_action.custom_name?: string
    • user_action.hard_navigation_count: number
    • user_action.instance_id: string
    • Optionaluser_action.interrupted_by_instance_id?: string
    • Optionaluser_action.interrupted_instance_id?: string
    • user_action.mutation_count: number
    • user_action.requests.count: number
    • user_action.requests.data_url_request_count: number
    • user_action.requests.pending_request_count: number
    • Optionaluser_action.resources.audio.count?: number
    • Optionaluser_action.resources.beacon.count?: number
    • Optionaluser_action.resources.body.count?: number
    • user_action.resources.count: number
    • Optionaluser_action.resources.css.count?: number
    • Optionaluser_action.resources.early-hint.count?: number
    • Optionaluser_action.resources.embed.count?: number
    • Optionaluser_action.resources.fetch.count?: number
    • Optionaluser_action.resources.frame.count?: number
    • Optionaluser_action.resources.icon.count?: number
    • Optionaluser_action.resources.iframe.count?: number
    • Optionaluser_action.resources.image.count?: number
    • Optionaluser_action.resources.img.count?: number
    • Optionaluser_action.resources.input.count?: number
    • Optionaluser_action.resources.link.count?: number
    • Optionaluser_action.resources.navigation.count?: number
    • Optionaluser_action.resources.object.count?: number
    • Optionaluser_action.resources.other.count?: number
    • Optionaluser_action.resources.ping.count?: number
    • Optionaluser_action.resources.script.count?: number
    • Optionaluser_action.resources.track.count?: number
    • Optionaluser_action.resources.video.count?: number
    • Optionaluser_action.resources.xmlhttprequest.count?: number
    • user_action.soft_navigation_count: number
    • Optionaluser_action.source.action.instance_id?: string
    • Optionaluser_action.source.action.type?: UserActionType
    • Optionaluser_action.source.dom_event.is_trusted?: boolean
    • Optionaluser_action.source.interaction.type?: UserInteraction
    • Optionaluser_action.source.is_referrer_mismatch?: boolean

      Set to true when the source context was kept even though the previous page's stored view URL did not match document.referrer

    • Optionaluser_action.source.start_time?: number
    • Optionaluser_action.source.ui_element.custom_name?: string
    • Optionaluser_action.source.ui_element.detected_name?: string
    • Optionaluser_action.source.ui_element.name_origin?: string
    • Optionaluser_action.source.ui_element.tag_name?: string
    • Optionaluser_action.source.view.detected_name?: string
    • Optionaluser_action.source.view.instance_id?: string
    • Optionaluser_action.source.view.url.full?: string
    • Optionaluser_session.inactive?: boolean
    • Optionaluser.identifier?: string
    • Optionalview.detected_name?: string
    • Optionalview.instance_id?: string
    • Optionalview.source.detected_name?: string
    • Optionalview.source.instance_id?: string
    • Optionalview.source.url.full?: string
    • Optionalview.url.full?: string
    • Optionalvisibility.state?: PageVisibilityState