Sign in

v1

latestOpenAPI 3.0.02026-07-2678399358.2 KB
Event

PostUserEvent

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

post/rmp/event/v1/platforms/{platform}/userevents

Path parameters

platformstring required

Platform for the user event.

Request body

idstring

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

event_type'UNKNOWN_EVENT_TYPE' | 'SEARCH' | 'ITEM_PAGE_VIEW' | 'ADD_TO_CART' | 'PURCHASE' | 'ADD_TO_WISHLIST' | 'HOME' | 'LAND' | 'PAGE_VIEW' required

Supported EventTypes.

timestampstring int64 required

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

channel_type'UNKNOWN_CHANNEL_TYPE' | 'APP' | 'SITE' | 'DESKTOP_SITE' | 'MOBILE_SITE' required

ChannelType enumerates available channel types. Simply using APP and SITE is fine, but you can also further distinguish DESKTOP_SITE and MOBILE_SITE for web users.

  • APP: Mobile App (iOS or Android)
  • SITE: Site (e.g. Website)
  • DESKTOP_SITE: Desktop Site (e.g. Desktop Website)
  • MOBILE_SITE: Mobile Site (e.g. Mobile Website)
domainstring

Set domain to a value that can identify the domain portion of your website's URL. We recommend you keep the same value across your website and application if they share your backend.

user_idstring

User identifier used by the platform. This should typically be the sign-in ID used within the platform, and is highly recommended to be hashed prior to being sent to Moloco. Please provide this value whenever available to achieve optimal performance. If the value is unknown for any reason, please leave empty and do not fill in a default or random value.

search_querystring

Query string for the search. Required for SEARCH event.

session_idstring

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

custom_idstring

Alternative ID to track users regardless of sign-in status or device. This ID should be provided as a third option following the user_id and device.persistent_id, and is highly recommended to be hashed prior to being sent to Moloco. This ID must be provided if both the user_id and device.persistent_id fields are left empty. Please do not fill in a default value, and instead randomize it if you must, but we recommend you send some ID that can be used to track users even if for a short time span. Please reach out to Moloco if you have further questions about this ID.

page_idstring

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_idstring

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

decision_track_idstring

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.

personalization_mode'UNKNOWN_PERSONALIZATION_MODE' | 'STANDARD' | 'METRIC_ONLY' | 'ID_LESS'

PersonalizationMode determines how user identification is handled in decision and event processing.

  • STANDARD: STANDARD means standard user processing with full user identification.
  • METRIC_ONLY: METRIC_ONLY means user data is used for metric collection only, not for personalization.
  • ID_LESS: ID_LESS means no user identification is used.

Response

A successful response.

V1PostUserEventResponse required