Skip to content

Latest commit

 

History

History
69 lines (38 loc) · 2.09 KB

measure.schema.md

File metadata and controls

69 lines (38 loc) · 2.09 KB

Measure Schema

https://ns.adobe.com/xdm/data/measure

A measure is a concrete quantifiable data point of a particular metric.

It has a value, and a unique identifier.

Abstract Extensible Status Identifiable Custom Properties Additional Properties Defined In
Can be instantiated Yes Stabilizing No Forbidden Permitted data/measure.schema.json

Measure Example

{
  "xdm:value": 175
}

Measure Properties

Property Type Required Defined by
xdm:id string Optional Measure (this schema)
xdm:value number Required Measure (this schema)
* any Additional this schema allows additional properties

xdm:id

Unique Identifier

Unique identifier of the measure. In cases of data collection using lossy communication channels, such as mobile apps or websites with offline functionality, where transmission of measures cannot be ensured, this property contains a client-generated, unique ID of the measure taken. It is best practice to make this sufficiently long to ensure enough entropy. Additionally, if information such as time stamp, device ID, IP, or MAC address, or other potentially user-identifying values are incorporated in the generation of the xdm:id, the result should be hashed, so that no PII is encoded in the value, as the goal is not to identify user or device, but the specific measure in time.

xdm:id

  • is optional
  • type: string
  • defined in this schema

xdm:id Type

string

xdm:value

The quantifiable value of this measure.

xdm:value

  • is required
  • type: number
  • defined in this schema

xdm:value Type

number