Skip to main content
GET
/
api
/
overview
Overview
curl --request GET \
  --url https://api.example.com/api/overview
{
  "items": [
    {
      "slug": "service-one",
      "name": "Service One",
      "online": 1250
    }
  ],
  "history": {
    "service-one": [
      { "t": 1703750400000, "v": 1200 }
    ]
  }
}

​
Overview API

Get a comprehensive overview of all services including their current status and 24-hour history data. Ideal for building dashboards.

​
Response

​
items
array
Array of all service objects with current status
​
history
object
Object with service slugs as keys

​
Example Request

curl -X GET "https://www.orcrev.fit/api/overview"

​
Example Response

{
  "items": [
    {
      "slug": "service-one",
      "name": "Service One",
      "online": 1250,
      "status": "online"
    },
    {
      "slug": "service-two",
      "name": "Service Two",
      "online": 850,
      "status": "online"
    }
  ],
  "history": {
    "service-one": [
      { "t": 1703750400000, "v": 1200 },
      { "t": 1703754000000, "v": 1250 }
    ],
    "service-two": [
      { "t": 1703750400000, "v": 800 },
      { "t": 1703754000000, "v": 850 }
    ]
  }
}
This endpoint combines current service status with history data, making it perfect for real-time dashboards with charts.
History data is automatically pruned to keep only the last 24 hours.
{
  "items": [
    {
      "slug": "service-one",
      "name": "Service One",
      "online": 1250
    }
  ],
  "history": {
    "service-one": [
      { "t": 1703750400000, "v": 1200 }
    ]
  }
}