Docs
Deliverability

Get inbox vs spam by provider

Inbox vs spam by recipient provider (Gmail, Outlook, other) for one account

Warmup emails this account sent in the window, split by the recipient's provider: sent, inbox and spam counts plus the inbox rate for each, and totals summed from those rows. Original sends only (replies are excluded). from/to are inclusive dates, at most 90 days apart, with day boundaries in timeZone (default UTC). Requires a plan with the deliverability-score report; other plans get 403.

GET
/v2/workspaces/{workspaceId}/accounts/{id}/analytics/esp

Path Parameters

workspaceIdnumber
idnumber

Query Parameters

fromstring

Start date, inclusive (YYYY-MM-DD)

tostring

End date, inclusive (YYYY-MM-DD)

esps?array<string>

ESPs to include. Defaults to all of gmail, outlook, other.

Value in"gmail" | "outlook" | "other"
timeZone?string

IANA time zone for day boundaries, e.g. Asia/Kolkata

Default"UTC"

Response Body

curl -X GET "https://lynx-api.trulyinbox.com/v2/workspaces/0/accounts/0/analytics/esp?from=string&to=string&esps=gmail&timeZone=UTC"
{
  "data": {
    "accountId": 12,
    "perEsp": [
      {
        "esp": "gmail",
        "sentCount": 0,
        "inboxCount": 0,
        "spamCount": 0,
        "deliverabilityRate": 0
      }
    ],
    "totalSentCount": 1500,
    "totalInboxCount": 1320,
    "totalSpamCount": 180,
    "deliverabilityRate": 88
  },
  "meta": {
    "request_id": "req_2f1c…",
    "timestamp": "2019-08-24T14:15:22Z"
  }
}
{
  "error": {
    "code": "invalid_request",
    "message": "string",
    "details": {},
    "retry_after": 34
  },
  "meta": {
    "request_id": "req_2f1c…",
    "timestamp": "2019-08-24T14:15:22Z"
  }
}
{
  "error": {
    "code": "invalid_request",
    "message": "string",
    "details": {},
    "retry_after": 34
  },
  "meta": {
    "request_id": "req_2f1c…",
    "timestamp": "2019-08-24T14:15:22Z"
  }
}