Product Click Analytics API | Athena XAI Documentation

Overview

Use the Product Click Analytics API to record a click on a product.

Endpoint

Method	Path
`POST`	`/api/v2/product-click`

Request body parameters

Parameter name	Requirement	Type	Description
`productId`	required	integer\|string	ID of the clicked product.
`searchKeywords`	optional	string\|nullable	Comma-separated keywords that led to the product click, if any were typed.
`type`	optional	string	Autocomplete or search. This parameter is dated and no longer needs to be provided.
`token`	required	string	Athena XAI website token.

Example call

Method	Path
`POST`	`{{athena_url}}/api/v2/product-click`

Body raw (JSON)

JSON

{
    "token": "website token",
    "productId": "2573655",
    “searchKeywords” : “majica,majica sa”
    "athenaUid": "athena-123-test",
    "source": "search",
    "channel": "search landing page"
}

Response

JSON

{
    "message":"Product Click Analytics was successfully stored.",
    "status":200
}