Skip to main content

Scan Metadata

When creating a scan, you may optionally provide a scanMetadata object.

The purpose of this field is to supply additional data to improve DyScan's performance. Any metadata you include is sent along with the scan request and will signficantly enhance performance and the quality of downstream analysis.

Format​

scanMetadata must follow this structure:

version​

type: integer​

Identifies the schema version of the metadata payload

data​

type: Dict[str, Any]​

Contains arbitrary metadata key–value pairs

{
  "version": 1,
  "data": {
    "deviceID": "510e48ce-3724-4943-a924-06708c53dd70",
    "orderAmount": "9.99",
    "currency": "USD"
  }
}

See here for a comprehensive list of commonly provided data fields, but please reach out if you'd like to consult us on specific recommendations for your business or use case.