Client

A client describes the device and software used to access the application, including details of the device, operating system, and browser.

Properties

These are the available properties:

device

object

The device used by the client.

name(optional)

string

The name of the device. For example, “iPhone 11 Pro” or “MacBook Pro”.

vendor(optional)

string

The vendor or manufacturer of the device. For example, “Apple” or “Samsung”.

category

string

The category of the device. The possible values are:

Value	Description
desktop	A desktop computer.
tablet	A tablet device.
mobile	A mobile phone.
bot	Bots or crawlers.
other	Any other device.
unknown	An unknown device.

operatingSystem

object

The operating system of the device.

name(optional)

string

The name of the operating system. For example, “iOS”, “Android”, or “Windows”.

version(optional)

string

The operating system’s version. For example, “10.0.18363”, “13.3”, or “10”.

browser

object

The browser used by the client.

name(optional)

string

The browser’s name. For example, “Chrome”, “Safari”, or “Firefox”.

version(optional)

string

The browser’s version. For example, “78.0.3904.108”, “13”, or “71.0”.

type

string

The browser type. The possible values are:

Value	Description
web	A standard web browser.
in-app	A browser embedded in an application.
crawler	A search engine bot or crawler.
other	Any other browser, like proxies or feed readers.
unknown	An unknown browser type.

Payload examples

Below is a payload example for this type:

{  "device": {    "name": "MacBook Pro",    "vendor": "Apple",    "category": "desktop",    "operatingSystem": {      "name": "iOS",      "version": "10.0.18363"    }  },  "browser": {    "name": "Chrome",    "version": "78.0.3904.108",    "type": "web"  }}