Interface IPageActionTelemetry

Page Action event

interface IPageActionTelemetry {
    actionType?: string;
    behavior?: string | number;
    clickCoordinates?: string;
    content?: any;
    contentVer?: string;
    iKey?: string;
    measurements?: {
        [key: string]: number;
    };
    name: string;
    pageName?: string;
    pageType?: string;
    parentId?: string;
    properties?: {
        [key: string]: any;
    };
    refUri?: string;
    targetUri?: string;
    timeToAction?: number;
    uri?: string;
}

Hierarchy

  • IEventTelemetry
    • IPageActionTelemetry

Properties

actionType? behavior? clickCoordinates? content? contentVer? iKey? measurements? name pageName? pageType? parentId? properties? refUri? targetUri? timeToAction? uri?

Properties

OptionalactionType

actionType?: string

One of the awa.actionType values

Optionalbehavior

behavior?: string | number

One of the awa.behavior values.

OptionalclickCoordinates

clickCoordinates?: string

X, Y representing the absolute co-ordinates withrespect to topleft corner of the page. This should be normalized for the screen resolution to provide better heat map.

Optionalcontent

content?: any

JSON-formatted array of content acted upon

OptionalcontentVer

contentVer?: string

Version indicating content version which aids in parsing the content.

OptionaliKey

iKey?: string

Description

custom defined iKey

Optionalmeasurements

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

Property bag to contain additional custom measurements (Part C)

Deprecated

-- please use properties instead

name

name: string

Description

An event name string

OptionalpageName

pageName?: string

Title of the page

OptionalpageType

pageType?: string

Page type

OptionalparentId

parentId?: string

Content Id (Parent Id) of the parent in which the content was located;

Optionalproperties

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

Property bag to contain additional custom properties (Part C)

OptionalrefUri

refUri?: string

Uri of the referrer, this is a convinence for adaptors to just leverage PageAction for click analytics without linking it to the respective Page Views.

OptionaltargetUri

targetUri?: string

Target uri for PageAction events

OptionaltimeToAction

timeToAction?: number

Time taken in milliseconds since the user saw the page and took the action (such as click on a link, etc.). This will be in seconds.

Optionaluri

uri?: string

A relative or absolute URL that identifies the page or other item. Defaults to the window location.

Settings

Member Visibility

On This Page

Properties