Track a category view event. This event is used to track when a user views a category page such as a Product Listing Page

  • Published on Dec 18, 2024
  • 1 minute(s) read
Prev Next
Post
/customers/{customerId}/users/{userId}/category-view
Security
API Key
Header parameter nameaccess_token

Access token Authentication

Path parameters
customerId
stringRequired
userId
stringRequired
Body parameters
Expand All
object
Example{ "rec": "1", "idsite": "1234", "url": "https://example.com", "urlref": "https://example.com", "locale": "en_US", "uid": "{\"customer_id\":\"customer_id\",\"user_type\":\"return_user\",\"testing_group_name\":\"Inactive\",\"session_id\":\"524e0542-5713-4755-a8c0-1430cbd58aa9\"}", "action_name": "category_view", "action_detail": "category_view", "action_type": "ecomm", "cvar": "{\"5\":[\"_pkc\",\"Category Name\"]}", "context": { "plpProducts": [ "1234", "5678" ] } }
rec
string

Default parameter to send with event payload

Example1
idsite
string

The tracking_id of the site

Example1234
url
string

The URL of the page

Examplehttps://example.com
urlref
string

The referrer URL

Examplehttps://example.com
locale
string

The locale of the user

Exampleen_US
uid
string

A string representation of the user object

Example{"customer_id":"customer_id","user_type":"return_user","testing_group_name":"Inactive","session_id":"524e0542-5713-4755-a8c0-1430cbd58aa9"}
action_name
string

The name of the action that was performed.

Examplecontent_tracking
action_detail
string

Details on the action that was performed.

Examplesearch_result
action_type
string

The meta action that was performed.

Examplesearch_service
cvar
string

A string representation of a JSON object containing information about the product. _pkp is the product's price, _pks is the product's sku, _pkn is the product's name, _pkc is the product's currency.

Example{"2":["_pkp",1000],"3":["_pks","1234"],"4":["_pkn","product_name"],"5":["_pkc","{"currency_code":"USD"}"]}
context
object

A JSON object of context data. Used to pass dynamic, additional data to the tracker.

Example{ "key1": "value1", "key2": 1000, "nested": { "key": "value" }, "array": [ "1", "2", "3" ] }
Responses
200

Successful response

400

Bad request

401

Unauthorized

403

Forbidden

500

Internal server error