Skip to content

Latest commit

 

History

History
205 lines (159 loc) · 7.74 KB

summary_metrics.schema.md

File metadata and controls

205 lines (159 loc) · 7.74 KB
Raw

XDM Summary Metrics Schema

https://ns.adobe.com/xdm/classes/summarymetrics

A Summary Metric record provides pre-summarized metrics with grouping dimensions. An example would be the results of an SQL SELECT with a GROUP BY.

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

Schema Hierarchy

XDM Summary Metrics Examples

{
  "xdm:timestamp": "2022-01-01T00:00:00+00:00",
  "xdm:placeContext": {
    "xdm:geo": {
      "xdm:stateProvince": "TX",
      "xdm:city": "Houston"
    }
  },
  "xdm:commerce": {
    "xdm:purchases": {
      "xdm:value": 500
    }
  }
}
{
  "xdm:timestamp": "2022-01-01T00:00:00+00:00",
  "xdm:commerce": {
    "xdm:purchases": {
      "xdm:value": 2500
    }
  }
}

XDM Summary Metrics Properties

Property Type Required Defined by
@id string Optional Time-series Schema
xdm:eventType string Optional Time-series Schema
xdm:timestamp string Required Time-series Schema
* any Additional this schema allows additional properties

@id

Identifier

A unique identifier for the time-series event.

@id

@id Type

string

  • format: uri-reference – URI Reference (according to RFC3986)

xdm:eventType

Event Type

The primary event type for this time-series record.

xdm:eventType

xdm:eventType Type

string

xdm:eventType Known Values

Value Description
advertising.completes Advertising Completes
advertising.timePlayed Advertising Time Played
advertising.federated Advertising Federated
advertising.clicks Advertising Clicks
advertising.conversions Advertising Conversions
advertising.firstQuartiles Advertising First Quartiles
advertising.impressions Advertising Impressions
advertising.midpoints Advertising Midpoints
advertising.starts Advertising Starts
advertising.thirdQuartiles Advertising Third Quartiles
application.close Application Close
application.launch Application Launch
web.webpagedetails.pageViews Web Webpagedetails Page Views
web.webinteraction.linkClicks Web Webinteraction Link Clicks
web.formFilledOut Web Form Filled Out
commerce.checkouts Commerce Checkouts
commerce.productListAdds Commerce Product List (Cart) Adds
commerce.productListOpens Commerce Product List (Cart) Opens
commerce.productListRemovals Commerce Product List (Cart) Removals
commerce.productListReopens Commerce Product List (Cart) Reopens
commerce.productListViews Commerce Product List (Cart) Views
commerce.productViews Commerce Product (Cart) Views
commerce.purchases Commerce Purchases
commerce.saveForLaters Commerce Save For Laters
decisioning.propositionDisplay Decisioning Proposition Display
decisioning.propositionInteract Decisioning Proposition Interact
decisioning.propositionSend Decisioning Proposition Send
decisioning.propositionDismiss Decisioning Proposition Dismiss
decisioning.propositionTrigger Decisioning Proposition Trigger
delivery.feedback Delivery Feedback
message.feedback Message Feedback
message.tracking Message Tracking
pushTracking.applicationOpened Push Tracking Application Opened
pushTracking.customAction Push Tracking Custom Action
listOperation.removeFromList List Operation Remove From List
listOperation.addToList List Operation Add To List
leadOperation.scoreChanged Lead Operation Score Changed
leadOperation.revenueStageChanged Lead Operation Revenue Stage changed
leadOperation.statusInCampaignProgressionChanged Lead Operation Status In Campaign Progression Changed
leadOperation.interestingMoment Lead Operation Interesting Moment
leadOperation.newLead Lead Operation New Lead
leadOperation.convertLead Lead Operation Convert Lead
leadOperation.callWebhook Lead Operation Call Webhook
leadOperation.changeEngagementCampaignCadence Change Engagement Campaign Cadence
leadOperation.addToCampaign Lead Operation Add To Campaign
leadOperation.changeCampaignStream Lead Operation Change Campaign Stream
leadOperation.mergeLeads Lead Operation Merge Leads
directMarketing.emailBounced Direct Marketing Email Bounced
directMarketing.emailBouncedSoft Direct Marketing Email Bounced Soft
directMarketing.emailDelivered Direct Marketing Email Delivered
directMarketing.emailUnsubscribed Direct Marketing Email Unsubscribed
directMarketing.emailOpened Direct Marketing Email Opened
directMarketing.emailClicked Direct Marketing Email Clicked
directMarketing.emailSent Direct Marketing Email Sent
opportunityEvent.removeFromOpportunity Opportunity Event Remove From Opportunity
opportunityEvent.addToOpportunity Opportunity Event Add To Opportunity
opportunityEvent.opportunityUpdated Opportunity Event Opportunity Updated
inappmessageTracking.dismiss inapp message was dimissed
inappmessageTracking.display inapp message was displayed
inappmessageTracking.interact inapp message was interacted with
media.ping Media ping
media.sessionStart Media sessionStart
media.play Media play
media.bufferStart Media bufferStart
media.pauseStart Media pauseStart
media.chapterStart Media chapterStart
media.chapterSkip Media chapterSkip
media.chapterComplete Media chapterComplete
media.adStart Media adStart
media.adSkip Media adSkip
media.adComplete Media adComplete
media.adBreakStart Media adBreakStart
media.adBreakComplete Media adBreakComplete
media.bitrateChange Media bitrateChange
media.error Media error
media.sessionComplete Media sessionComplete
media.sessionEnd Media sessionEnd
media.statesUpdate Media statesUpdate
media.downloaded Media downloaded content
location.entry Location entry
location.exit Location exit

xdm:timestamp

Timestamp

The time when an event or observation occurred.

xdm:timestamp

xdm:timestamp Type

string