Docs
Email Accounts

Get account overview

Get an aggregated account overview

GET
/v2/workspaces/{workspaceId}/accounts/{id}/overview

Path Parameters

workspaceIdnumber
idnumber

Response Body

curl -X GET "https://lynx-api.trulyinbox.com/v2/workspaces/0/accounts/0/overview"
{
  "data": {
    "account": {
      "id": 0,
      "emailAddress": "string",
      "senderName": "string",
      "provider": "string",
      "authMethod": "string",
      "status": "string",
      "accountState": "string",
      "statusBucket": "string",
      "sendCheckFailed": true,
      "receiveCheckFailed": true,
      "structuredStatus": {},
      "warmupStatus": "string",
      "warmupPausedAt": "2019-08-24T14:15:22Z",
      "warmupPausedReason": "string",
      "throttleReason": "string",
      "cooldownUntil": "2019-08-24T14:15:22Z",
      "warmupMinLimit": 0,
      "warmupMaxLimit": 0,
      "warmupCurrentLimit": 0,
      "warmupRampupDay": 0,
      "warmupStrategy": "string",
      "timezone": "string",
      "poolTier": "string",
      "deliverabilityRate": 0,
      "spfData": {},
      "dkimData": {},
      "dmarcData": {},
      "mxRecordData": {},
      "dnsCheckedAt": "2019-08-24T14:15:22Z",
      "setupScore": 82,
      "inboxPlacementScore": 0,
      "lastVerifiedAt": "2019-08-24T14:15:22Z",
      "pushNotificationsActive": true,
      "createdAt": "2019-08-24T14:15:22Z",
      "source": "string",
      "dwdWorkspaceId": 0,
      "partnerIntegrationId": 0,
      "domainRegisteredAt": "2019-08-24T14:15:22Z",
      "mailboxCreatedAt": "2019-08-24T14:15:22Z",
      "warmupStartDate": "2019-08-24T14:15:22Z",
      "replyRate": 0,
      "warmupPreference": "string",
      "contentIndustry": "string",
      "contentTopics": [
        "string"
      ],
      "contentLanguage": "string",
      "blacklistedAt": "2019-08-24T14:15:22Z",
      "blacklistSource": "string",
      "todaySent": 0,
      "todayReceived": 0,
      "sevenDaySent": 0,
      "sevenDayReceived": 0,
      "tags": [
        {
          "id": 0,
          "name": "string",
          "color": "string"
        }
      ],
      "activeBulkJobId": "string",
      "activeImportId": "string"
    },
    "last14Days": [
      {
        "date": "string",
        "sent": 0,
        "delivered": 0,
        "opened": 0,
        "replied": 0
      }
    ],
    "latestVerificationRun": {
      "id": 0,
      "status": "string",
      "startedAt": "2019-08-24T14:15:22Z",
      "completedAt": "2019-08-24T14:15:22Z",
      "spfResult": "string",
      "dkimResult": "string",
      "dmarcResult": "string",
      "inboxCategoryResult": "string"
    },
    "domainSecurity": {
      "domain": "string",
      "score": 0,
      "band": "green",
      "fields": [
        {
          "key": "spf",
          "label": "string",
          "score": 29,
          "maxScore": 29,
          "indeterminate": true
        }
      ],
      "spfData": {},
      "dmarcData": {},
      "dkimData": {},
      "mxRecordData": {},
      "domainBlacklistData": {},
      "ipBlacklistData": {},
      "ipAddress": {},
      "recordsRefreshedAt": {},
      "blacklistRefreshedAt": {},
      "scoredAt": {},
      "senderName": {}
    }
  },
  "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"
  }
}