Track Device Variables

10min
Stores metadata for a specific device
POST
Request
Header Parameters
Date
required
String
In RFC7231 format (see "License API Authorization"), eg.: Thu, 17 Nov 2022 20:51:35 GMT
Authorization
required
String
See "License API Authorization" article
Body Parameters
hardware_id
required
String
Unique hardware ID generated for the client device
product
required
String
Product short code
variables
required
Object
JSON key-value object, with keys being variable names and values being the values to set for those variables. Values may be: string, number or boolean
license_key
optional
String
Required if product is key-based (see section below)
username
optional
String
Required if product is user based (see section below)
license_id
optional
Number
Ensures that the action affects only the license with the specified ID. This is useful if e.g. you have multiple licenses for the same product assigned to the same user. For obtaining a list of licenses assigned to a user, see "User Licenses"
Curl
Node.js
JS
Python
Ruby
import requests

url = "/api/v4/track_device_variables"

payload = "{\"hardware_id\":\"String\",\"product\":\"string\",\"variables\":\"Object\",\"license_key\":\"string\",\"username\":\"string\"}"
headers = {
   'Accept': 'application/json',
   'Date': 'string',
   'Authorization': 'string'
}

response = requests.request("POST", url, headers=headers, data=payload)

print(response.text)

import requests

url = "/api/v4/track_device_variables"

payload = "{\"hardware_id\":\"String\",\"product\":\"string\",\"variables\":\"Object\",\"license_key\":\"string\",\"username\":\"string\"}"
headers = {
   'Accept': 'application/json',
   'Date': 'string',
   'Authorization': 'string'
}

response = requests.request("POST", url, headers=headers, data=payload)

print(response.text)
Responses
200
400
[
    {
        "variable": "first_variable",
        "value": "cooling",
        "device_id": 1698663677416479,
        "created_at": 1698667364802
    }
]
[
    {
        "variable": "first_variable",
        "value": "cooling",
        "device_id": 1698663677416479,
        "created_at": 1698667364802
    }
]
﻿
Variables are sent as a JSON object, where parameter is the variable name and value is the value of the variable.
Eq.
"variables": {
    "first_variable": "something",
    "second_variable": "something else"
}
If a variable already exists on the device, its value will be overwritten
Device variables can also be set during activation by providing a variables parameter in the activation payload, with the same syntax as described on this page. For more details see: Activate License (Online Method)﻿, Activate License (Offline Method)﻿ 
Schema
Request Body
TypeScript
JSON
type TrackDeviceVariablesRequestBody = {
  
  // required parameters:
  product: string,
  hardware_id: string,
  variables: {
    [key: string]: string | number | boolean,
  }
  
  // required for key-based products:
  license_key: string,
  
  // required for user-based products:
  username: string,
}
type TrackDeviceVariablesRequestBody = {
  
  // required parameters:
  product: string,
  hardware_id: string,
  variables: {
    [key: string]: string | number | boolean,
  }
  
  // required for key-based products:
  license_key: string,
  
  // required for user-based products:
  username: string,
}
﻿
Response Body
TypeScript
JSON
type TrackDeviceVariablesResponseBody = ({
    variable: string,
    value: string | number | boolean,
    device_id: number,
    created_at: number, // UNIX Timestamp in milliseconds, e.g. 1737128752745
})[];
type TrackDeviceVariablesResponseBody = ({
    variable: string,
    value: string | number | boolean,
    device_id: number,
    created_at: number, // UNIX Timestamp in milliseconds, e.g. 1737128752745
})[];
﻿
License Authorization Method
There are two types of product licenses based on how the client application authorizes itself to interact with a license:
Key-based product licenses: client interactions with the license have to be authorized using a license_key
User-based product licenses: the license has a corresponding "license user" instead of a license key. Client interactions with the license have to be authorized using a username 
Errors
If an error occurs, the response will have an HTTP status code of 400 or higher, and the response body will contain an error description in the following format:
TypeScript
{
  status: number,
  code: string,
  message: string
}
{
  status: number,
  code: string,
  message: string
}
﻿
List of exceptions
unknown_product (400): Provided product was not found
license_not_found (400): License with the provided license user not found
license_not_active (400): The license is not active
license_not_enabled (400): The license is not enabled
device_not_found (400): An active device matching the hardware_id not found
blacklisted (400): This device is blacklisted
invalid json?
Updated 17 Jan 2025
Did this page help you?
Get Device Variables
Change Password