Statuspage-compatible status summary

Embed
Preview of the card
<a href="https://forumulate.com/reference/forumulate-api-publicstatus-summary"><img src="https://forumulate.com/reference/_api/public/orgs/046a9bc0-d530-43ae-9bae-af7945008cda/spaces/8042f004-e3d9-445f-b7a4-b6c1f86836e6/pages/93b0c35b-92ca-4a76-9505-ad19fe416355/social-card.svg?v=3e7ae33eec8b" alt="Statuspage-compatible status summary" width="600" height="315"></a>
GEThttps://forumulate.com/api/public/orgs/{orgId}/spaces/{spaceId}/status/summary.json

statuspage.io's summary.json shape, derived from the same board a person reads so the two cannot disagree. Components keep OUR state words (degraded, maintenance, unknown) and carry Statuspage's id, description, position, group_id (plus group_name and slug); incidents are the open ones with id, impact, shortlink and incident_updates; scheduled_maintenances lists maintenance not yet over; page has id, time_zone and updated_at. The Statuspage-worded twin is …/status/api/v2/summary.json. uptime is nullable (null means nothing was recorded, which is NOT 0%) and each component carries the window its percentage was measured over, so a poller can tell '100% over ninety days' from '100% over ninety minutes'. outages lists the failing runs our own checks recorded even when no incident was opened. The snake_case keys inside incidents are deliberate Statuspage compatibility, not our envelope drifting.

Parameters
orgIdstringpathrequired
spaceIdstringpathrequired
forumulate-versionstringheader
API version negotiation. Send forumulate-version: 2026-12-01 on every request from a new integration; it is optional only so that integrations written before versioning keep working. Each version includes everything before it:
Code samples
cURL
curl -X GET "https://forumulate.com/api/public/orgs/{orgId}/spaces/{spaceId}/status/summary.json" \
  -H "forumulate-version: <value>"
TypeScript
const res = await fetch('https://forumulate.com/api/public/orgs/{orgId}/spaces/{spaceId}/status/summary.json', {
  method: 'GET',
  headers: {
    'forumulate-version': '<value>',
  },
});
const data = await res.json();
Python
import requests

res = requests.request(
    "GET",
    "https://forumulate.com/api/public/orgs/{orgId}/spaces/{spaceId}/status/summary.json",
    headers={
    "forumulate-version": "<value>",
    },
)
data = res.json()
Go
package main

import (
	"fmt"
	"io"
	"net/http"
)

func main() {
	req, _ := http.NewRequest("GET", "https://forumulate.com/api/public/orgs/{orgId}/spaces/{spaceId}/status/summary.json", nil)
	req.Header.Set("forumulate-version", "<value>")
	res, _ := http.DefaultClient.Do(req)
	defer res.Body.Close()
	body, _ := io.ReadAll(res.Body)
	fmt.Println(string(body))
}
PHP
<?php
$ch = curl_init();
curl_setopt($ch, CURLOPT_URL, 'https://forumulate.com/api/public/orgs/{orgId}/spaces/{spaceId}/status/summary.json');
curl_setopt($ch, CURLOPT_CUSTOMREQUEST, 'GET');
curl_setopt($ch, CURLOPT_RETURNTRANSFER, true);
curl_setopt($ch, CURLOPT_HTTPHEADER, ['forumulate-version: <value>']);
$response = curl_exec($ch);
curl_close($ch);
echo $response;
Ruby
require 'net/http'
require 'uri'

uri = URI('https://forumulate.com/api/public/orgs/{orgId}/spaces/{spaceId}/status/summary.json')
req = Net::HTTP::Get.new(uri)
req['forumulate-version'] = '<value>'
res = Net::HTTP.start(uri.hostname, uri.port, use_ssl: uri.scheme == 'https') do |http|
  http.request(req)
end
puts res.body
Java
import java.net.URI;
import java.net.http.*;
import java.net.http.HttpRequest.BodyPublishers;

HttpClient client = HttpClient.newHttpClient();
HttpRequest request = HttpRequest.newBuilder()
    .uri(URI.create("https://forumulate.com/api/public/orgs/{orgId}/spaces/{spaceId}/status/summary.json"))
    .header("forumulate-version", "<value>")
    .GET()
    .build();
