Scan Data Fields Glossary

These fields are returned by the download scans API. See Download Scan Data for more details on how to retrieve the scans.

Section	Description
scan	fields populated by the scan activity
user	only contains data if the scan is performed by a named user.
code	data fields copied from the code for convenience
product	data fields copied from the product for convenience
device	data taken from the device used to scan the code
location	data populated by the location-service, ip or gps based on the user
scm	supply chain fields added to the code at time of scanning

scan

• scan.uuid: globally unique tracking id of a scan
• scan.datetime: ISO date when the scan was made
• scan.timestamp: Unix epoch timestamp when the scan was made
• scan.app: application used to make the scan. "Other" if the application was not recognized
• scan.reason: query (for qr lookup) or auth (for an authentication scan - codes with secure graphic only)
• scan.result: scanresult as determined by the backend (ok or failure)
• scan.computed_status:
• scan.auth_failure_mode: details on why the authentication failed (for an authentication scan - codes with secure graphic only)
• scan.flags: anomalies flagged by the backend, partially determined by the scan alerts
• scan.unique_user: unique id for the user extracted from the app or the browser
• scan.install_id: unique install-id extracted from the app or the browser
• scan.utid: tracking id

user

• user.email: set when a named user scans the codes

code

• code.extended_id: extended_id as embedded in the QR message
• code.serial_number: random serial number as set on each code. can be customer-assigned
• code.activation_status: 0-inactive, 1-active, 2-blacklisted
• code.blacklist_reason: when a code is blacklisted, a reason is assigned

product

• product.id: system-identifier for a product
• product.sku: customer identifier set for a product
• product.name: product name
• product.brand_name: brand name to which the product was assigned

device

• device.imei: (deprecated) device hardware identifier
• device.model: technical model number as extracted from the User-agent header
• device.model_name: commercial mode as extracted from the User-agent header
• device.os: operating system of the device

location

• location.method: ip or gps
• location.country_code: ISO code of the country where the code was scanned
• location.country: country name of the country where the code was scanned
• location.province: province in which the code was scanned
• location.city: city in which the code was scanned
• location.lat: latitude for the scan (as determined by the best-guess location service)
• location.lng: longitude for the scan (as determined by the best-guess location service)

scm

• scm.case_number: (example) SCM field with key case_number as defined in the campaign options
• scm.consumed_date: (example) SCM field with key consumed_date as defined in the campaign options
• scm.distributor: (example) SCM field with key distributor as defined in the campaign options
• etc.