Skip to content

Latest commit

 

History

History
573 lines (284 loc) · 18 KB

metrics.schema.md

File metadata and controls

573 lines (284 loc) · 18 KB

Metrics Schema

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

This is map of metrics and measures. Each key is the valid URI of a known Metric. Each value is a Measure, i.e. a concrete data point.

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

Schema Hierarchy

  • Metrics https://ns.adobe.com/xdm/data/metrics
    • Measure https://ns.adobe.com/xdm/data/measure

Metrics Example

{
  "https://ns.adobe.com/xdm/data/metrics/direct-marketing/sends": {
    "xdm:value": 1000
  },
  "https://ns.adobe.com/xdm/data/metrics/commerce/product-views": {
    "xdm:value": 20,
    "xdm:unit": null
  },
  "https://ns.adobe.com/xdm/data/metrics/web/page-views": {
    "@type": "https://ns.adobe.com/xdm/data/metrics/web/page-views",
    "xdm:value": 1625,
    "xdm:unit": null
  }
}

Metrics Properties

Property Type Required Defined by
https://ns.adobe.com/xdm/data/metrics/advertising/clicks Measure Optional Metrics (this schema)
https://ns.adobe.com/xdm/data/metrics/advertising/impressions Measure Optional Metrics (this schema)
https://ns.adobe.com/xdm/data/metrics/application/closes Measure Optional Metrics (this schema)
https://ns.adobe.com/xdm/data/metrics/application/crashes Measure Optional Metrics (this schema)
https://ns.adobe.com/xdm/data/metrics/application/featureusages Measure Optional Metrics (this schema)
https://ns.adobe.com/xdm/data/metrics/application/installs Measure Optional Metrics (this schema)
https://ns.adobe.com/xdm/data/metrics/application/launches Measure Optional Metrics (this schema)
https://ns.adobe.com/xdm/data/metrics/application/upgrades Measure Optional Metrics (this schema)
https://ns.adobe.com/xdm/data/metrics/commerce/abandons Measure Optional Metrics (this schema)
https://ns.adobe.com/xdm/data/metrics/commerce/checkouts Measure Optional Metrics (this schema)
https://ns.adobe.com/xdm/data/metrics/commerce/product-list-adds Measure Optional Metrics (this schema)
https://ns.adobe.com/xdm/data/metrics/commerce/product-list-opens Measure Optional Metrics (this schema)
https://ns.adobe.com/xdm/data/metrics/commerce/product-list-removals Measure Optional Metrics (this schema)
https://ns.adobe.com/xdm/data/metrics/commerce/product-list-reopens Measure Optional Metrics (this schema)
https://ns.adobe.com/xdm/data/metrics/commerce/product-list-views Measure Optional Metrics (this schema)
https://ns.adobe.com/xdm/data/metrics/commerce/product-views Measure Optional Metrics (this schema)
https://ns.adobe.com/xdm/data/metrics/commerce/purchases Measure Optional Metrics (this schema)
https://ns.adobe.com/xdm/data/metrics/commerce/save-for-laters Measure Optional Metrics (this schema)
https://ns.adobe.com/xdm/data/metrics/direct-marketing/bounces Measure Optional Metrics (this schema)
https://ns.adobe.com/xdm/data/metrics/direct-marketing/mirror-pages Measure Optional Metrics (this schema)
https://ns.adobe.com/xdm/data/metrics/direct-marketing/non-deliverables Measure Optional Metrics (this schema)
https://ns.adobe.com/xdm/data/metrics/direct-marketing/not-sent Measure Optional Metrics (this schema)
https://ns.adobe.com/xdm/data/metrics/direct-marketing/opens Measure Optional Metrics (this schema)
https://ns.adobe.com/xdm/data/metrics/direct-marketing/sends Measure Optional Metrics (this schema)
https://ns.adobe.com/xdm/data/metrics/direct-marketing/unsubscriptions Measure Optional Metrics (this schema)
https://ns.adobe.com/xdm/data/metrics/direct-marketing/user-complaints Measure Optional Metrics (this schema)
https://ns.adobe.com/xdm/data/metrics/web/link-clicks Measure Optional Metrics (this schema)
https://ns.adobe.com/xdm/data/metrics/web/page-views Measure Optional Metrics (this schema)
* any Additional this schema allows additional properties

https://ns.adobe.com/xdm/data/metrics/advertising/clicks

Click(s) actions on an advertisement.

https://ns.adobe.com/xdm/data/metrics/advertising/clicks

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

https://ns.adobe.com/xdm/data/metrics/advertising/clicks Type

  • Measure – https://ns.adobe.com/xdm/data/measure

https://ns.adobe.com/xdm/data/metrics/advertising/impressions

Impression(s) of an advertisement to an end user with the potential of being viewed.

https://ns.adobe.com/xdm/data/metrics/advertising/impressions

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