HttpResponse<String> response = client.send(request, HttpResponse.BodyHandlers.ofString());
System.out.println(response.body());
Responses
200 Success.
Example
{
  "components": [
    {
      "description": "string",
      "group": true,
      "group_id": "string",
      "group_name": "string",
      "id": "string",
      "name": "string",
      "only_show_if_degraded": true,
      "page_id": "string",
      "position": 0,
      "showcase": true,
      "slug": "string",
      "start_date": "string",
      "status": "degraded",
      "uptime": 0,
      "window": {
        "daysCovered": 0,
        "firstCheckAt": null,
        "lastCheckAt": null,
        "minSamples": 0,
        "minSpanHours": 0,
        "reportedDays": 0,
        "samples": 0,
        "spanHours": 0,
        "sufficient": true
      }
    }
  ],
  "incidents": [
    {
      "components": [
        {
          "id": null,
          "name": null,
          "status": null
        }
      ],
      "created_at": "string",
      "id": "string",
      "impact": "string",
      "incident_updates": [
        {
          "affected_components": null,
          "body": null,
          "created_at": null,
          "display_at": null,
          "id": null,
          "incident_id": null,
          "status": null,
          "updated_at": null
        }
      ],
      "monitoring_at": "string",
      "name": "string",
      "page_id": "string",
      "resolved_at": "string",
      "scheduled_for": "string",
      "scheduled_until": "string",
      "shortlink": "string",
      "started_at": "string",
      "status": "string",
      "updated_at": "string"
    }
  ],
  "outages": [
    {
      "endedAt": "string",
      "failures": 0,
      "monitorId": "string",
      "monitorName": "string",
      "ongoing": true,
      "startedAt": "string"
    }
  ],
  "page": {
    "id": "string",
    "name": "string",
    "time_zone": "string",
    "updated_at": "string",
    "url": "string"
  },
  "scheduled_maintenances": [
    {
      "components": [
        {
          "id": null,
          "name": null,
          "status": null
        }
      ],
      "created_at": "string",
      "id": "string",
      "impact": "string",
      "incident_updates": [
        {
          "affected_components": null,
          "body": null,
          "created_at": null,
          "display_at": null,
          "id": null,
          "incident_id": null,
          "status": null,
          "updated_at": null
        }
      ],
      "monitoring_at": "string",
      "name": "string",
      "page_id": "string",
      "resolved_at": "string",
      "scheduled_for": "string",
      "scheduled_until": "string",
      "shortlink": "string",
      "started_at": "string",
      "status": "string",
      "updated_at": "string"
    }
  ],
  "status": {
    "description": "string",
    "indicator": "string",
    "overall": "degraded"
  },
  "window": {
    "daysCovered": 0,
    "firstCheckAt": "string",
    "lastCheckAt": "string",
    "minSamples": 0,
    "minSpanHours": 0,
    "reportedDays": 0,
    "samples": 0,
    "spanHours": 0,
    "sufficient": true
  }
}
Schema
componentsSummaryComponent[]required
Show child parameters
descriptionstringrequired
groupbooleanrequired
group_idstringrequired
group_namestringrequired
idstringrequired
namestringrequired
only_show_if_degradedbooleanrequired
page_idstringrequired
positionnumberrequired
showcasebooleanrequired
slugstringrequired
start_datestringrequired
statusstringrequired
degraded | maintenance | major_outage | operational | partial_outage | unknown
uptimenumberrequired
windowobjectrequired
Show child parameters
daysCoverednumberrequired
firstCheckAtstringrequired
lastCheckAtstringrequired
minSamplesnumberrequired
minSpanHoursnumberrequired
reportedDaysnumberrequired
samplesnumberrequired
spanHoursnumberrequired
sufficientbooleanrequired
incidentsV2Incident[]required
Show child parameters
componentsV2AffectedComponent[]required
Show child parameters
idstringrequired
namestringrequired
statusstringrequired
created_atstringrequired
idstringrequired
impactstringrequired
incident_updatesV2IncidentUpdate[]required
Show child parameters
affected_componentsV2AffectedComponent[]required
bodystringrequired
created_atstringrequired
display_atstringrequired
idstringrequired
incident_idstringrequired
statusstringrequired
updated_atstringrequired
monitoring_atstringrequired
namestringrequired
page_idstringrequired
resolved_atstringrequired
scheduled_forstring
scheduled_untilstring
shortlinkstringrequired
started_atstringrequired
statusstringrequired
updated_atstringrequired
outagesOutageWindow[]required
Show child parameters
endedAtstringrequired
failuresnumberrequired
monitorIdstringrequired
monitorNamestringrequired
ongoingbooleanrequired
startedAtstringrequired
pageobjectrequired
Show child parameters
idstringrequired
namestringrequired
time_zonestringrequired
updated_atstringrequired
urlstringrequired
scheduled_maintenancesV2Incident[]required
Show child parameters
componentsV2AffectedComponent[]required
Show child parameters
idstringrequired
namestringrequired
statusstringrequired
created_atstringrequired
idstringrequired
impactstringrequired
incident_updatesV2IncidentUpdate[]required
Show child parameters
affected_componentsV2AffectedComponent[]required
bodystringrequired
created_atstringrequired
display_atstringrequired
idstringrequired
incident_idstringrequired
statusstringrequired
updated_atstringrequired
monitoring_atstringrequired
namestringrequired
page_idstringrequired
resolved_atstringrequired
scheduled_forstring
scheduled_untilstring
shortlinkstringrequired
started_atstringrequired
statusstringrequired
updated_atstringrequired
statusobjectrequired
Show child parameters
descriptionstringrequired
indicatorstringrequired
overallstringrequired
degraded | down | maintenance | unknown | up
windowobjectrequired
Show child parameters
daysCoverednumberrequired
firstCheckAtstringrequired
lastCheckAtstringrequired
minSamplesnumberrequired
minSpanHoursnumberrequired
reportedDaysnumberrequired
samplesnumberrequired
spanHoursnumberrequired
sufficientbooleanrequired
400 The request could not be understood — a malformed header, path or query value (request.malformed). A value that was understood but is not acceptable is a 422 validation.failed.
Example
{
  "error": {
    "code": "string",
    "message": "string",
    "details": {},
    "docs": "string",
    "reason": "string",
    "slugs": [
      "string"
    ],
    "conflict": {
      "etag": "string",
      "ops": [
        null
      ]
    }
  },
  "requestId": "string"
}
Schema
errorobjectrequired
Show child parameters
codestringrequired
Stable, machine-readable error code, e.g. rbac.forbidden.
messagestringrequired
Human-readable explanation.
detailsobject
Field-level validation problems, keyed by field path (422 only).
docsstring
Where the vocabulary or format this error is about is published — an absolute URL, or an API route such as GET /space-types/{type}/presets. Present on errors over a controlled list, so the answer to "what am I allowed to send?" is in the error itself.
reasonstring
Why a credential was refused, as one stable word, where one status has several causes — e.g. an external_jwt redeem answers iat_too_old, iat_in_future, bad_signature, bad_issuer, bad_audience, expired and more. Branch on this, not on message.
slugsstring[]
The exact slugs that collided, on a slug-conflict 409 — space.slug_taken, page.slug_taken, collection.slug_taken, site.slug_taken or badge.slug_taken.
conflictobject
On a 409 from a content entry field write (PATCH …/entries/{entryId}/fields) whose If-Match was stale.
Show child parameters
etagstringrequired
The entry's current fields etag.
opsarrayrequired
The field operations since your If-Match that touch a path your own operations touch. Empty: none did — retry the batch unchanged under etag. null: the history no longer reaches your tag — re-read the entry first.
requestIdstring
The id of this request — the same value as the x-request-id and x-forumulate-request-id response headers. Quote it in a bug report: it is the only thing that finds your exact request in our logs. It is in the body because that is the part that survives — an SDK that throws the parsed body, a serverless log that keeps the body and drops the headers, a ticket with the JSON pasted in.
404 No such thing — one of the ids in the path does not resolve, or resolves to something this caller may not see (*.not_found).
Example
{
  "error": {
    "code": "string",
    "message": "string",
    "details": {},
    "docs": "string",
    "reason": "string",
    "slugs": [
      "string"
    ],
    "conflict": {
      "etag": "string",
      "ops": [
        null
      ]
    }
  },
  "requestId": "string"
}
Schema
errorobjectrequired
Show child parameters
codestringrequired
Stable, machine-readable error code, e.g. rbac.forbidden.
messagestringrequired
Human-readable explanation.
detailsobject
Field-level validation problems, keyed by field path (422 only).
docsstring
Where the vocabulary or format this error is about is published — an absolute URL, or an API route such as GET /space-types/{type}/presets. Present on errors over a controlled list, so the answer to "what am I allowed to send?" is in the error itself.
reasonstring
Why a credential was refused, as one stable word, where one status has several causes — e.g. an external_jwt redeem answers iat_too_old, iat_in_future, bad_signature, bad_issuer, bad_audience, expired and more. Branch on this, not on message.
slugsstring[]
The exact slugs that collided, on a slug-conflict 409 — space.slug_taken, page.slug_taken, collection.slug_taken, site.slug_taken or badge.slug_taken.
conflictobject
On a 409 from a content entry field write (PATCH …/entries/{entryId}/fields) whose If-Match was stale.
Show child parameters
etagstringrequired
The entry's current fields etag.
opsarrayrequired
The field operations since your If-Match that touch a path your own operations touch. Empty: none did — retry the batch unchanged under etag. null: the history no longer reaches your tag — re-read the entry first.
requestIdstring
The id of this request — the same value as the x-request-id and x-forumulate-request-id response headers. Quote it in a bug report: it is the only thing that finds your exact request in our logs. It is in the body because that is the part that survives — an SDK that throws the parsed body, a serverless log that keeps the body and drops the headers, a ticket with the JSON pasted in.
429 Rate limited — see the RateLimit-* headers.
Example
{
  "error": {
    "code": "string",
    "message": "string",
    "details": {},
    "docs": "string",
    "reason": "string",
    "slugs": [
      "string"
    ],
    "conflict": {
      "etag": "string",
      "ops": [
        null
      ]
    }
  },
  "requestId": "string"
}
Schema
errorobjectrequired
Show child parameters
codestringrequired
Stable, machine-readable error code, e.g. rbac.forbidden.
messagestringrequired
Human-readable explanation.
detailsobject
Field-level validation problems, keyed by field path (422 only).
docsstring
Where the vocabulary or format this error is about is published — an absolute URL, or an API route such as GET /space-types/{type}/presets. Present on errors over a controlled list, so the answer to "what am I allowed to send?" is in the error itself.
reasonstring
Why a credential was refused, as one stable word, where one status has several causes — e.g. an external_jwt redeem answers iat_too_old, iat_in_future, bad_signature, bad_issuer, bad_audience, expired and more. Branch on this, not on message.
slugsstring[]
The exact slugs that collided, on a slug-conflict 409 — space.slug_taken, page.slug_taken, collection.slug_taken, site.slug_taken or badge.slug_taken.
conflictobject
On a 409 from a content entry field write (PATCH …/entries/{entryId}/fields) whose If-Match was stale.
Show child parameters
etagstringrequired
The entry's current fields etag.
opsarrayrequired
The field operations since your If-Match that touch a path your own operations touch. Empty: none did — retry the batch unchanged under etag. null: the history no longer reaches your tag — re-read the entry first.
requestIdstring
The id of this request — the same value as the x-request-id and x-forumulate-request-id response headers. Quote it in a bug report: it is the only thing that finds your exact request in our logs. It is in the body because that is the part that survives — an SDK that throws the parsed body, a serverless log that keeps the body and drops the headers, a ticket with the JSON pasted in.
default Error — the stable { error: { code, message } } envelope.
Example
{
  "error": {
    "code": "string",
    "message": "string",
    "details": {},
    "docs": "string",
    "reason": "string",
    "slugs": [
      "string"
    ],
    "conflict": {
      "etag": "string",
      "ops": [
        null
      ]
    }
  },
  "requestId": "string"
}
Schema
errorobjectrequired
Show child parameters
codestringrequired
Stable, machine-readable error code, e.g. rbac.forbidden.
messagestringrequired
Human-readable explanation.
detailsobject
Field-level validation problems, keyed by field path (422 only).
docsstring
Where the vocabulary or format this error is about is published — an absolute URL, or an API route such as GET /space-types/{type}/presets. Present on errors over a controlled list, so the answer to "what am I allowed to send?" is in the error itself.
reasonstring
Why a credential was refused, as one stable word, where one status has several causes — e.g. an external_jwt redeem answers iat_too_old, iat_in_future, bad_signature, bad_issuer, bad_audience, expired and more. Branch on this, not on message.
slugsstring[]
The exact slugs that collided, on a slug-conflict 409 — space.slug_taken, page.slug_taken, collection.slug_taken, site.slug_taken or badge.slug_taken.
conflictobject
On a 409 from a content entry field write (PATCH …/entries/{entryId}/fields) whose If-Match was stale.
Show child parameters
etagstringrequired
The entry's current fields etag.
opsarrayrequired
The field operations since your If-Match that touch a path your own operations touch. Empty: none did — retry the batch unchanged under etag. null: the history no longer reaches your tag — re-read the entry first.
requestIdstring
The id of this request — the same value as the x-request-id and x-forumulate-request-id response headers. Quote it in a bug report: it is the only thing that finds your exact request in our logs. It is in the body because that is the part that survives — an SDK that throws the parsed body, a serverless log that keeps the body and drops the headers, a ticket with the JSON pasted in.
The Forumulate teamUpdated