Track a search click event. This event is used to track when a user clicks on a search result

  • Published on Dec 18, 2024
  • 1 minute(s) read
Prev Next
Post
/customers/{customerId}/users/{userId}/search-click
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": "content_tracking", "action_detail": "search_click", "action_type": "search_service", "query_id": "4893e2d0-2a35-4c58-81b6-ad3906518563", "c_n": "1234", "c_p": "1234", "c_t": "1234,5678,9012", "c_i": "searchResult", "context": { "query": "dress", "deployment_id": "1234", "is_type_to_search": false } }
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
query_id
string

Used for search events. The query id is sent to the tracker to be able to identify and group search events.

Example4893e2d0-2a35-4c58-81b6-ad3906518563
c_n
string

The ID of the element or deployment to track

Examplesm_el_1234
c_p
string

The product_id. Used for events such as product_view, product_add, product_purchase, etc.

Example1234
c_t
string

A comma separated list of products

Example1234,5678,9012
c_i
string

A description of the event type

ExamplesearchResult
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