@xylabs/pixel

Event Client for xylabs ESB

Reference

@xylabs/pixel

Classes

• PixelApi
• XyPixel
• Referrer
• UniqueUserId
• UserEventHandler
• UtmFields
• XyUserEventHandler

Interfaces

• UserEvent
• CommonFields
• FunnelStartedFields
• PurchaseFields
• TestStartedFields
• UserClickFields
• ViewContentFields
• XyLabsTrackingEventJson

Type Aliases

• UserEventSystem

classes

PixelApi

@xylabs/pixel

Constructors

Constructor

new PixelApi(baseUri): PixelApi;

Parameters

baseUri

string = 'prod'

Returns

PixelApi

Methods

trackEvents()

trackEvents(events): Promise<any>;

Parameters

events

UserEvent[]

Returns

Promise<any>

Referrer

@xylabs/pixel

Constructors

Constructor

new Referrer(): Referrer;

Returns

Referrer

Properties

local

local: string;

session

session: string;

Methods

toJson()

toJson(): 
  | undefined
  | {
  local: string;
  session: string;
};

Returns

| undefined | { local: string; session: string; }

UniqueUserId

@xylabs/pixel

Constructors

Constructor

new UniqueUserId(): UniqueUserId;

Returns

UniqueUserId

Properties

id

id: string;

Methods

toString()

toString(): string;

Returns

string

UserEventHandler

@xylabs/pixel

Extended by

• XyUserEventHandler

Type Parameters

TData

TData extends EmptyObject

Constructors

Constructor

new UserEventHandler<TData>(): UserEventHandler<TData>;

Returns

UserEventHandler<TData>

Methods

funnelStarted()

abstract funnelStarted<T>(fields): Promisable<void>;

Type Parameters

T

T extends object

Parameters

fields

FunnelStartedFields | T

Returns

Promisable<void>

testStarted()

abstract testStarted<T>(fields): Promisable<void>;

Type Parameters

T

T extends object

Parameters

fields

TestStartedFields | T

Returns

Promisable<void>

userClick()

abstract userClick<T>(fields): Promisable<void>;

Type Parameters

T

T extends object

Parameters

fields

UserClickFields | T

Returns

Promisable<void>

viewContent()

abstract viewContent<T>(fields): Promisable<void>;

Type Parameters

T

T extends object

Parameters

fields

T | ViewContentFields

Returns

Promisable<void>

UtmFields

@xylabs/pixel

Constructors

Constructor

new UtmFields(): UtmFields;

Returns

UtmFields

Properties

fields

fields: Record<string, string>[] = [];

Methods

getUtmRecord()

getUtmRecord(): null | Record<string, string>;

Returns

null | Record<string, string>

toString()

toString(): string;

Returns

string

update()

update(): Record<string, string>[];

Returns

Record<string, string>[]

XyPixel

@xylabs/pixel

Properties

api

static api: PixelApi;

cid

cid: string;

email?

optional email: string;

email_hash?

optional email_hash: null | string;

exids?

optional exids: ExIds;

pixelId?

optional pixelId: string;

queue

queue: UserEvent[] = [];

Accessors

instance

Get Signature

get static instance(): XyPixel;

Returns

XyPixel

Methods

init()

static init(pixelId): XyPixel;

Parameters

pixelId

string

Returns

XyPixel

selectApi()

static selectApi(api): void;

Parameters

api

PixelApi

Returns

void

identify()

identify(email?): void;

Parameters

email?

string

Returns

void

send()

send<T>(
   event, 
   fields?, 
eventId?): Promise<void>;

Type Parameters

T

T extends JsonObject

Parameters

event

string

fields?

T

eventId?

string

Returns

Promise<void>

XyUserEventHandler

@xylabs/pixel

Extends

• UserEventHandler<T>

Type Parameters

T

T extends EmptyObject = EmptyObject

Constructors

Constructor

new XyUserEventHandler<T>(): XyUserEventHandler<T>;

Returns

XyUserEventHandler<T>

Overrides

UserEventHandler.constructor

Methods

funnelStarted()

funnelStarted(fields): Promise<void>;

Parameters

fields

FunnelStartedFields | T

Returns

