- Updating Device Data
- Useful Links
- Supported Versions
This tutorial illustrates how to access match metrics. The following is covered:
- How to retrieve device Id.
- How to retrieve match method.
- How to retrieve difference.
- How to retrieve rank.
Code and Explanation
Getting started example of using 51Degrees device detection match metrics
information. The example shows how to:
dataFile = settings.V3_WRAPPER_DATABASE
properties = settings.PROPERTIES
cacheSize = settings.CACHE_SIZE
poolSize = settings.POOL_SIZE
provider = fiftyone_degrees_mobile_detector_v3_wrapper.Provider(dataFile, properties, cacheSize, poolSize)
match = provider.getMatch(userAgent)
match.getRank()This example can be run in any directory, but assumes your settings file contains a valid dataFile location and has the IsMobile property selected.
Match metrics is an additional piece of information about each match result. It can help developers spot fake User-Agents and determine the general level of confidence the detector has in the current detection results.
Device metrics consists of four parts: device Id, detection method, difference and rank.
Device Id is composed of four components, each represented as a number and separated by the hyphen symbol. Numbers correspond to profile IDs the detector has selected for that particular component. The four components are: hardware, software, browser and crawler. For more information please see the 51Degrees Data Model .
The detection method provides information on what algorithm was used for this particular detection and difference indicates by how much the provided User-Agent is different to the best signatures found in the data file. The larger the number the less confident the detector is. Difference for the 'exact' method is always zero. Difference for the 'none' detection method is irrelevant. For more information see the How Device Detection Works page.
Rank value tells you how popular the identified device is. The lower the value the more popular the device. Popularity is derived by 51Degrees based on our observed usage level.
Other uses for match metrics include:
- Ranking devices by popularity. Best used in conjunction with other tutorials to rank the results based on the general device popularity.
- Storing device Id for analytics instead of individual profiles.
The Lite data file contains 446,634 device combinations, whilst Premium and Enterprise contain 940,018 and 1,407,838 device combinations respectively. A larger set of device combinations leads to the 'exact' detection method being used more frequently and the rank providing a more accurate value.