---
title: "Get platform status"
method: GET
path: "/v1/status"
tags: ["status"]
---

# Get platform status

`GET /v1/status`

## Request

- Base URL: `https://api.brixsignage.com`
- URL: `https://api.brixsignage.com/v1/status`
- Auth: none required

Get the current platform status, including overall state, 30-day latency attainment, open and recent published incidents, and a 90-day history strip. This endpoint requires no authentication. If the underlying status data is more than three hours old, the state is reported as `unknown` rather than `operational`. Pass `format=text` for a plain-text response.

**Notes.**
- Answers 200 during an outage too: the state is in the body.
- With `format=text` the body is `text/plain`.

## Query parameters

- `format` 'text'

## Response `200`

Success.

- object
  - `data` object, required
    - `state` 'operational' | 'degraded' | 'outage' | 'unknown', required
    - `computedAt` string, nullable, required: ISO-8601 timestamp (UTC).
    - `stale` boolean, required: True when the measurement is more than three hours old (the state is then `unknown`).
    - `latency` object, nullable, required
      - `windowDays` integer, required
      - `targetMs` number, required
      - `targetShare` number, required: The target share of requests under `targetMs`, 0–1.
      - `share` number, nullable, required: The measured share, 0–1; null when not measured.
      - `met` boolean, nullable, required
    - `incidents` StatusIncident[], required: Open incidents.
      - `id` string, required
      - `title` string, required
      - `status` 'investigating' | 'identified' | 'monitoring' | 'resolved', required
      - `impact` 'degraded' | 'outage' | 'none', required
      - `startedAt` string, required: ISO-8601 timestamp (UTC).
      - `resolvedAt` string, nullable, required: ISO-8601 timestamp (UTC).
      - `updates` object[], required: Oldest first.
        - `at` string, required: ISO-8601 timestamp (UTC).
        - `status` 'investigating' | 'identified' | 'monitoring' | 'resolved', required
        - `message` string, required
      - `screensPlaying` boolean, nullable, required: Whether screens kept playing during the incident; null when not stated.
    - `recent` StatusIncident[], required: Recently resolved incidents.
      - `id` string, required
      - `title` string, required
      - `status` 'investigating' | 'identified' | 'monitoring' | 'resolved', required
      - `impact` 'degraded' | 'outage' | 'none', required
      - `startedAt` string, required: ISO-8601 timestamp (UTC).
      - `resolvedAt` string, nullable, required: ISO-8601 timestamp (UTC).
      - `updates` object[], required: Oldest first.
        - `at` string, required: ISO-8601 timestamp (UTC).
        - `status` 'investigating' | 'identified' | 'monitoring' | 'resolved', required
        - `message` string, required
      - `screensPlaying` boolean, nullable, required: Whether screens kept playing during the incident; null when not stated.
    - `days` object[], required: One entry per day, for the last 90 days.
      - `date` string, required: `YYYY-MM-DD`.
      - `state` 'operational' | 'degraded' | 'outage', required

## Other responses

- `401`: Missing, expired or revoked bearer token.
- `5XX`: Server error. The body carries a `requestId` to quote to support.

---

[API](https://skmtc.dev/brixsignage/apis/brix-api.md) · [All operations](https://skmtc.dev/brixsignage/apis/brix-api/llms.txt) · [OpenAPI document](https://skmtc.dev/brixsignage/apis/brix-api/revisions/02fd3665dc7d?raw)
