Docs
Reports

Get workspace overview

Workspace warmup overview (≤30-day window)

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

Path Parameters

workspaceIdnumber

Query Parameters

days?number
Default30
Range1 <= value <= 30

Response Body

curl -X GET "https://lynx-api.trulyinbox.com/v2/workspaces/0/analytics/overview?days=30"
{
  "data": {
    "totalAccounts": 0,
    "activeAccounts": 0,
    "totalSent": 0,
    "totalReceived": 0,
    "totalBounced": 0,
    "totalSpamDetected": 0,
    "averageDeliverabilityRate": 0,
    "dailyBreakdown": [
      {
        "date": "string",
        "sent": 0,
        "received": 0,
        "bounced": 0,
        "spamDetected": 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 deliverability score for an accountGET

Deliverability for a single account (rolling 30-day window) The same row `analytics/deliverability` returns for this account, without scanning the whole workspace. An account with no sends in the window reports zeros rather than 404ing. The window is fixed at 30 days and is not caller-configurable, so the number matches the workspace-level response.

Get warmup trendsGET

Workspace warmup trends over a date range