https://ns.adobe.com/xdm/data/metrics/advertising/impressions Type

  • Measure – https://ns.adobe.com/xdm/data/measure

https://ns.adobe.com/xdm/data/metrics/application/closes

Graceful termination(s) of an application.

https://ns.adobe.com/xdm/data/metrics/application/closes

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

https://ns.adobe.com/xdm/data/metrics/application/closes Type

  • Measure – https://ns.adobe.com/xdm/data/measure

https://ns.adobe.com/xdm/data/metrics/application/crashes

Triggered when the application does not exit gracefully. Event is sent on application launch after a crash.

https://ns.adobe.com/xdm/data/metrics/application/crashes

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

https://ns.adobe.com/xdm/data/metrics/application/crashes Type

  • Measure – https://ns.adobe.com/xdm/data/measure

https://ns.adobe.com/xdm/data/metrics/application/featureusages

Activation(s) of an application feature that is being measured.

https://ns.adobe.com/xdm/data/metrics/application/featureusages

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

https://ns.adobe.com/xdm/data/metrics/application/featureusages Type

  • Measure – https://ns.adobe.com/xdm/data/measure

https://ns.adobe.com/xdm/data/metrics/application/installs

Install of an application on a device. Triggered on first launch after install.

https://ns.adobe.com/xdm/data/metrics/application/installs

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

https://ns.adobe.com/xdm/data/metrics/application/installs Type

  • Measure – https://ns.adobe.com/xdm/data/measure

https://ns.adobe.com/xdm/data/metrics/application/launches

Launch of an application. Triggered on every run, including crashes and installs. Also triggered on a resume from background when the lifecycle session timeout has been exceeded.

https://ns.adobe.com/xdm/data/metrics/application/launches

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

https://ns.adobe.com/xdm/data/metrics/application/launches Type

  • Measure – https://ns.adobe.com/xdm/data/measure

https://ns.adobe.com/xdm/data/metrics/application/upgrades

Upgrade of an application that has previously been installed. Triggered on first launch after upgrade.

https://ns.adobe.com/xdm/data/metrics/application/upgrades

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

https://ns.adobe.com/xdm/data/metrics/application/upgrades Type

  • Measure – https://ns.adobe.com/xdm/data/measure

https://ns.adobe.com/xdm/data/metrics/commerce/abandons

A product-list has been identified as no longer accessible (e.g purchasable) by the user.

https://ns.adobe.com/xdm/data/metrics/commerce/abandons

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

https://ns.adobe.com/xdm/data/metrics/commerce/abandons Type

  • Measure – https://ns.adobe.com/xdm/data/measure

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

An action 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.

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

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

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

  • Measure – https://ns.adobe.com/xdm/data/measure

https://ns.adobe.com/xdm/data/metrics/commerce/product-list-adds

Addition of a product to the product-list. Example a product is added to a shopping cart.

https://ns.adobe.com/xdm/data/metrics/commerce/product-list-adds

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

https://ns.adobe.com/xdm/data/metrics/commerce/product-list-adds Type

  • Measure – https://ns.adobe.com/xdm/data/measure

https://ns.adobe.com/xdm/data/metrics/commerce/product-list-opens

Initializations of a new product-list. Example a shopping cart is created.

https://ns.adobe.com/xdm/data/metrics/commerce/product-list-opens

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

https://ns.adobe.com/xdm/data/metrics/commerce/product-list-opens Type

  • Measure – https://ns.adobe.com/xdm/data/measure

https://ns.adobe.com/xdm/data/metrics/commerce/product-list-removals

Removal(s) of a product entry from a product-list. Example a product is removed from a shopping cart.

https://ns.adobe.com/xdm/data/metrics/commerce/product-list-removals

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

https://ns.adobe.com/xdm/data/metrics/commerce/product-list-removals Type

  • Measure – https://ns.adobe.com/xdm/data/measure

https://ns.adobe.com/xdm/data/metrics/commerce/product-list-reopens

A product-list that was no longer accessible(abandoned) has been re-activated by the user. Example via a re-marketing activity.

https://ns.adobe.com/xdm/data/metrics/commerce/product-list-reopens

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

https://ns.adobe.com/xdm/data/metrics/commerce/product-list-reopens Type

  • Measure – https://ns.adobe.com/xdm/data/measure

https://ns.adobe.com/xdm/data/metrics/commerce/product-list-views

View(s) of a product-list has occurred.

https://ns.adobe.com/xdm/data/metrics/commerce/product-list-views

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

https://ns.adobe.com/xdm/data/metrics/commerce/product-list-views Type

  • Measure – https://ns.adobe.com/xdm/data/measure

https://ns.adobe.com/xdm/data/metrics/commerce/product-views

View(s) of a product have occurred.

https://ns.adobe.com/xdm/data/metrics/commerce/product-views

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

