/reports/messages/email/statistics

Use this endpoint to view statistics reports for email messages.

Secured By: Authentication Token
Description:

Retrieve aggregate recipient statistics for email messages.

Headers

Name Required Type Description
X-AUTH-TOKEN * string

An authentication token provided to you by GovDelivery.

Query Parameters

Name Required Type Description
start * date

Start date to capture email messages statistics. Must be truncated to the hour and in ISO 8601 datetime format.

Example

reports/messages/email/statistics?start=2017-06-10T15:00:00Z
end * date

End date to capture email messages statistics. Must be truncated to the hour and in ISO 8601 datetime format.

Example

reports/messages/email/statistics?end=2017-06-10T15:00:00Z

Status

Body

Format: application/json

Example
{
  "recipients": {
    "new": 1,
    "sending": 5,
    "inconclusive": 0,
    "blacklisted": 2,
    "canceled": 0,
    "sent": 50,
    "failed": 1
  }
}
Schema
Array of objects that may include:
Name Type Description 
{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "title": "Email Statistics",
  "description": "Email Messages Statistics",
  "type": "object",
  "items": {
    "body": {
      "recipients": {
        "new": {
          "description": "The count of recipients in new status associated with email messages over the time period",
          "type": "integer",
          "example": "1"
        },
        "sending": {
          "description": "The count of recipients in sending status associated with email messages over the time period",
          "type": "integer",
          "example": "1"
        },
        "inconclusive": {
          "description": "The count of recipients in inconclusive status associated with email messages over the time period",
          "type": "integer",
          "example": "1"
        },
        "blacklisted": {
          "description": "The count of recipients in blacklisted status associated with email messages over the time period",
          "type": "integer",
          "example": "1"
        },
        "canceled": {
          "description": "The count of recipients in canceled status associated with email messages over the time period",
          "type": "integer",
          "example": "1"
        },
        "sent": {
          "description": "The count of recipients in sent status associated with email messages over the time period",
          "type": "integer",
          "example": "1"
        },
        "failed": {
          "description": "The count of recipients in failed status associated with email messages over the time period",
          "type": "integer",
          "example": "1"
        }
      }
    }
  }
}

Body

Format: application/json

Example
{
  "error": "Invalid date parameters. start must be in a valid datetime format."
}

Body

Format: application/json

Example
{
  "error": "Invalid authentication token"
}