---
title: "Get Website Details"
method: GET
path: "/api/websites/{id}/details"
tags: ["Websites"]
---

# Get Website Details

`GET /api/websites/{id}/details`

## Request

- Base URL: `https://uptimeify.io`
- URL: `https://uptimeify.io/api/websites/{id}/details`
- Auth: HTTP bearer

GET /api/websites/:websitePublicId/details

## Path parameters

- `id` string, required

## Query parameters

- `Response` string
- `range` 'day' | 'week' | 'month' | 'year'
- `date` union
  - string, date
  - string, date-time
- `tz` integer
- `startDate` union
  - string, date
  - string, date-time
- `endDate` union
  - string, date
  - string, date-time
- `granularity` 'minute'

## Response `200`

OK

- object
  - `websiteId` integer, required
  - `website` object, nullable, required
    - `id` integer, required
    - `publicId` string, uuid, required
    - `customerId` integer, required
    - `name` string, required
    - `url` string, required: heartbeat://<token> for heartbeat monitors, playwright://... for scripted ones.
    - `monitoringType` 'combined' | 'http_status' | 'ssl_check' | 'playwright' | 'heartbeat' | 'dns', required
    - `dnsConfig` object, required
    - `checkInterval` integer, required: Minutes.
    - `timeoutSeconds` integer, required
    - `expectedStatusCodes` string, nullable, required
    - `searchTerm` string, nullable, required
    - `playwrightDevice` string, nullable, required
    - `playwrightViewportWidth` integer, nullable, required
    - `playwrightViewportHeight` integer, nullable, required
    - `playwrightRetries` integer, required
    - `playwrightTimeoutMs` integer, required
    - `allowedCheckCountryCodes` string[], nullable, required: ISO country codes of the allowed check locations; null = all.
    - `customFields` object, nullable, required
    - `authMode` 'none' | 'authorization_header' | 'basic', required
    - `basicAuthUsername` string, nullable, required
    - `httpMethod` 'GET' | 'QUERY' | 'POST' | 'PUT' | 'PATCH' | 'DELETE' | 'HEAD' | 'OPTIONS', nullable, required
    - `followRedirects` boolean, nullable, required
    - `cookieHandling` 'none' | 'jar', nullable, required
    - `connectHost` string, nullable, required
    - `connectPort` integer, nullable, required
    - `connectTlsInsecure` boolean, required
    - `mtlsEnabled` boolean, nullable, required
    - `checkSslEnabled` boolean, nullable, required
    - `checkHttpsRedirectEnabled` boolean, nullable, required
    - `checkStatusEnabled` boolean, nullable, required
    - `checkSizeEnabled` boolean, nullable, required
    - `checkResponseTimeEnabled` boolean, nullable, required
    - `checkKeywordEnabled` boolean, nullable, required
    - `checkDomainExpiryEnabled` boolean, nullable, required
    - `checkExpectedResponseEnabled` boolean, nullable, required
    - `expectedResponseMatchType` 'contains' | 'equals' | 'json_path_equals', nullable, required
    - `expectedResponseValue` string, nullable, required
    - `expectedResponseJsonPath` string, nullable, required
    - `sslNoticeDays` integer, nullable, required
    - `sslErrorDays` integer, nullable, required
    - `domainExpiryNoticeDays` integer, nullable, required
    - `domainExpiryErrorDays` integer, nullable, required
    - `minPageSize` integer, nullable, required
    - `maxPageSize` integer, nullable, required
    - `heartbeatToken` string, nullable, required: Heartbeat monitors: the token of the ping URL.
    - `heartbeatGracePeriodMinutes` integer, nullable, required
    - `status` 'active' | 'inactive' | 'maintenance', required
    - `escalationDisabled` boolean, required
    - `escalationDisabledReason` string, nullable, required
    - `escalationDisabledAt` string, date-time, nullable, required
    - `managementType` 'managed' | 'self_service', required
    - `flappingSince` string, date-time, nullable, required
    - `notificationPhoneNumber` string, nullable, required
    - `notificationEmail` string, nullable, required
    - `lastCheckedAt` string, date-time, nullable, required
    - `lastHeartbeatAt` string, date-time, nullable, required
    - `createdAt` string, date-time, required
    - `updatedAt` string, date-time, required
    - `playwrightScript` string, nullable, required
    - `hasCustomHeaders` boolean, required
    - `hasRequestBody` boolean, required
  - `unmeasuredSince` string, date-time, nullable, required: Set while the monitor cannot be measured right now.
  - `latestCheck` object, nullable, required
    - `id` string, required
    - `websiteId` integer, required
    - `locationId` integer, required
    - `checkType` string, required
    - `status` string, required: success, failure, warning or timeout.
    - `responseTimeMs` number, nullable, required
    - `statusCode` integer, nullable, required
    - `sslValid` boolean, nullable, required
    - `sslExpiresAt` string, date-time, nullable, required
    - `contentFound` boolean, nullable, required
    - `contentSize` integer, nullable, required
    - `httpsRedirect` boolean, nullable, required
    - `errorMessage` string, nullable, required
    - `warningMessage` string, nullable, required
    - `timingDns` number, nullable, required
    - `timingTcp` number, nullable, required
    - `timingTls` number, nullable, required
    - `timingTtfb` number, nullable, required
    - `timingTransfer` number, nullable, required
    - `checkedAt` string, date-time, required
    - `createdAt` string, date-time, required
    - `resolution` string, required: raw, or the aggregate tier the row came from.
  - `uptimeStats` object, required: Uptime over 24h, 7d, 30d and the calendar year; averages in ms and bytes (0 without data).
    - `day` string, required: Percent with two decimals, e.g. "99.95".
    - `week` string, required: Percent with two decimals, e.g. "99.95".
    - `month` string, required: Percent with two decimals, e.g. "99.95".
    - `year` string, required: Percent with two decimals, e.g. "99.95".
    - `dayAvgResponse` number, required
    - `weekAvgResponse` number, required
    - `monthAvgResponse` number, required
    - `yearAvgResponse` number, required
    - `dayAvgPageSize` number, required
    - `weekAvgPageSize` number, required
    - `monthAvgPageSize` number, required
    - `yearAvgPageSize` number, required
    - `blockedRatio` object, required
      - `day` number, required: Share of the window in which the monitor could not be measured.
      - `week` number, required: Share of the window in which the monitor could not be measured.
      - `month` number, required: Share of the window in which the monitor could not be measured.
      - `year` number, required: Share of the window in which the monitor could not be measured.
  - `uptimeStatsMeta` object, required
    - `day` object, required
      - `window` string, required: 24h, 30d or YTD.
      - `downtimeMinutes` integer, required
      - `incidents` integer, required
      - `checksTotal` integer, required
      - `checksFailed` integer, required
    - `month` object, required
      - `window` string, required: 24h, 30d or YTD.
      - `downtimeMinutes` integer, required
      - `incidents` integer, required
      - `checksTotal` integer, required
      - `checksFailed` integer, required
    - `year` object, required
      - `window` string, required: 24h, 30d or YTD.
      - `downtimeMinutes` integer, required
      - `incidents` integer, required
      - `checksTotal` integer, required
      - `checksFailed` integer, required
  - `monitoringData` object, required
    - `responseTimeData` object[], required: Chart points of the requested range.
      - `timestamp` string, date-time, required
      - `responseTime` number, required
      - `status` 'success' | 'error', required
      - `success` boolean, required
      - `timingDns` number, required
      - `timingTcp` number, required
      - `timingTls` number, required
      - `timingTtfb` number, required
      - `timingTransfer` number, required
      - `pageSize` number, required
    - `statusData` object[], required: Status bar of the last 90 days, one entry per day.
      - `date` string, required
      - `status` string, required
    - `uptimePercentage` string, required: Percent with two decimals, e.g. "99.95".
    - `checkSuccessRatePercentage` string, required: Percent with two decimals, e.g. "99.95".
    - `totalChecks` integer, required
    - `successfulChecks` integer, required
  - `heartbeatData` object[], required: Heartbeat monitors: pings per bucket.
    - `timestamp` string, date-time, required
    - `successCount` integer, required
    - `failedCount` integer, required
  - `heartbeatCheckIntervalMinutes` integer, required
  - `playwrightData` object[], required: Scripted monitors: runs per bucket.
    - `timestamp` string, date-time, required
    - `successCount` integer, required
    - `failedCount` integer, required
  - `playwrightCheckIntervalMinutes` integer, required
  - `incidents` object, required
    - `history` object[], required: Latest 50.
      - `id` integer, required
      - `type` string, required
      - `status` string, required
      - `startedAt` string, date-time, required
      - `endedAt` string, date-time, nullable, required
      - `duration` string, required
      - `durationMs` integer, required
      - `details` string, required
      - `isOngoing` boolean, required
    - `total` integer, required
    - `ongoing` integer, required
    - `totalDowntime` string, required
  - `alerts` object, required
    - `history` object[], required: Latest 100.
      - `id` integer, required
      - `incidentId` integer, nullable, required
      - `type` string, required
      - `status` string, required
      - `channelType` string, nullable, required
      - `channelName` string, nullable, required
      - `channelConfig` unknown, required
      - `responseCode` integer, nullable, required
      - `deliveryDetails` unknown, required
      - `sentAt` string, date-time, required
      - `errorMessage` string, nullable, required
    - `total` integer, required
    - `notificationContext` object, nullable, required: null for customer logins.
      - `customerEmail` string, nullable, required
      - `orgDefaultEmail` string, nullable, required
      - `orgDefaultPhoneNumber` string, nullable, required
      - `notificationTargets` object, nullable, required: Who receives each channel type: customer or organization.
  - `maintenance` object, required
    - `inMaintenance` boolean, required
    - `allWindows` object[], required: Maintenance windows that cover this website.
      - `id` integer, required
      - `publicId` string, uuid, required
      - `websiteId` integer, nullable, required
      - `customerIpId` integer, nullable, required
      - `customerId` integer, nullable, required
      - `organizationId` integer, nullable, required
      - `name` string, required
      - `description` string, nullable, required
      - `startTime` string, date-time, required
      - `endTime` string, date-time, required
      - `isRecurring` boolean, required
      - `recurrencePattern` unknown, required
      - `isActive` boolean, required
      - `timezone` string, nullable, required
      - `createdBy` string, nullable, required
      - `createdAt` string, date-time, required
      - `updatedAt` string, date-time, required

## Other responses

- `400`: Invalid or missing parameters.
- `401`: Missing, invalid or expired API token.
- `404`: No such resource, or not visible to this token.
- `500`: Unexpected server error.

---

[API](https://skmtc.dev/uptimeify/apis/uptimeify-rest-api.md) · [All operations](https://skmtc.dev/uptimeify/apis/uptimeify-rest-api/llms.txt) · [OpenAPI document](https://skmtc.dev/uptimeify/apis/uptimeify-rest-api/revisions/2129a771ee7e?raw)