When you create or edit a device, the fields below are either optional or required.

devices

Field

Description

Example

device_id

Unique identifier of the instrument in your system

  • 123456789

device_type

Type of instrument

  • mobile

device_subtype

Subtype of the device

  • android

status

Status of the device in your system

  • active

registered_at

Date in seconds since 1 Jan 1970 00:00:00 UTC (i.e. in Unix time)

  • 1632776052

os_name

Operating system used by the device

  • ios

os_version

Operating system version used by the device

  • 10.1.3

app_version

Application version used by the device

  • 5.44.4

device_manufacturer

Manufacturer of the device

  • Samsung

device_model

Model of the device

  • SM-N970U

timezone

Time zone configured by the device's application/OS

  • UTC-7

network_carrier

Network carrier used by the device (AT&T, Verizon, Vodafone, etc.)

  • AT&T

network_cellular

Whether or not the device has a cellular connection

  • true
  • false

phone_numbers

List of phone numbers associated with the device in E.164 format

  • ["+14159627132"]

tags

Additional information that can be used for grouping and filtering in "key:value" format

  • sector:Europe
  • source:UK_internal

entities

Fields

Description

Example

entity_id

The unique identifier for the entity associated with this device, as defined in your system

  • 1a2b3c4d5e

entity_type

The type of user in your system. Must be either user or business

  • user
  • business

digital_data.ip_address

Fields

Description

Example

ip_address

List of IP addresses. MUST be in either IPv4 or IPv6 format.

  • 52.15.247.208

first_seen

Date in seconds since 1 Jan 1970 00:00:00 UTC (i.e. in Unix time)

  • 1572643225

last_seen

Date in seconds since 1 Jan 1970 00:00:00 UTC (i.e. in Unix time)

  • 1572643230

custom_data

Fields

Description

Example

custom_data

Any additional information that should be associated with this instrument in key:value format as freeform json

  • Region: 3
  • Offshore": false

Did this page help you?