Custom Properties

Apart from the pre-set values that Revulytics Usage Intelligence collects, such as OS version, product version, edition, language, and license type you also have the ability 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 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 static for a particular installation since the reporting granularity provided by Revulytics Usage Intelligence 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), Revulytics Usage Intelligence will only store the latest known property value for that user on that particular day.

IMPORTANT: tbSetCustomProperty() does not have to be called. If it is called, it must be after calling tbCreateConfig().

Note: By default you can store up to 1000 unique values inside every custom property. Please contact V.i Laboratories Revulytics Usage Intelligence support ( if you want to discuss this limit or alternative uses.

TBRESULT tbSetCustomProperty(TBINSTANCE *tbInstance, unsigned short index, const wchar_t *customValue)

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


tbInstance (TBINSTANCE*) - The Revulytics Usage Intelligence SDK instance returned in call to tbCreateInstance()

index (unsigned short) - This is a numeric index between 1 and 20. On the Revulytics Usage Intelligence 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 (wchar_t*) - The value to be assigned to the custom property. A NULL or empty removes any previous value.

Returns:One of the return status constants below.
* TB_OK (1)