Interface IPageViewTelemetryInternal

Pageview telemetry interface

interface IPageViewTelemetryInternal {
    id?: string;
    iKey?: string;
    isLoggedIn?: boolean;
    measurements?: {
        [key: string]: number;
    };
    name?: string;
    pageType?: string;
    properties?: {
        duration?: number;
        [key: string]: any;
    };
    refUri?: string;
    startTime?: Date;
    uri?: string;
    ver?: string;
}

Hierarchy (view full)

Properties

id? iKey? isLoggedIn? measurements? name? pageType? properties? refUri? startTime? uri? ver?

Properties

Optionalid

id?: string

An identifier assigned to each distinct impression for the purposes of correlating with pageview. A new id is automatically generated on each pageview. You can manually specify this field if you want to use a specific value instead.

OptionaliKey

iKey?: string

iKey String - custom defined iKey.

OptionalisLoggedIn

isLoggedIn?: boolean

isLoggedIn - boolean is user logged in

Optionalmeasurements

measurements?: {
    [key: string]: number;
}

Property bag to contain additional custom measurements (Part C)

Deprecated

-- please use properties instead

Optionalname

name?: string

name String - The string you used as the name in startTrackPage. Defaults to the document title.

OptionalpageType

pageType?: string

pageType String - page type

Optionalproperties

properties?: {
    duration?: number;
    [key: string]: any;
}

Property bag to contain additional custom properties (Part C)

Type declaration

  • [key: string]: any
  • Optionalduration?: number

    The number of milliseconds it took to load the page. Defaults to undefined. If set to default value, page load time is calculated internally.

OptionalrefUri

refUri?: string

refUri String - the URL of the source page where current page is loaded from

OptionalstartTime

startTime?: Date

Time first page view is triggered

Optionaluri

uri?: string

uri String - a relative or absolute URL that identifies the page or other item. Defaults to the window location.

Optionalver

ver?: string

Version of the part B schema, todo: set this value in trackpageView

Settings

Member Visibility

On This Page

Properties