Request a Demo Start Trial

Event Reference

Event Properties

Deskmetrics is a flexible system that supports arbitrary event properties.

To cover common use cases, we’ve defined some properties that are generally understood by our SDKs and reporting tools. Where possible, properties are added automatically by the Analytics SDK. Others may be added by you, as you will see in our SDK integration guides.

tracking_id The primary property used to slice event data into different segments. Populate this property with whatever’s most important to you, e.g. build, distribution channel, etc.

sub_id Further segment your application by sub-id.

channel Further segment your application by channel.

dm.timestamp Time the event was received. This is automatically added by our servers to all incoming events.

install_time Time that the application was installed.

cohort.day Day in the life of your application (since install_time).

cohort.week Week in the life of your application (since install_time).

cohort.month Month in the life of your application (since install_time).

cohort.install_day install_time represented as the number of days since the Unix epoch: Jan 1, 1970

version Application version

ip_address IP address of the machine that sent the event

geo.city City based on geo-lookup of ip_address

geo.country Country based on geo-lookup of ip_address

click_id Unique ID associated with a tracking link click

tracking_link_key Unique key corresponding to a tracking link

sdk_version Version of the SDK integrated into your application

client_uid Unique user ID

os.name Operating system name

os.long_name Operating system name and version

os.major Operating system major version

os.minor Operating system minor version

os.patch Operating system patch or build version

os.service_pack On windows 7 and older, the service pack version

locale Operating system locale

bitness 32 or 64

Installer Events

The following events are automatically sent by the Analytics SDK when integrated into an installer (or uninstaller). The properties specific to each event type are detailed below.

Application Events

The following events are automatically sent by the Analytics SDK when integrated into an application. The properties specific to each event type are detailed below.

Enrichment

Deskmetrics can enrich your event data by parsing it or adding to it. You can tell Deskmetrics which enrichments to apply by including them in your event properties.

Metadata

The value ${dm.meta:<path.to.metadata_property>} is replaced with a JSON object containing the value of the specified metadata property. The following metadata properties are available:

Geography

The value ${dm.geo:<path.to.ip_address_property>} is replaced with a JSON object containing standard geo-ip properties.

User Agent

The value ${dm.ua:<path.to.user_agent_property>} is replaced with a JSON object containing standard user-agent properties.

Cohort

The value ${dm.cohort:<path.to.install_time_property>} is replaced with a JSON object containing cohort properties.

Example

Event sent to Deskmetrics:

{
  "ip_address": "${dm.meta:request_ip}",
  "geo": "${dm.meta:request_geo}",
  "wifi": {
    "ip" : "240.25.88.51"
  },
  "wifi_geo": "${dm.geo:wifi.ip}",
  "install_time": 1454464158,
  "cohort": "${dm.cohort:install_time}",
  "user_agent": "Mozilla/5.0 (Windows NT 6.1; WOW64) ...",
  "ua": "${dm.ua:user_agent}",
}

Enriched event:

{
  "is" : {
    "timestamp": 1457736108
  },
  "ip_address": "154.244.21.2",
  "geo": {
    "city": "Rochester",
    "subdivision": "New York",
    "country": "United States",
    "longitude": -77.6843,
    "continent": "North America",
    "registered_country": "United States",
    "registered_country_code": "US",
    "country_code": "US",
    "subdivision_code": "NY",
    "latitude": 43.286,
    "is_anonymous_proxy": false,
    "is_satellite_provider": false
  },
  "wifi": {
    "ip" : "240.25.88.51"
  },
  "wifi_geo": {
    "city": "Rochester",
    "subdivision": "New York",
    "country": "United States",
    "longitude": -77.6843,
    "continent": "North America",
    "registered_country": "United States",
    "registered_country_code": "US",
    "country_code": "US",
    "subdivision_code": "NY",
    "latitude": 43.286,
    "is_anonymous_proxy": false,
    "is_satellite_provider": false
  },
  "install_time": 1454464158,
  "cohort": {
    "week": 6,
    "install_day": 16834,
    "day": 38,
    "month": 2
  },
  "user-agent": "Mozilla/5.0 (Windows NT 6.1; WOW64) ...",
  "ua": {
    "os_name": "Windows 7",
    "ua_company": "Google Inc.",
    "ua_info_url": "http://udger.com/list-of-ua/browser-detail?browser=Chrome",
    "os_company_url": "https://www.microsoft.com/about/",
    "ua_icon": "chrome.png",
    "os_company": "Microsoft Corporation.",
    "device_icon": "desktop.png",
    "ua_name": "Chrome 48.0.2564.116",
    "os_family": "Windows",
    "ua_url": "http://www.google.com/chrome/",
    "device_type": "Personal computer",
    "device_info_url": "/list-of-ua/device-detail?device=Personal computer",
    "ua_family": "Chrome",
    "ua_company_url": "https://www.google.com/about/company/",
    "typ": "Browser",
    "os_icon": "windows-7.png",
    "os_url": "https://en.wikipedia.org/wiki/Windows_7"
  }
}