Skip to Content
Uptimeify Docs
Websites

Get Website Details

Returns the website detail page data in one call (mega endpoint). This includes monitoring stats, alert history, incident history, monitoring chart data, and maintenance windows.

GET /api/websites/:websitePublicId/details

Example (cURL)

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 Parameters

  • 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)

Response

{
  "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 Fields

  • 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.
  • uptimeStatsMeta.day|month|year: downtimeMinutes and incidents for the period, plus checksTotal and checksFailed. For day these count check cycles (one per minute, failed when as many locations as the alert threshold failed together) over the last 24 hours. For month (the last 30 days) and year (since 1 January, UTC) they count single location checks of every check type, read from the 15-minute and daily aggregates, because the per-minute cycles are only kept for 7 days. Do not compare the day figure with the month or year figure directly.
  • uptimeStats.dayAvgResponse|weekAvgResponse|monthAvgResponse|yearAvgResponse and the matching …AvgPageSize fields: averages over the same windows as the uptime, the last 24 hours, 7 days and 30 days and the year since 1 January (UTC). monthAvgPageSize and yearAvgPageSize are null, because page size is kept for 7 days only.

Common errors

  • 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

Data retention

The series is read from the finest aggregate that still covers the requested range: minute data for the last 7 days, 15-minute buckets up to 30 days back and daily buckets beyond that. In the coarser buckets timingDns, timingTcp, timingTls, timingTtfb and timingTransfer are reported as 0 (not measured), and successRate is the share of successful location checks rather than the per-minute quorum.

On this page