Benchmark Email · Schema

CampaignReport

Analytics and performance report for an email campaign in Benchmark Email.

Email MarketingCampaignsContactsAutomationTransactional EmailMarketing

Properties

Name Type Description
EmailID integer Unique identifier of the email campaign.
Name string Name of the email campaign.
TotalSent integer Total number of emails sent.
TotalOpens integer Total number of email opens.
UniqueOpens integer Number of unique email opens.
TotalClicks integer Total number of link clicks.
UniqueClicks integer Number of unique link clicks.
Bounces integer Number of bounced emails.
Unsubscribes integer Number of unsubscribes from this campaign.
Forwards integer Number of times the email was forwarded.
OpenRate number Open rate as a percentage.
ClickRate number Click rate as a percentage.
View JSON Schema on GitHub

JSON Schema

campaign-report.json Raw ↑
{
  "$schema": "http://json-schema.org/draft-07/schema#",
  "$id": "https://raw.githubusercontent.com/api-evangelist/benchmark-email/main/json-schema/campaign-report.json",
  "title": "CampaignReport",
  "description": "Analytics and performance report for an email campaign in Benchmark Email.",
  "type": "object",
  "properties": {
    "EmailID": {
      "type": "integer",
      "description": "Unique identifier of the email campaign."
    },
    "Name": {
      "type": "string",
      "description": "Name of the email campaign."
    },
    "TotalSent": {
      "type": "integer",
      "description": "Total number of emails sent."
    },
    "TotalOpens": {
      "type": "integer",
      "description": "Total number of email opens."
    },
    "UniqueOpens": {
      "type": "integer",
      "description": "Number of unique email opens."
    },
    "TotalClicks": {
      "type": "integer",
      "description": "Total number of link clicks."
    },
    "UniqueClicks": {
      "type": "integer",
      "description": "Number of unique link clicks."
    },
    "Bounces": {
      "type": "integer",
      "description": "Number of bounced emails."
    },
    "Unsubscribes": {
      "type": "integer",
      "description": "Number of unsubscribes from this campaign."
    },
    "Forwards": {
      "type": "integer",
      "description": "Number of times the email was forwarded."
    },
    "OpenRate": {
      "type": "number",
      "format": "float",
      "description": "Open rate as a percentage."
    },
    "ClickRate": {
      "type": "number",
      "format": "float",
      "description": "Click rate as a percentage."
    }
  }
}