PostUserEvent

post

https://sandbox-evt.mcm-api.moloco.com/rmp/event/v1/platforms/{platform}/userevents

Post an individual user event. Server host may vary by platform. Moloco's account manager will provide accurate host information.

Recent Requests

Time	Status	User Agent
Retrieving recent requests…

Loading…

Path Params

platform

string

required

Platform for the user event.

Body Params

string

length ≤ 128

Recommended. Unique ID generated by the client that could be used as an identifier. The length should not exceed 128 characters.

event_type

string

enum

required

Defaults to UNKNOWN_EVENT_TYPE

Supported EventTypes.

timestamp

string

required

Unix timestamp in milliseconds that the event happened at. (e.g., 1617870506121)

channel_type

string

enum

required

Defaults to UNKNOWN_CHANNEL_TYPE

Allowed:

user_id

string

length ≤ 128

User Identifier for the platform. Recommended to hash it before sending for anonymization. The length should not exceed 128 characters. This field cannot be one of the following values: "null", "undefined", "invalid", "nil".

device

object

items

array of objects

Items information related to the event. Required for ADD_TO_CART, ADD_TO_WISHLIST, ITEM_PAGE_VIEW and PURCHASE event types.

items

revenue

object

A monetary amount in a specific currency. For example, {currency: "USD", amount: 12.34} means $12.34. Price of the single item.

search_query

string

Query string for the search. Required for SEARCH event.

session_id

string

length ≤ 128

Deprecated. Please use custom_id as alternative. Identifier for tracking users regardless of sign-in status. The length should not exceed 128 characters.

custom_id

string

length ≤ 128

Custom ID generated by the client to suppress duplicate events. The length should not exceed 128 characters.

page_id

string

Page ID should be a uniquely assigned value for each page in the app or web site. It is a mandatory field if the Event type is PAGE_VIEW. Otherwise, it's not required to have a value for the page_id parameter. If the Event type is PAGE_VIEW, provide a string that can identify a context of the event, such as "electronics", "categories/12312", "azd911d" or "/classes/foo/lectures/bar." Any value will be acceptable if it helps identify unique pages.

referrer_page_id

string

Similar to referer in HTTP, this value indicates from which page the user came to the current page.

shipping_charge

object

A monetary amount in a specific currency. For example, {currency: "USD", amount: 12.34} means $12.34. Price of the single item.

decision_track_id

string

Track ID for the event. Track ID is generated by a call to the Decision API. Fill in this field accordingly if the user event is to be associated with a Decision API response.

Responses

200A successful response.

400Bad request. Detailed cause can be found in the response message.

401Unauthorized. The request does not have valid authentication credentials for the operation.

403Permission denied. The caller does not have permission to execute the specified operation.

404Not found. One or more resources required to perform the request does not exist. Detailed cause can be found in the response message.

429Too many requests either by platform or by user. Detailed cause can be found in the response message.

500Internal server error. Detailed cause can be found in the response message.