List outage reports for a board | StatusGator Octri Preview

4 parameters

board_idstringrequired

Board public ID

sincestringoptional

Only return reports submitted at or after this ISO 8601 timestamp

pageintegeroptional

Page number for pagination (default: 1)

per_pageintegeroptional

Number of items per page (default: 25, max: 100)

4 status codes

200outage reports found

dataarray<object>optional

paginationobjectoptional

successbooleanoptional

401unauthorized

errorsarray<string>optional

successbooleanoptional

404board not found

errorsarray<string>optional

successbooleanoptional

422invalid since

errorsarray<string>optional

successbooleanoptional

Error handling

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

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.outageReports.list({ boardId: "3fa85f64-5717-4562-b3fc-2c963f66afa6" });

{
  "data": [
    {
      "comment": "API returning 500s",
      "components": [
        {
          "group_name": "Core Services",
          "id": "k2x9m7nPqR",
          "name": "API"
        }
      ],
      "confirmed_at": "2023-10-01T12:00:00Z",
      "created_at": "2023-10-01T12:00:00Z",
      "email": "reporter@example.com",
      "id": "abc123def",
      "location": {
        "city": "Seattle",
        "country": "United States",
        "country_code": "US",
        "region": "Washington"
      },
      "monitor": {
        "icon_url": "https://statusgator.com/favicons/example.png",
        "id": "uVLl2YK1rn",
        "monitor_type": "WebsiteMonitor",
        "name": "My Website Monitor"
      },
      "service": {
        "icon_url": "https://statusgator.com/favicons/aws.png",
        "id": "k2x9m7nPqR",
        "name": "Amazon Web Services",
        "official": true
      },
      "summary": {
        "description": "Service down",
        "id": "uw2YK1rnl0"
      }
    }
  ],
  "pagination": {
    "current_page": 1,
    "next_page": 1,
    "per_page": 1,
    "prev_page": 1,
    "total_count": 42,
    "total_pages": 42
  },
  "success": true
}

Request

Response

Errors