Skip to content

Latest commit

 

History

History
688 lines (377 loc) · 13.7 KB

feedbackevent.schema.md

File metadata and controls

688 lines (377 loc) · 13.7 KB
Raw

Adobe Delivery Feedback Events Schema

https://ns.adobe.com/experience/campaign/feedbackevent

Contains all delivery event fields.

Abstract Extensible Status Identifiable Custom Properties Additional Properties Defined In
Can be instantiated Yes Stable No Forbidden Permitted adobe/experience/campaign/feedbackevent.schema.json

Adobe Delivery Feedback Events Properties

Property Type Required Defined by
https://ns.adobe.com/experience/campaign/feedback/channel object Optional Adobe Delivery Feedback Events (this schema)
https://ns.adobe.com/experience/campaign/feedback/delivery object Optional Adobe Delivery Feedback Events (this schema)
https://ns.adobe.com/experience/campaign/feedback/message object Optional Adobe Delivery Feedback Events (this schema)
https://ns.adobe.com/experience/campaign/feedback/messageFailure object Optional Adobe Delivery Feedback Events (this schema)
https://ns.adobe.com/experience/campaign/feedback/solutionContext Key Value Pair Optional Adobe Delivery Feedback Events (this schema)
https://ns.adobe.com/experience/campaign/feedback/type string Optional Adobe Delivery Feedback Events (this schema)
xdm:retryCount integer Optional Adobe Delivery Feedback Events (this schema)
* any Additional this schema allows additional properties

https://ns.adobe.com/experience/campaign/feedback/channel

Delivery channel

https://ns.adobe.com/experience/campaign/feedback/channel

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

https://ns.adobe.com/experience/campaign/feedback/channel Type

object with following properties:

Property Type Required
email object Optional
xdm:type string Optional

email

E-mail Channel

undefined

email

  • is optional
  • type: object
email Type

Unknown type object.

{
  "title": "E-mail Channel",
  "type": "object",
  "properties": {
    "interactions": {
      "title": "User Interactions",
      "type": "object",
      "properties": {
        "xdm:spamType": {
          "title": "Spam Type",
          "type": "string",
          "description": "Type of spam report entered against this message (see RFC 5965 § 7.3).",
          "meta:titleId": "feedbackevent##xdm:spamType##title##78981",
          "meta:descriptionId": "feedbackevent##xdm:spamType##description##90271"
        },
        "xdm:reportedBy": {
          "title": "Reported By",
          "type": "string",
          "description": "E-mail Address of the entity reporting this message as spam.",
          "meta:titleId": "feedbackevent##xdm:reportedBy##title##91731",
          "meta:descriptionId": "feedbackevent##xdm:reportedBy##description##38351"
        },
        "xdm:reportTo": {
          "title": "Report To",
          "type": "string",
          "description": "E-mail Address to which this spam report is to be delivered.",
          "meta:titleId": "feedbackevent##xdm:reportTo##title##90131",
          "meta:descriptionId": "feedbackevent##xdm:reportTo##description##86451"
        },
        "xdm:userAgent": {
          "title": "User Agent",
          "type": "string",
          "description": "Value of the browser's User-Agent header.",
          "meta:titleId": "feedbackevent##xdm:userAgent##title##85711",
          "meta:descriptionId": "feedbackevent##xdm:userAgent##description##76961"
        }
      },
      "meta:titleId": "feedbackevent##interactions##title##39261"
    },
    "operationalContext": {
      "title": "Operational Context",
      "type": "object",
      "properties": {
        "xdm:outboundIP": {
          "title": "IP Address",
          "type": "string",
          "description": "Outbound IP address of the customer used to deliver the message.",
          "meta:titleId": "feedbackevent##xdm:outboundIP##title##11691",
          "meta:descriptionId": "feedbackevent##xdm:outboundIP##description##32721"
        },
        "xdm:sendProtocol": {
          "title": "Send Protocol",
          "type": "string",
          "description": "Protocol by which the message is delivered.",
          "meta:titleId": "feedbackevent##xdm:sendProtocol##title##77221",
          "meta:descriptionId": "feedbackevent##xdm:sendProtocol##description##15751"
        },
        "xdm:remoteIp": {
          "title": "IP Address",
          "type": "string",
          "oneOf": [
            {
              "format": "ipv4"
            },
            {
              "format": "ipv6"
            }
          ],
          "description": "IP address of the host to which this message is delivered.",
          "meta:titleId": "feedbackevent##xdm:remoteIp##title##71451",
          "meta:descriptionId": "feedbackevent##xdm:remoteIp##description##62391"
        },
        "xdm:mtaHost": {
          "title": "Node Name",
          "type": "string",
          "description": "Name of the MTA Instance originating the events.",
          "meta:titleId": "feedbackevent##xdm:mtaHost##title##5321",
          "meta:descriptionId": "feedbackevent##xdm:mtaHost##description##44431"
        },
        "xdm:mtaIp": {
          "title": "Sending IP Address",
          "type": "string",
          "oneOf": [
            {
              "format": "ipv4"
            },
            {
              "format": "ipv6"
            }
          ],
          "description": "IP address through which this message was sent.",
          "meta:titleId": "feedbackevent##xdm:mtaIp##title##40251",
          "meta:descriptionId": "feedbackevent##xdm:mtaIp##description##26591"
        },
        "xdm:queueTime": {
          "title": "Queue time",
          "type": "number",
          "description": "Delay, expressed in milliseconds, between this message's injection into SparkPost and its delivery to the receiving domain; that is, the length of time this message spent in the outgoing queue.",
          "meta:titleId": "feedbackevent##xdm:queueTime##title##78331",
          "meta:descriptionId": "feedbackevent##xdm:queueTime##description##16651"
        }
      },
      "meta:titleId": "feedbackevent##operationalContext##title##52921"
    }
  },
  "meta:titleId": "feedbackevent##email##title##44831",
  "simpletype": "`object`"
}

