Request header parameters
| Parameter name | Requirement | Type | Description |
|---|---|---|---|
client-source | optional | string | The origin of the API call: Mobile App, Mobile Web, Web,… |
platform | optional | string | The client’s operating system: iOS, Android,… |
device | optional | string | The client’s device: Mobile or Desktop. |
Request body parameters
| Parameter name | Requirement | Type | Description |
|---|---|---|---|
athenaUid | optional | string | Unique Athena XAI cookie generated on the platform. |
agent | optional | string | Request user agent string. |
ip_address | optional | string | The client’s IP address. |
source | optional | string | The source that led the user to the add to cart, click or order action. See the possible source values. Applies only to the Product Click Analytics API and the Cart Analytics API. |
channel | optional | string | The source’s channel, a more detailed explanation of the origin. See the possible channel values. Applies only to the Product Click Analytics API and the Cart Analytics API. |
None of these parameters are required, but they are valuable to Athena XAI for providing more detailed analytics and reports. You can provide them to all the APIs explained below.