Get board uptime report | StatusGator Octri Preview

2 parameters

board_idstringrequired

Public ID of the board

periodstringoptional

Reporting window: 7d, 30d (default), or 90d

4 status codes

200uptime report

dataobjectoptional

successbooleanoptional

401unauthorized

404board not found

422invalid period

Error handling

A 401 is returned: unauthorized. A 404 is returned: board not found. A 422 is returned: invalid period.

import { StatusGatorAPIUnofficialOctriFullPreview } from "statusgator-octri-preview-sdk";

const client = new StatusGatorAPIUnofficialOctriFullPreview({
  baseUrl: "https://statusgator.com/api/v3",
  auth: { bearerAuth: process.env.API_TOKEN! },
});

const result = await client.reports.getBoardUptime({ boardId: "3fa85f64-5717-4562-b3fc-2c963f66afa6" });

{
  "data": {
    "average_uptime_percentage": 99.95,
    "monitors": [
      {
        "monitor_id": "k2x9m7nPqR",
        "name": "API Monitor",
        "uptime_percentage": 99.95
      }
    ],
    "outage_count": 3,
    "period": "30d",
    "total_downtime_minutes": 1.5,
    "total_monitors": 12
  },
  "success": true
}

Request

Response

Errors