GET/api/summary

Retrieve status summary

A compact roll-up of the same data: one overall status, its label in Portuguese, Spanish and English, and how many incidents are open. Use it for a status badge or a health check when you do not need the full snapshot. Maintenance windows are not counted as open incidents. Cached for 30s.

Responses

200Current overall status.

object

statusstring

Worst status across connectors, infrastructure and open incidents: op operational, dg degraded, pt partial outage, mj major outage, mn maintenance. unknown means the status data itself is unavailable (the status backend is down and no recent snapshot is cached); render it as a neutral state, never as operational.

opdgptmjmnunknown

labelsobject

Ready-to-render label for the status, keyed by locale.

ptstring

esstring

enstring

openIncidentsinteger

Number of open incidents (maintenance windows excluded).

updatedAtstring (date-time)

Example response

json

{
  "status": "op",
  "labels": {
    "pt": "string",
    "es": "string",
    "en": "string"
  },
  "openIncidents": 0,
  "updatedAt": "2024-01-01T00:00:00Z"
}

curl -X GET \
  'https://status.pluggy.ai/api/summary' \
  -H 'Content-Type: application/json'

Sample response

{
  "status": "op",
  "labels": {
    "pt": "string",
    "es": "string",
    "en": "string"
  },
  "openIncidents": 0,
  "updatedAt": "2024-01-01T00:00:00Z"
}