---
title: "Diagnose a screen issue"
method: GET
path: "/v1/screens/{id}/diagnose"
tags: ["screens"]
---

# Diagnose a screen issue

`GET /v1/screens/{id}/diagnose`

## Request

- Base URL: `https://api.brixsignage.com`
- URL: `https://api.brixsignage.com/v1/screens/{id}/diagnose`
- Auth: HTTP bearer

Get a likely-cause troubleshooting verdict for a screen, based on signals such as online or offline status, what is actually rendering, resource pressure, and early hardware warnings. The response also includes a guided checklist for checking the TV, input, and cable, which the screen itself cannot detect.

## Path parameters

- `id` string, required

## Response `200`

Success.

- object
  - `data` ScreenDiagnosis, required: Why a screen is (or is not) showing what it should.
    - `layer` 'offline' | 'deactivated' | 'unassigned' | 'stick' | 'resource' | 'display' | 'downstream' | 'healthy', required: The first layer that explains the problem, checked from the device outward.
    - `severity` 'none' | 'info' | 'warning' | 'critical', required
    - `likelyCause` string, required: One sentence an operator can act on.
    - `detail` string, nullable, required
    - `fault` 'platform' | 'user' | 'environment', nullable, required: Whose problem it is; null when healthy.
    - `guided` boolean, required: True when `checklist` is a guided fix.
    - `checklist` object[], required
      - `code` string, required
      - `label` string, required
      - `detail` string
    - `remedies` object[]: One-click fixes, when one applies.
      - `kind` 'reboot' | 'wake-screen' | 'restart-app', required: The command to send with POST /v1/screens/{id}/commands.
      - `label` string, required
      - `cost` string, required: What the remedy interrupts, in words.
      - `confirm` boolean, required
    - `prominent` boolean, required: True when the console shows this as a banner.

## Other responses

- `401`: Missing, expired or revoked bearer token.
- `403`: The token lacks the permission this operation needs (see `x-brix-permission`).
- `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)