Skip to main content
POST
/
api
/
v2
/
accounts
/
warmup-analytics
Get warmup analytics
curl --request POST \
  --url https://api.instantly.ai/api/v2/accounts/warmup-analytics \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "emails": [
    "user@example.com"
  ]
}
'
{
  "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
    }
  }
}

Authorizations

Authorization
string
header
required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Body

application/json
emails
string[]
required

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

Required array length: 1 - 100 elements

Response

Default Response

email_date_data
object
aggregate_data
object