Promise<void>

Overrides

UserEventHandler.funnelStarted

purchase()

purchase(fields): Promise<void>;

Parameters

fields

PurchaseFields | T

Returns

Promise<void>

testStarted()

testStarted(fields): Promise<void>;

Parameters

fields

TestStartedFields | T

Returns

Promise<void>

Overrides

UserEventHandler.testStarted

userClick()

userClick(fields): Promise<void>;

Parameters

fields

UserClickFields | T

Returns

Promise<void>

Overrides

UserEventHandler.userClick

viewContent()

viewContent(fields): Promise<void>;

Parameters

fields

ViewContentFields | T

Returns

Promise<void>

Overrides

UserEventHandler.viewContent

interfaces

CommonFields

@xylabs/pixel

Extended by

• FunnelStartedFields
• PurchaseFields
• TestStartedFields
• UserClickFields
• ViewContentFields

Properties

funnel?

optional funnel: string;

testData?

optional testData: string;

FunnelStartedFields

@xylabs/pixel

Extends

• CommonFields

Properties

funnel?

optional funnel: string;

Inherited from

CommonFields.funnel

testData?

optional testData: string;

Inherited from

CommonFields.testData

name

name: string;

PurchaseFields

@xylabs/pixel

Extends

• CommonFields

Properties

funnel?

optional funnel: string;

Inherited from

CommonFields.funnel

testData?

optional testData: string;

Inherited from

CommonFields.testData

id

id: string;

name?

optional name: string;

price?

optional price: number;

value?

optional value: number;

TestStartedFields

@xylabs/pixel

Extends

• CommonFields

Properties

funnel?

optional funnel: string;

Inherited from

CommonFields.funnel

testData?

optional testData: string;

Inherited from

CommonFields.testData

name

name: string;

UserClickFields

@xylabs/pixel

Extends

• CommonFields

Properties

funnel?

optional funnel: string;

Inherited from

CommonFields.funnel

testData?

optional testData: string;

Inherited from

CommonFields.testData

elementName

elementName: string;

elementType

elementType: string;

intent?

optional intent: string;

placement?

optional placement: string;

UserEvent

@xylabs/pixel

Properties

cid

cid: string;

create_time?

optional create_time: number;

email?

optional email: string;

email_hash?

optional email_hash: string;

event?

optional event: string;

event_id?

optional event_id: string;

exids?

optional exids: ExIds;

fields?

optional fields: Record<string, unknown>;

host?

optional host: string;

pathname?

optional pathname: string;

pixel?

optional pixel: string;

receive_time?

optional receive_time: number;

referrer?

optional referrer: object;

local

local: string;

session

session: string;

rid?

optional rid: string;

system?

optional system: ParsedResult;

uid?

optional uid: string;

utm?

optional utm: Record<string, string>[] | Record<string, string[]>;

ViewContentFields

@xylabs/pixel

Extends

• CommonFields

Properties

funnel?

optional funnel: string;

Inherited from

CommonFields.funnel

testData?

optional testData: string;

Inherited from

CommonFields.testData

name

name: string;

path

path: string;

XyLabsTrackingEventJson

@xylabs/pixel

Properties

cid

cid: string;

create_time?

optional create_time: number;

email?

optional email: string;

email_hash?

optional email_hash: string;

event?

optional event: string;

event_id?

optional event_id: string;

exids?

optional exids: Record<string, string>;

fields?

optional fields: Record<string, unknown>;

host?

optional host: string;

ip?

optional ip: string;

pathname?

optional pathname: string;

pixel?

optional pixel: string;

receive_time?

optional receive_time: number;

rid?

optional rid: string;

system?

optional system: unknown;

ua?

optional ua: string;

uid?

optional uid: string;

utm?

optional utm: Record<string, string>[] | Record<string, string[]>;

type-aliases

UserEventSystem

@xylabs/pixel

type UserEventSystem = Bowser.Parser.ParsedResult;

Part of sdk-js

Maintainers

• Arie Trouw (arietrouw.com)
• Matt Jones
• Joel Carter
• Jordan Trouw

License

See the LICENSE file for license details

Credits

Made with 🔥 and ❄️ by XYLabs