setEnableClientHints
The setEnableClientHints() method enables tracking of Client Hints provided by the browser.
Syntax
setEnableClientHints(enable): void Not available Not available Not available Not available Not available Not availableParameters
| Parameter | Type | Description | Required |
|---|---|---|---|
| enable | boolean | Whether to enable or disable tracking of Client Hints | Yes |
List of Supported Client Hints
- model - A string representing the model of the mobile device. For example, "Pixel 2XL". If the device is not a mobile device or the model is unknown, the value will be omitted.
- brands - An array of objects, each containing the browser brand and version.
- platform - A string specifying the platform the user agent is running on, for example "Windows".
- platformVersion - A string representing the platform version.
- fullVersionList - An array of objects, each containing properties "brand" (browser name) and "version" (full version).
Examples
To enable tracking of a client hints:
_paq.push(['setEnableClientHints', true]);Not availableNot availableNot availableNot availableNot availableNot availableNotes
setEnableClientHintsmust be called as soon as possible so all of the events in the session contain the hints.- Not all browsers support Client Hints yet.
- Depending on browser, Client Hints may only be available on websites served through HTTPS.
- Client Hints are an experimental feature and may change in the future.
Updated about 2 months ago