v1

latestOpenAPI 3.1.02026-07-2617125852.3 KB

Account

Analytics

Get warmup analytics

Requires one of the following scopes: accounts:read, accounts:all, all:read, all:all

post/api/v2/accounts/warmup-analytics

Request body

emailsstring[] required

List of emails to get warmup analytics for. The emails should be attached to accounts in your workspace.

Example request

{
  "emails": [
    "user@example.com"
  ]
}

Response

Default Response

email_date_dataobject

aggregate_dataobject

Example response

{
  "email_date_data": {
    "example1@example.com": {
      "2023-10-01": {
        "sent": 10,
        "landed_inbox": 8,
        "landed_spam": 2,
        "received": 10
      },
      "2023-10-02": {
        "sent": 5,
        "landed_inbox": 5,
        "received": 5
      }
    },
    "example2@example.com": {
      "2023-10-01": {
        "sent": 7,
        "landed_inbox": 7,
        "received": 7
      }
    }
  },
  "aggregate_data": {
    "example1@example.com": {
      "sent": 15,
      "landed_inbox": 13,
      "landed_spam": 2,
      "received": 15,
      "health_score_label": "87%",
      "health_score": 87
    },
    "example2@example.com": {
      "sent": 7,
      "landed_inbox": 7,
      "health_score_label": "100%",
      "health_score": 100
    }
  }
}