Search
Preparing search index...
The search index is not available
@moloco-rmp/event-api-client - v1.0.4
Options
All
Public
Public/Protected
All
Inherited
Externals
Menu
@moloco-rmp/event-api-client - v1.0.4
v1
Namespace v1
Index
Client
Client
Create
Client
Options
create
Client
Error
errors
Event
Channel
Type
Insert
Event
Params
Retail
Event
Type
Client
Create
Client
Options
Create
Client
Options
:
{
apiKey
:
string
;
baseURL
?:
string
;
platformId
:
string
;
region
?:
string
}
Type declaration
api
Key
:
string
Optional
baseURL
?:
string
platform
Id
:
string
Optional
region
?:
string
create
Client
create
Client
(
options
:
CreateClientOptions
)
:
Client
Parameters
options:
CreateClientOptions
Returns
Client
Event
Channel
Type
Channel
Type
:
"APP"
|
"SITE"
|
"DESKTOP_SITE"
|
"MOBILE_SITE"
Insert
Event
Params
Insert
Event
Params
:
{
channelType
:
ChannelType
;
decisionTrackId
?:
string
;
device
?:
{
advertisingId
?:
string
;
ip
?:
string
;
language
?:
string
;
model
?:
string
;
os
:
string
;
osVersion
?:
string
;
persistentId
?:
string
;
ua
?:
string
;
uniqueDeviceId
?:
string
}
;
eventType
:
RetailEventType
;
id
?:
string
;
items
?:
{
id
:
string
;
itemGroupId
?:
string
;
price
:
{
amount
:
number
;
currency
:
string
}
;
quantity
:
number
;
sellerId
?:
string
}
[]
;
pageId
?:
string
;
referrerPageId
?:
string
;
revenue
?:
{
amount
:
number
;
currency
:
string
}
;
searchQuery
?:
string
;
sessionId
?:
string
;
shippingCharge
?:
{
amount
:
number
;
currency
:
string
}
;
timestamp
:
number
;
userId
:
string
}
Type declaration
channel
Type
:
ChannelType
Optional
decision
Track
Id
?:
string
Optional
device
?:
{
advertisingId
?:
string
;
ip
?:
string
;
language
?:
string
;
model
?:
string
;
os
:
string
;
osVersion
?:
string
;
persistentId
?:
string
;
ua
?:
string
;
uniqueDeviceId
?:
string
}
Optional
advertising
Id
?:
string
Optional
ip
?:
string
Optional
language
?:
string
Optional
model
?:
string
os
:
string
Optional
os
Version
?:
string
Optional
persistent
Id
?:
string
Optional
ua
?:
string
Optional
unique
Device
Id
?:
string
event
Type
:
RetailEventType
Optional
id
?:
string
Optional
items
?:
{
id
:
string
;
itemGroupId
?:
string
;
price
:
{
amount
:
number
;
currency
:
string
}
;
quantity
:
number
;
sellerId
?:
string
}
[]
Optional
page
Id
?:
string
Optional
referrer
Page
Id
?:
string
Optional
revenue
?:
{
amount
:
number
;
currency
:
string
}
amount
:
number
currency
:
string
Optional
search
Query
?:
string
Optional
session
Id
?:
string
Optional
shipping
Charge
?:
{
amount
:
number
;
currency
:
string
}
amount
:
number
currency
:
string
timestamp
:
number
user
Id
:
string
Retail
Event
Type
Retail
Event
Type
:
"SEARCH"
|
"ITEM_PAGE_VIEW"
|
"ADD_TO_CART"
|
"PURCHASE"
|
"ADD_TO_WISHLIST"
|
"HOME"
|
"LAND"
|
"PAGE_VIEW"
Exports
v1
errors
Client
Channel
Type
Create
Client
Options
Insert
Event
Params
Retail
Event
Type
create
Client