Retrieve email statistics by country and state/province.

v1.0.0

This endpoint allows you to retrieve your email statistics segmented by country and state/province.

We only store up to 7 days of email activity in our database. By default, 500 items will be returned per request via the Advanced Stats API endpoints.

Advanced Stats provide a more in-depth view of your email statistics and the actions taken by your recipients. You can segment these statistics by geographic location, device type, client type, browser, and mailbox provider. For more information about statistics, please see our .

Input

{
  "type": "object",
  "properties": {
    "aggregated_by": {
      "type": "string",
      "enum": [
        "day",
        "week",
        "month"
      ]
    },
    "country": {
      "type": "string",
      "enum": [
        "US",
        "CA"
      ]
    },
    "end_date": {
      "type": "string"
    },
    "limit": {
      "type": "integer"
    },
    "offset": {
      "type": "integer"
    },
    "on-behalf-of": {
      "type": "string"
    },
    "start_date": {
      "type": "string"
    }
  },
  "required": [
    "start_date"
  ],
  "additionalProperties": false
}

Output

{
  "type": "array",
  "items": {
    "type": "object",
    "properties": {
      "date": {
        "type": "string",
        "description": "The date that the statistics were gathered."
      },
      "stats": {
        "type": "array",
        "description": "The list of statistics.",
        "items": {
          "type": "object",
          "properties": {
            "metrics": {
              "description": "The individual events and their stats.",
              "type": "object"
            },
            "name": {
              "type": "string",
              "description": "The name of the specific segmentation."
            },
            "type": {
              "type": "string",
              "description": "The type of segmentation."
            }
          }
        }
      }
    }
  }
}