Docs
Reports

Get accounts leaderboard

Top accounts leaderboard (≤30-day window)

GET
/v2/workspaces/{workspaceId}/analytics/leaderboard

Path Parameters

workspaceIdnumber

Query Parameters

days?number
Default30
Range1 <= value <= 30
limit?number
Default10
Range1 <= value <= 50

Response Body

curl -X GET "https://lynx-api.trulyinbox.com/v2/workspaces/0/analytics/leaderboard?days=30&limit=10"
{
  "data": {
    "entries": [
      {
        "accountId": 0,
        "emailAddress": "string",
        "poolTier": "string",
        "warmupStatus": "string",
        "sent": 0,
        "received": 0,
        "bounced": 0,
        "spamDetected": 0,
        "deliverabilityRate": 0
      }
    ]
  },
  "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"
  }
}

Get warmup trendsGET

Workspace warmup trends over a date range

Bulk account reportPOST

Per-account warmup stats for up to 50 accounts Batched form of the single-account stats endpoint. POST rather than GET because the id list can exceed a practical query-string length. Partial-succeed: an account that cannot be read is reported in `failed` while the rest still return.