Get Website Details

GET /api/websites/:websitePublicId/details

Example (cURL)Copy Anchor Link

BASE_URL="https://uptimeify.io"
TOKEN="<your-api-token>"

curl -X GET "$BASE_URL/api/websites/9a3d4d4d-7a4b-4f37-a9df-2a6f6d9d7a10/details?range=day" \
  -H "Authorization: Bearer $TOKEN" \
  -H "Accept: application/json"

Query ParametersCopy Anchor Link

• range (optional): day | week | month | year (default: day)
• date (optional): reference date for calendar views
• startDate / endDate (optional): custom date window for zoomed views
• granularity (optional): e.g. minute for non-aggregated data (when supported)

ResponseCopy Anchor Link

{
  "website": {
    "id": 101,
    "name": "Main Marketing Site",
    "url": "https://deinkunde.com",
    "status": "active",
    "monitoringType": "combined",
    "customerId": 1
  },
  "uptimeStats": {
    "day": "100.00",
    "month": "99.95",
    "year": "99.90",
    "dayAvgResponse": 125,
    "monthAvgResponse": 118,
    "yearAvgResponse": 120,
    "blockedRatio": { "day": 0, "week": 0, "month": 0.02, "year": 0 }
  },
  "monitoringData": {
    "responseTimeData": [],
    "statusData": [],
    "uptimePercentage": "99.95",
    "checkSuccessRatePercentage": "99.80",
    "totalChecks": 100,
    "successfulChecks": 99
  },
  "incidents": {
    "history": [],
    "total": 0,
    "ongoing": 0,
    "totalDowntime": "0m"
  },
  "alerts": {
    "history": [],
    "total": 0,
    "notificationContext": null
  },
  "maintenance": {
    "inMaintenance": false,
    "activeWindows": [],
    "allWindows": []
  }
}

Response FieldsCopy Anchor Link

• uptimeStats.day|week|month|year: uptime percentage as a string with two decimals, or null when nothing was measurable in that period. The same holds for monitoringData.uptimePercentage.
• uptimeStats.blockedRatio: per period, the share we could not measure, between 0 and 1, null for an empty period. A site's bot protection can answer our check with a challenge instead of the page; that time leaves the uptime calculation, so it counts neither as up nor as down.

Common errorsCopy Anchor Link

• 400 Invalid website public ID (UUID) when :websitePublicId is invalid
• 401 Unauthorized when you are not logged in
• 404 Not Found when the website does not exist or belongs to another customer or organization (the two cases are indistinguishable on purpose)
• 500 Failed to fetch website details on server errors