---
title: "Get IMAP/POP Monitor Details"
method: GET
path: "/api/imap-pop-monitors/{id}/details"
tags: ["Imap Pop Monitors"]
---

# Get IMAP/POP Monitor Details

`GET /api/imap-pop-monitors/{id}/details`

## Request

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

GET /api/imap-pop-monitors/:imapPopMonitorPublicId/details

## Path parameters

- `id` string, required

## Query parameters

- `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` 'raw' | 'aggregated'

## Response `200`

OK

- object
  - `imapPopMonitorId` integer, required
  - `monitor` object, nullable, required
    - `id` integer, required
    - `allowedCheckCountryCodes` string[], nullable, required: ISO country codes of the allowed check locations; null = all.
    - `publicId` string, uuid, required
    - `organizationId` integer, required
    - `customerId` integer, required
    - `name` string, required
    - `hostname` string, required
    - `checkInterval` integer, required: Minutes.
    - `timeoutSeconds` integer, required
    - `status` 'active' | 'maintenance' | 'disabled', required
    - `managementType` 'managed' | 'self_service', required
    - `notificationPhoneNumber` string, nullable, required
    - `notificationEmail` string, nullable, required
    - `lastCheckedAt` string, date-time, nullable, required
    - `createdAt` string, date-time, required
    - `updatedAt` string, date-time, required
    - `port` integer, required
    - `config` object, required: Protocol settings. Secrets (password, privateKey, passphrase, auth.pass) are always null.
    - `checkMode` 'protocol' | 'tcp', required: tcp only checks that the port accepts connections.
    - `imapPopConfig` object, required: Protocol settings. Secrets (password, privateKey, passphrase, auth.pass) are always null.
    - `hasPassword` boolean, required
  - `latestCheck` object, nullable, required: Newest check within the raw retention window.
    - `id` string, required
    - `imapPopMonitorId` integer, required
    - `locationId` integer, required
    - `status` string, required: success, failure or timeout.
    - `timingTotal` number, nullable, required
    - `errorMessage` string, nullable, required
    - `diagnostics` unknown, required
    - `checkedAt` string, date-time, required
    - `createdAt` string, date-time, required
  - `uptimeStats` object, required: Uptime as percent strings with two decimals; average response times in ms (0 without data).
    - `day` string, required
    - `month` string, required
    - `year` string, required
    - `dayAvgResponse` number, required
    - `weekAvgResponse` number, required
    - `monthAvgResponse` number, required
    - `yearAvgResponse` number, required
  - `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
    - `statusData` object[], required: Status bar, one entry per day.
      - `date` string, required
      - `status` string, required
    - `uptimePercentage` string, required
    - `checkSuccessRatePercentage` string, required
    - `totalChecks` integer, required
    - `successfulChecks` 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
      - `sentAt` string, date-time, required
      - `errorMessage` string, nullable, required
    - `total` integer, required
    - `notificationContext` object, required
      - `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 target this monitor.
      - `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)