https://ns.adobe.com/xdm/data/metrics/commerce/product-views Type

  • Measure – https://ns.adobe.com/xdm/data/measure

https://ns.adobe.com/xdm/data/metrics/commerce/purchases

An order has been accepted. Purchase is the only required action in a commerce conversion. Purchase must have a product-list referenced.

https://ns.adobe.com/xdm/data/metrics/commerce/purchases

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

https://ns.adobe.com/xdm/data/metrics/commerce/purchases Type

  • Measure – https://ns.adobe.com/xdm/data/measure

https://ns.adobe.com/xdm/data/metrics/commerce/save-for-laters

Product-list is saved for future use. Example a product wish list.

https://ns.adobe.com/xdm/data/metrics/commerce/save-for-laters

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

https://ns.adobe.com/xdm/data/metrics/commerce/save-for-laters Type

  • Measure – https://ns.adobe.com/xdm/data/measure

https://ns.adobe.com/xdm/data/metrics/direct-marketing/bounces

Asynchronous message(s) that have been returned as temporarily undeliverable the receiving system.

https://ns.adobe.com/xdm/data/metrics/direct-marketing/bounces

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

https://ns.adobe.com/xdm/data/metrics/direct-marketing/bounces Type

  • Measure – https://ns.adobe.com/xdm/data/measure

https://ns.adobe.com/xdm/data/metrics/direct-marketing/mirror-pages

Click on a link in a message to a web hosted mirror page.

https://ns.adobe.com/xdm/data/metrics/direct-marketing/mirror-pages

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

https://ns.adobe.com/xdm/data/metrics/direct-marketing/mirror-pages Type

  • Measure – https://ns.adobe.com/xdm/data/measure

https://ns.adobe.com/xdm/data/metrics/direct-marketing/non-deliverables

Asynchronous message(s) failed to deliver in a way that indicates that no future delivery attempts will be successful to the address.

https://ns.adobe.com/xdm/data/metrics/direct-marketing/non-deliverables

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

https://ns.adobe.com/xdm/data/metrics/direct-marketing/non-deliverables Type

  • Measure – https://ns.adobe.com/xdm/data/measure

https://ns.adobe.com/xdm/data/metrics/direct-marketing/not-sent

Asynchronous message (email, SMS, MMS etc) was not dispatched due to cancellation or expiration of the marketing activity.

https://ns.adobe.com/xdm/data/metrics/direct-marketing/not-sent

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

https://ns.adobe.com/xdm/data/metrics/direct-marketing/not-sent Type

  • Measure – https://ns.adobe.com/xdm/data/measure

https://ns.adobe.com/xdm/data/metrics/direct-marketing/opens

The direct marketing message (email, SMS, Push Notifications etc) has been opened/swyped/touched by the recipient.

https://ns.adobe.com/xdm/data/metrics/direct-marketing/opens

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

https://ns.adobe.com/xdm/data/metrics/direct-marketing/opens Type

  • Measure – https://ns.adobe.com/xdm/data/measure

https://ns.adobe.com/xdm/data/metrics/direct-marketing/sends

Asynchronous message(s) (email, SMS, MMS etc) have been dispatched to a person's account/address/device.

https://ns.adobe.com/xdm/data/metrics/direct-marketing/sends

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

https://ns.adobe.com/xdm/data/metrics/direct-marketing/sends Type

  • Measure – https://ns.adobe.com/xdm/data/measure

https://ns.adobe.com/xdm/data/metrics/direct-marketing/unsubscriptions

The recipient of the direct marketing message (email, newsletters, etc) has opted out from receiving them.

https://ns.adobe.com/xdm/data/metrics/direct-marketing/unsubscriptions

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

https://ns.adobe.com/xdm/data/metrics/direct-marketing/unsubscriptions Type

  • Measure – https://ns.adobe.com/xdm/data/measure

https://ns.adobe.com/xdm/data/metrics/direct-marketing/user-complaints

User complaint(s) have been received. This generally occurs when a recipient of a message reports it as spam.

https://ns.adobe.com/xdm/data/metrics/direct-marketing/user-complaints

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

https://ns.adobe.com/xdm/data/metrics/direct-marketing/user-complaints Type

  • Measure – https://ns.adobe.com/xdm/data/measure

https://ns.adobe.com/xdm/data/metrics/web/link-clicks

Click of a web-link has occurred.

https://ns.adobe.com/xdm/data/metrics/web/link-clicks

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

https://ns.adobe.com/xdm/data/metrics/web/link-clicks Type

  • Measure – https://ns.adobe.com/xdm/data/measure

https://ns.adobe.com/xdm/data/metrics/web/page-views

View(s) of a webpage has occurred.

https://ns.adobe.com/xdm/data/metrics/web/page-views

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

https://ns.adobe.com/xdm/data/metrics/web/page-views Type

  • Measure – https://ns.adobe.com/xdm/data/measure