Get Customer Events

Retrieves the details of all events of a specific customer.

Query parameter

ParameterDescription
userIdUnique ID of the customer whose events need to be fetched.
scopeUse the scope child to retrieve the event details of a customer in a child org using the parent org till ID. This is applicable to a Connected org setup.

Response parameter

ParameterDescription
dataA list of event details.
orgIdThe organization's identification number.
userIdThe user's identification number.
dateThe date and time when the event occurred.
eventNameName of the event.
eventIdUnique identifier for the event.
sourceSource from which the event originated.
tillCodeCode of the till where the event took place.
source_till_idTill ID of the till where the event took place.
source_user_idUser ID from which the event was generated.
additonalAttributesAdditional details associated with the event.
uniqueIdUnique generated for the event when the Is Unique feature is enabled. Refer to the Uniqueness check documentation for more information.
accountidAccount identification.
autoUpdateTimeStampTime when the event was automatically updated.
brandname/brandName of the brand.
browsername/browser_nameName of the browser where the event took place.
cartid/cartrefkeyUnique identifier for the cart.
categoryname/categoryCategory under which the product/event falls.
cityCity where the event took place.
countryCountry where the event took place.
deviceType of device used during the event.
idUnique identifier.
ipIP address from which the event originated.
locationnameName of the location where the event took place.
osname/os_nameName of the operating system.
pageurl/page_urlURL of the page where the event occurred.
productname/nameName of the product.
regionRegion where the event took place.
tillTill details.
variantVariant details of the product.
psiAttributesObject indicating if the field contains Protected Sensitive Information. For more information refer, Classify Potentially Sensitive Information (PSI)
warningsA list of warnings related to the response.
errorsA list of errors related to the response.
Language
Credentials
Basic
base64
:
URL
Click Try It! to start a request and see the response here!