Documentation - v7.0.0
    Preparing search index...

    Type Alias RumResourceEvent

    RumResourceEvent: CommonProperties & ActionChildProperties & ViewContainerSchema & {
        _dd?: RumTrace & { discarded?: boolean; [k: string]: unknown };
        resource: {
            connect?: { duration: number; start: number; [k: string]: unknown };
            decoded_body_size?: number;
            delivery_type?: "cache" | "navigational-prefetch" | "other";
            dns?: { duration: number; start: number; [k: string]: unknown };
            download?: { duration: number; start: number; [k: string]: unknown };
            duration?: number;
            encoded_body_size?: number;
            first_byte?: { duration: number; start: number; [k: string]: unknown };
            graphql?: RumGraphql;
            id?: string;
            method?:
                | "POST"
                | "GET"
                | "HEAD"
                | "PUT"
                | "DELETE"
                | "PATCH"
                | "TRACE"
                | "OPTIONS"
                | "CONNECT";
            protocol?: string;
            provider?: {
                domain?: string;
                name?: string;
                type?: | "ad"
                | "advertising"
                | "analytics"
                | "cdn"
                | "content"
                | "customer-success"
                | "first party"
                | "hosting"
                | "marketing"
                | "other"
                | "social"
                | "tag-manager"
                | "utility"
                | "video";
                [k: string]: unknown;
            };
            redirect?: { duration: number; start: number; [k: string]: unknown };
            render_blocking_status?: "blocking" | "non-blocking";
            request?: {
                decoded_body_size?: number;
                encoded_body_size?: number;
                headers?: { [k: string]: string };
                [k: string]: unknown;
            };
            response?: { headers?: { [k: string]: string }; [k: string]: unknown };
            size?: number;
            ssl?: { duration: number; start: number; [k: string]: unknown };
            status_code?: number;
            transfer_size?: number;
            type:
                | "document"
                | "xhr"
                | "beacon"
                | "fetch"
                | "css"
                | "js"
                | "image"
                | "font"
                | "media"
                | "other"
                | "native";
            url: string;
            worker?: { duration: number; start: number; [k: string]: unknown };
            [k: string]: unknown;
        };
        type: "resource";
        [k: string]: unknown;
    }

    Schema of all properties of a Resource event

    Type Declaration

    • [k: string]: unknown
    • Optional Readonly_dd?: RumTrace & { discarded?: boolean; [k: string]: unknown }

      Internal properties

    • Readonlyresource: {
          connect?: { duration: number; start: number; [k: string]: unknown };
          decoded_body_size?: number;
          delivery_type?: "cache" | "navigational-prefetch" | "other";
          dns?: { duration: number; start: number; [k: string]: unknown };
          download?: { duration: number; start: number; [k: string]: unknown };
          duration?: number;
          encoded_body_size?: number;
          first_byte?: { duration: number; start: number; [k: string]: unknown };
          graphql?: RumGraphql;
          id?: string;
          method?:
              | "POST"
              | "GET"
              | "HEAD"
              | "PUT"
              | "DELETE"
              | "PATCH"
              | "TRACE"
              | "OPTIONS"
              | "CONNECT";
          protocol?: string;
          provider?: {
              domain?: string;
              name?: string;
              type?: | "ad"
              | "advertising"
              | "analytics"
              | "cdn"
              | "content"
              | "customer-success"
              | "first party"
              | "hosting"
              | "marketing"
              | "other"
              | "social"
              | "tag-manager"
              | "utility"
              | "video";
              [k: string]: unknown;
          };
          redirect?: { duration: number; start: number; [k: string]: unknown };
          render_blocking_status?: "blocking" | "non-blocking";
          request?: {
              decoded_body_size?: number;
              encoded_body_size?: number;
              headers?: { [k: string]: string };
              [k: string]: unknown;
          };
          response?: { headers?: { [k: string]: string }; [k: string]: unknown };
          size?: number;
          ssl?: { duration: number; start: number; [k: string]: unknown };
          status_code?: number;
          transfer_size?: number;
          type:
              | "document"
              | "xhr"
              | "beacon"
              | "fetch"
              | "css"
              | "js"
              | "image"
              | "font"
              | "media"
              | "other"
              | "native";
          url: string;
          worker?: { duration: number; start: number; [k: string]: unknown };
          [k: string]: unknown;
      }

      Resource properties

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

        Connect phase properties

        • Readonlyduration: number

          Duration in ns of the resource connect phase

        • Readonlystart: number

          Duration in ns between start of the request and start of the connect phase

      • Optional Readonlydecoded_body_size?: number

        Size in octet of the response body after removing any applied encoding

      • Optional Readonlydelivery_type?: "cache" | "navigational-prefetch" | "other"

        Delivery type of the resource

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

        DNS phase properties

        • Readonlyduration: number

          Duration in ns of the resource dns phase

        • Readonlystart: number

          Duration in ns between start of the request and start of the dns phase

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

        Download phase properties

        • Readonlyduration: number

          Duration in ns of the resource download phase

        • Readonlystart: number

          Duration in ns between start of the request and start of the download phase

      • Optional Readonlyduration?: number

        Duration of the resource

      • Optional Readonlyencoded_body_size?: number

        Size in octet of the response body before removing any applied content encodings

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

        First Byte phase properties

        • Readonlyduration: number

          Duration in ns of the resource first byte phase

        • Readonlystart: number

          Duration in ns between start of the request and start of the first byte phase

      • Optional Readonlygraphql?: RumGraphql
      • Optional Readonlyid?: string

        UUID of the resource

      • Optional Readonlymethod?:
            | "POST"
            | "GET"
            | "HEAD"
            | "PUT"
            | "DELETE"
            | "PATCH"
            | "TRACE"
            | "OPTIONS"
            | "CONNECT"

        HTTP method of the resource

      • Optional Readonlyprotocol?: string

        Network protocol used to fetch the resource (e.g., 'http/1.1', 'h2')

      • Optional Readonlyprovider?: {
            domain?: string;
            name?: string;
            type?:
                | "ad"
                | "advertising"
                | "analytics"
                | "cdn"
                | "content"
                | "customer-success"
                | "first party"
                | "hosting"
                | "marketing"
                | "other"
                | "social"
                | "tag-manager"
                | "utility"
                | "video";
            [k: string]: unknown;
        }

        The provider for this resource

        • Optional Readonlydomain?: string

          The domain name of the provider

        • Optional Readonlyname?: string

          The user friendly name of the provider

        • Optional Readonlytype?:
              | "ad"
              | "advertising"
              | "analytics"
              | "cdn"
              | "content"
              | "customer-success"
              | "first party"
              | "hosting"
              | "marketing"
              | "other"
              | "social"
              | "tag-manager"
              | "utility"
              | "video"

          The type of provider

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

        Redirect phase properties

        • Readonlyduration: number

          Duration in ns of the resource redirect phase

        • Readonlystart: number

          Duration in ns between start of the request and start of the redirect phase

      • Optional Readonlyrender_blocking_status?: "blocking" | "non-blocking"

        Render blocking status of the resource

      • Optional Readonlyrequest?: {
            decoded_body_size?: number;
            encoded_body_size?: number;
            headers?: { [k: string]: string };
            [k: string]: unknown;
        }

        Request properties

        • Optional Readonlydecoded_body_size?: number

          Size in octet of the request body before any encoding

        • Optional Readonlyencoded_body_size?: number

          Size in octet of the request body sent over the network (after encoding)

        • Optionalheaders?: { [k: string]: string }

          HTTP headers of the resource request

      • Optional Readonlyresponse?: { headers?: { [k: string]: string }; [k: string]: unknown }

        Response properties

        • Optionalheaders?: { [k: string]: string }

          HTTP headers of the resource response

      • Optional Readonlysize?: number

        Size in octet of the resource response body

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

        SSL phase properties

        • Readonlyduration: number

          Duration in ns of the resource ssl phase

        • Readonlystart: number

          Duration in ns between start of the request and start of the ssl phase

      • Optional Readonlystatus_code?: number

        HTTP status code of the resource

      • Optional Readonlytransfer_size?: number

        Size in octet of the fetched response resource

      • Readonlytype:
            | "document"
            | "xhr"
            | "beacon"
            | "fetch"
            | "css"
            | "js"
            | "image"
            | "font"
            | "media"
            | "other"
            | "native"

        Resource type

      • url: string

        URL of the resource

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

        Worker phase properties

        • Readonlyduration: number

          Duration in nanoseconds of the resource worker phase

        • Readonlystart: number

          Duration in nanoseconds between start of the request and start of the worker phase

    • Readonlytype: "resource"

      RUM event type