Developer Zone

Custom Properties

Apart from the pre-set values that Trackerbird collects, such as OS version, product version, edition, language, license type, etc. you also have the possibility to collect any custom value that is relevant to your specific application.

Typical examples where you can benefit from custom properties include storing the download source or marketing campaign from where the user downloaded your software or else some other status in your application. These custom properties will then be available inside the filters panel on every report so you may use them as part of your report filtering criteria.

Please note that Custom properties are intended to store values that are not very dynamic for a particular installation since the reporting granularity provided by Trackerbird is on a daily basis. This means if you use this API to register multiple values inside the same custom property (for the same user), Trackerbird will only store the latest known property value for that user on that particular day.

Note: By default you can store up to 1000 unique values inside every custom property. Please contact Trackerbird support if you want to discuss this limit or alternative uses.

setCustomProperty(index, customValue)

This function is used to set the value of a custom property.

Parameters:
  • index (int) – This is a numeric index between 1 and 20. On the Trackerbird web UI, custom values are given an ID ranging from C01 to C20. This ID is used to identify which of the 20 possible custom value is being set.
  • customValue (str/unicode) – The value to be assigned to the custom property.
Return type:

One of the return status constants below.

* OK (1)
* CONFIG_NOT_CREATED (-5)
* INVALID_PARAMETER (-9)