Skip to content

Latest commit

 

History

History
143 lines (76 loc) · 3.08 KB

checkouts.schema.md

File metadata and controls

143 lines (76 loc) · 3.08 KB

Checkouts Schema

https://ns.adobe.com/xdm/data/metrics/checkouts

Number of actions during a checkout process of a product list, there can be more than one checkout event if there are multiple steps in a checkout process. If there are multiple steps the event time information and referenced page or experience is used to identify the step individual events represent in order.

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

Schema Hierarchy

  • Checkouts https://ns.adobe.com/xdm/data/metrics/checkouts

Checkouts Example

{
  "schema:name": "commerce metric: checkouts",
  "@id": "xdm:checkouts",
  "xdm:measurement": "count",
  "xdm:unit": null
}

Checkouts Properties

Property Type Required Defined by
@id string Required Metric Definition
schema:name string Required Metric Definition
xdm:measurement string Required Metric Definition
xdm:unit complex Required Metric Definition
* any Additional this schema allows additional properties

@id

The unique identifier of this metric.

@id

@id Type

string

  • format: uri – Uniformous Resource Identifier (according to RFC3986)

schema:name

The human-readable name of the metric. The name can be used in user interfaces and does not have to be unique.

schema:name

  • is required
  • type: string
  • defined in Metric Definition

schema:name Type

string

xdm:measurement

How to take measures of this metric.

xdm:measurement

  • is required
  • type: string
  • defined in Metric Definition

xdm:measurement Type

string

xdm:measurement Examples

"distance"
"time"
"price"
"count"

xdm:unit

xdm:unit

  • is required
  • type: complex
  • defined in Metric Definition

xdm:unit Type

Any following options needs to be fulfilled.

Option 1

string

Option 2