xdm:type

Channel Type

Classifies whether the channel is email, push, sms.

xdm:type

  • is optional
  • type: string
xdm:type Type

string

https://ns.adobe.com/experience/campaign/feedback/delivery

The campaign activity originating a message to a recipient.

https://ns.adobe.com/experience/campaign/feedback/delivery

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

https://ns.adobe.com/experience/campaign/feedback/delivery Type

object with following properties:

Property Type Required
xdm:campaignId string Optional
xdm:from string Optional
xdm:id string Optional
xdm:label string Optional
xdm:name string Optional
xdm:type string Optional

xdm:campaignId

Campaign Id

Campaign of which this delivery was a part.

xdm:campaignId

  • is optional
  • type: string
xdm:campaignId Type

string

xdm:from

From

Address used as a from/sender/caller address. Depending on the communication channel, the address has a different format.

  • email: an email address.
  • textMessage or phone: a shortcode or phone number.

xdm:from

  • is optional
  • type: string
xdm:from Type

string

xdm:id

Delivery ID

The campaign activity originating this message.

xdm:id

  • is optional
  • type: string
xdm:id Type

string

xdm:label

Delivery Label

A human-friendly name of the campaign activity which is originating this message.

xdm:label

  • is optional
  • type: string
xdm:label Type

string

xdm:name

Delivery Internal Name

A human-friendly identifier of the campaign activity which is originating this message.

xdm:name

  • is optional
  • type: string
xdm:name Type

string

xdm:type

Delivery Type

Mode of delivery for the messages sent.

xdm:type

  • is optional
  • type: string
xdm:type Type

string

https://ns.adobe.com/experience/campaign/feedback/message

A single message sent to a recipient.

https://ns.adobe.com/experience/campaign/feedback/message

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

https://ns.adobe.com/experience/campaign/feedback/message Type

object with following properties:

Property Type Required
recipient object Optional
size integer Optional
subject string Optional
xdm:id string Optional

recipient

The recipient of this message

undefined

recipient

  • is optional
  • type: object
recipient Type

Unknown type object.

{
  "title": "The recipient of this message",
  "type": "object",
  "properties": {
    "xdm:to": {
      "title": "To",
      "type": "string",
      "description": "Address used as a to/callee address. Depending on the communication channel, the `address` has a different format.\n\n  * `email`: an email address.\n  * `textMessage` or `phone`: a shortcode or phone number.",
      "meta:titleId": "feedbackevent##xdm:to##title##98651",
      "meta:descriptionId": "feedbackevent##xdm:to##description##58751"
    },
    "xdm:type": {
      "title": "Type",
      "type": "string",
      "description": "Whether this message message event describes the BCC, CC or To recipient.",
      "meta:titleId": "feedbackevent##xdm:type##title##65901",
      "meta:descriptionId": "feedbackevent##xdm:type##description##52831"
    }
  },
  "meta:titleId": "feedbackevent##recipient##title##41241",
  "simpletype": "`object`"
}

size

Message Size

Size in bytes of the message.

size

  • is optional
  • type: integer
size Type

integer

subject

Message Subject

Subject line of the message.

subject

  • is optional
  • type: string
subject Type

string

xdm:id

Message Identifier

Identifier of the message.

xdm:id

  • is optional
  • type: string
xdm:id Type

string

https://ns.adobe.com/experience/campaign/feedback/messageFailure

Message Failure

https://ns.adobe.com/experience/campaign/feedback/messageFailure

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

https://ns.adobe.com/experience/campaign/feedback/messageFailure Type

object with following properties:

Property Type Required
xdm:bounceClass string Optional
xdm:bounceType string Optional
xdm:canonicalReason string Optional
xdm:errorCode string Optional
xdm:reason string Optional

xdm:bounceClass

Bounce Class

Classification code for a given message.

xdm:bounceClass

  • is optional
  • type: string
xdm:bounceClass Type

string

xdm:bounceType

Bounce Type

Classifies whether it is a soft bounce or hard bounce.

xdm:bounceType

  • is optional
  • type: string
xdm:bounceType Type

string

xdm:canonicalReason

Canonical Reason

Canonicalized text of the response returned by the remote server due to a failed delivery attempt.

xdm:canonicalReason

  • is optional
  • type: string
xdm:canonicalReason Type

string

xdm:errorCode

Error Code

Error code by which the remote server described a failed delivery attempt.

xdm:errorCode

  • is optional
  • type: string
xdm:errorCode Type

string

xdm:reason

Reason

Unmodified, exact response returned by the remote server due to a failed delivery attempt.

xdm:reason

  • is optional
  • type: string
xdm:reason Type

string

https://ns.adobe.com/experience/campaign/feedback/solutionContext

Solution Context

List of solution specific key value pairs.

https://ns.adobe.com/experience/campaign/feedback/solutionContext

  • is optional

  • type: Key Value Pair

  • defined in this schema

https://ns.adobe.com/experience/campaign/feedback/solutionContext Type

Array type: Key Value Pair

All items must be of the type:

  • Key Value Pair – https://ns.adobe.com/experience/analytics/keyvalue

https://ns.adobe.com/experience/campaign/feedback/type

Feedback Type

The type of message event.

https://ns.adobe.com/experience/campaign/feedback/type

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

https://ns.adobe.com/experience/campaign/feedback/type Type

string

xdm:retryCount

Retry Count

Number of failed attempts before the current event.

xdm:retryCount

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

xdm:retryCount Type

integer