Mailchimp · Schema

MessageInfo

Summary information about a sent message.

CampaignsEmail MarketingMarketing AutomationNewslettersTransactional Email

Properties

Name	Type	Description
ts	integer	The Unix timestamp when the message was sent.
_id	string	The unique message ID.
sender	string	The sender email address.
template	string	The template slug used, if any.
subject	string	The subject line of the message.
email	string	The recipient email address.
tags	array	Tags applied to the message.
opens	integer	The number of times the message was opened.
opens_detail	array	Detailed open tracking events.
clicks	integer	The number of link clicks in the message.
clicks_detail	array	Detailed click tracking events.
state	string	The current state of the message.
metadata	object	Custom metadata attached to the message.

View JSON Schema on GitHub

JSON Schema

{
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "$id": "#/components/schemas/MessageInfo",
  "title": "MessageInfo",
  "type": "object",
  "description": "Summary information about a sent message.",
  "properties": {
    "ts": {
      "type": "integer",
      "description": "The Unix timestamp when the message was sent.",
      "example": 10
    },
    "_id": {
      "type": "string",
      "description": "The unique message ID.",
      "example": "500123"
    },
    "sender": {
      "type": "string",
      "format": "email",
      "description": "The sender email address.",
      "example": "example_value"
    },
    "template": {
      "type": "string",
      "description": "The template slug used, if any.",
      "example": "example_value"
    },
    "subject": {
      "type": "string",
      "description": "The subject line of the message.",
      "example": "example_value"
    },
    "email": {
      "type": "string",
      "format": "email",
      "description": "The recipient email address.",
      "example": "[email protected]"
    },
    "tags": {
      "type": "array",
      "items": {
        "type": "string"
      },
      "description": "Tags applied to the message.",
      "example": []
    },
    "opens": {
      "type": "integer",
      "description": "The number of times the message was opened.",
      "example": 10
    },
    "opens_detail": {
      "type": "array",
      "items": {
        "type": "object",
        "properties": {
          "ts": {
            "type": "integer",
            "description": "Unix timestamp of the open event."
          },
          "ip": {
            "type": "string",
            "description": "IP address from which the message was opened."
          },
          "location": {
            "type": "string",
            "description": "Approximate geographic location of the open."
          },
          "ua": {
            "type": "string",
            "description": "User agent string of the client."
          }
        }
      },
      "description": "Detailed open tracking events.",
      "example": []
    },
    "clicks": {
      "type": "integer",
      "description": "The number of link clicks in the message.",
      "example": 10
    },
    "clicks_detail": {
      "type": "array",
      "items": {
        "type": "object",
        "properties": {
          "ts": {
            "type": "integer",
            "description": "Unix timestamp of the click event."
          },
          "url": {
            "type": "string",
            "description": "The URL that was clicked."
          },
          "ip": {
            "type": "string",
            "description": "IP address of the clicker."
          },
          "location": {
            "type": "string",
            "description": "Approximate geographic location of the click."
          },
          "ua": {
            "type": "string",
            "description": "User agent string of the client."
          }
        }
      },
      "description": "Detailed click tracking events.",
      "example": []
    },
    "state": {
      "type": "string",
      "enum": [
        "sent",
        "bounced",
        "rejected",
        "soft-bounced",
        "spam",
        "unsub"
      ],
      "description": "The current state of the message.",
      "example": "sent"
    },
    "metadata": {
      "type": "object",
      "additionalProperties": {
        "type": "string"
      },
      "description": "Custom metadata attached to the message.",
      "example": "example_value"
    }
  }
}