saveBrowsingEvent
post
/ccstore/v1/audienceContext/addBrowsingEvent
Save the browsing page view data for the current user.
Request
Supported Media Types
- application/json
Root Schema : saveBrowsingEvent_request
Type:
Show Source
object
-
pageView:
object pageView
A browsing page view event data
Example:
{
"pageView":{
"catalogId":"cloudLakeCatalog",
"id":"Product_35Fxy",
"type":"PRODUCT"
}
}
Nested Schema : pageView
Type:
object
A browsing page view event data
Show Source
-
catalogId(optional):
string
The id of the catalog to which the browsed entity belongs.
-
id(optional):
string
The id of the browsed entity.
-
type(optional):
string
Indicates if the browsed entity is either a 'CATEGORY' or a 'PRODUCT'.
Response
Supported Media Types
- application/json
200 Response
Following model is returned when operation succeeds.
Root Schema : saveBrowsingEvent_response
Type:
Show Source
object
-
catalogId(optional):
string
The id of the catalog to which the browsed entity belongs.
-
id(optional):
string
The id of the browsed entity.
-
type(optional):
string
Indicates if the browsed entity is either a 'CATEGORY' or a 'PRODUCT'.
Example:
{
"application/json":{
"catalogId":"cloudLakeCatalog",
"links":[
{
"rel":"self",
"href":"http://example.com/ccstore/v1/audienceContext/addBrowsingEvent"
}
],
"id":"Product_35Fxy",
"type":"PRODUCT"
}
}
Default Response
The error response.
The following are the internal error codes thrown by this API when the request processing fails in Oracle Commerce Cloud:
|Error Code|Description|
|------------------|------------------|
|54098|The request was missing the required behavioral data body.|
|54099|No page view data specified in the request.|
|54100|Invalid page type specified for data collection, the expected values are "PRODUCT" or "CATEGORY".|
|54101|Type not specified for page view entry.|
|54102|Catalog Id not specified for page view entry.|
|54103|Id not specified for page view entry.|
Root Schema : errorModel
Type:
Show Source
object
-
devMessage(optional):
string
An optional non-localized message containing technical information for developers
-
errorCode(optional):
string
The numerical code identifying the error
-
errors(optional):
array errors
An optional list of errors if multiple errors were encountered
-
message(optional):
string
The localized message describing the error
-
moreInfo(optional):
string
An optional non-localized message with more information
-
o:errorPath(optional):
string
An optional machine readable description of where the error occurred
-
status(optional):
string
The HTTP status code
-
type(optional):
string
The URI to the HTTP state code definition
Nested Schema : errors
Type:
array
An optional list of errors if multiple errors were encountered
Show Source
Nested Schema : items
Type:
Show Source
object
-
devMessage(optional):
string
An optional non-localized message containing technical information for developers
-
errorCode(optional):
string
The numerical code identifying the error
-
message(optional):
string
The localized message describing the error
-
moreInfo(optional):
string
An optional non-localized message with more information
-
o:errorPath(optional):
string
An optional machine readable description of where the error occurred
-
status(optional):
string
The HTTP status code