Brix Uptime API

openapi: 3.2.0
info:
  title: Brix Uptime API
  version: '1'
  summary: 'Control plane for Brix digital signage: screens, content, playlists, schedules, casts and emergencies.'
  description: 'Generated from the route table the API actually mounts

    (`apps/api/routes.snapshot.json`), the description each route is required to

    carry (`tests/contracts/route-registry.json`), and request/response schemas

    (`apps/api/src/openapi/`). CI enforces all three, so this document cannot list a

    route that does not exist or omit one that does.


    **Schemas.** 447 operations carry request and response schemas

    (`x-brix-schema: verified`). Each is checked in CI against the response the

    real handler returns — a missing, mistyped or undeclared field fails the build.

    The remaining operations are route-level only (`x-brix-schema: none`): their

    path, method, permission and purpose are exact, but the shape of `data` is not

    yet modelled, and we would rather say so than publish a schema that validates

    against nothing. Objects are open: a new field is not a breaking change.


    **Envelope.** Success bodies are `{ "data": … }`. Failures are

    `{ "error": "", "message": "…" }`, plus `requestId` on a 5xx.

    Many list routes page opt-in (see each operation): pass `?limit=` and

    follow `nextCursor` via `?cursor=` until it is null.


    **Authentication.** `Authorization: Bearer ` with an API key

    (`ak_…`, created in the console under Settings → API & MCP) or a user session. An

    API key carries a creator-chosen set of `resource.verb` permissions and may be

    pinned to one location''s subtree; a key can never be granted a permission its

    creator does not hold. The permission an operation needs is in

    `x-brix-permission` and in its security requirement.


    **Tenancy.** Every request resolves to one workspace. A resource belonging to

    another tenant returns 404, never 403, so a response never confirms that an

    account exists.


    **Rate limits.** A 429 carries `Retry-After`; a 503 `database_busy` means retry

    after the `Retry-After` interval.'
servers:
- url: https://api.brixsignage.com
  description: Production
security:
- bearerAuth: []
tags:
- name: Uptime
paths:
  /v1/uptime:
    get:
      operationId: getUptime
      tags:
      - Uptime
      summary: Get uptime report
      description: 'Get an uptime report for a date range, with online percentage per screen and per location, downtime windows, and mean time to recovery.


        **Notes.**

        - Only screens at locations the caller can see. `outageSummary` is present only when there were outages.'
      x-brix-permission: screen.view
      x-brix-schema: verified
      x-brix-notes:
      - Only screens at locations the caller can see. `outageSummary` is present only when there were outages.
      parameters:
      - name: from
        in: query
        required: false
        schema:
          type: string
        description: 'ISO-8601 start (default: the start of the workspace''s offline-history window).'
      - name: to
        in: query
        required: false
        schema:
          type: string
        description: 'ISO-8601 end (default: now).'
      - name: screenId
        in: query
        required: false
        schema:
          type: string
        description: Only this screen.
      responses:
        '200':
          description: Success.
          content:
            application/json:
              schema:
                type: object
                properties:
                  data:
                    type: object
                    properties:
                      from:
                        anyOf:
                        - type: string
                          description: ISO-8601 timestamp (UTC).
                        - type: 'null'
                      to:
                        anyOf:
                        - type: string
                          description: ISO-8601 timestamp (UTC).
                        - type: 'null'
                      offlineRetentionDays:
                        type: integer
                        description: How far back offline history is kept.
                      fleet:
                        type: object
                        properties:
                          screenCount:
                            type: integer
                          onlinePct:
                            type: number
                            description: 0–100.
                          outages:
                            type: integer
                          mttrSec:
                            anyOf:
                            - type: number
                            - type: 'null'
                            description: Mean time to recover, in seconds; null with no recovered outage.
                          totalDowntimeSec:
                            type: number
                          plannedDarkSec:
                            type: number
                            description: Downtime the screen was expected to be dark (a schedule or power policy).
                          plannedDarkOutages:
                            type: integer
                          outageSummary:
                            $ref: '#/components/schemas/OutageSummary'
                          screensWithOutages:
                            type: integer
                        required:
                        - screenCount
                        - onlinePct
                        - outages
                        - mttrSec
                        - totalDowntimeSec
                        - plannedDarkSec
                        - plannedDarkOutages
                      screens:
                        type: array
                        items:
                          type: object
                          properties:
                            screenId:
                              type: string
                            screenName:
                              type: string
                            nodeId:
                              anyOf:
                              - type: string
                              - type: 'null'
                            locationLabel:
                              anyOf:
                              - type: string
                              - type: 'null'
                            status:
                              type: string
                              enum:
                              - online
                              - offline
                              - pairing
                            lastSeenAt:
                              anyOf:
                              - type: string
                                description: ISO-8601 timestamp (UTC).
                              - type: 'null'
                            windowSec:
                              type: number
                            downtimeSec:
                              type: number
                            uptimeSec:
                              type: number
                            onlinePct:
                              type: number
                            outages:
                              type: integer
                            mttrSec:
                              anyOf:
                              - type: number
                              - type: 'null'
                            plannedDarkOutages:
                              type: integer
                            plannedDarkSec:
                              type: number
                            downtimeWindows:
                              type: array
                              items:
                                type: object
                                properties:
                                  from:
                                    type: string
                                    description: ISO-8601 timestamp (UTC).
                                  to:
                                    anyOf:
                                    - type: string
                                      description: ISO-8601 timestamp (UTC).
                                    - type: 'null'
                                    description: Null while the screen is still down.
                                  durationSec:
                                    type: number
                                  detectionPath:
                                    type: string
                                    description: How the outage was noticed, e.g. `ws-close`, `heartbeat-timeout`.
                                  cause:
                                    anyOf:
                                    - type: string
                                    - type: 'null'
                                  causeDetail:
                                    anyOf:
                                    - type: string
                                    - type: 'null'
                                  causeLabel:
                                    anyOf:
                                    - type: string
                                    - type: 'null'
                                  reason:
                                    anyOf:
                                    - type: string
                                    - type: 'null'
                                  expectedDark:
                                    anyOf:
                                    - type: boolean
                                    - type: 'null'
                                  expectedReason:
                                    anyOf:
                                    - type: string
                                    - type: 'null'
                                required:
                                - from
                                - to
                                - durationSec
                                - detectionPath
                                - cause
                                - reason
                                - expectedDark
                                - expectedReason
                            outageSummary:
                              $ref: '#/components/schemas/OutageSummary'
                          required:
                          - screenId
                          - screenName
                          - nodeId
                          - locationLabel
                          - status
                          - lastSeenAt
                          - windowSec
                          - downtimeSec
                          - uptimeSec
                          - onlinePct
                          - outages
                          - mttrSec
                          - plannedDarkOutages
                          - plannedDarkSec
                          - downtimeWindows
                      locations:
                        type: array
                        items:
                          type: object
                          properties:
                            nodeId:
                              anyOf:
                              - type: string
                              - type: 'null'
                            name:
                              type: string
                            screenCount:
                              type: integer
                            onlinePct:
                              type: number
                            windowSec:
                              type: number
                            downtimeSec:
                              type: number
                            outages:
                              type: integer
                            mttrSec:
                              anyOf:
                              - type: number
                              - type: 'null'
                            outageSummary:
                              $ref: '#/components/schemas/OutageSummary'
                            screensWithOutages:
                              type: integer
                          required:
                          - nodeId
                          - name
                          - screenCount
                          - onlinePct
                          - windowSec
                          - downtimeSec
                          - outages
                          - mttrSec
                    required:
                    - from
                    - to
                    - offlineRetentionDays
                    - fleet
                    - screens
                    - locations
                required:
                - data
        '401':
          description: Missing, expired or revoked bearer token.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error'
        '403':
          description: The token lacks the permission this operation needs (see `x-brix-permission`).
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error'
        '422':
          description: '`from` or `to` is not an ISO-8601 timestamp.'
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error'
        5XX:
          description: Server error. The body carries a `requestId` to quote to support.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error'
      security:
      - bearerAuth:
        - screen.view
components:
  schemas:
    Error:
      type: object
      properties:
        error:
          type: string
          description: 'Machine-readable code: `unauthorized`, `forbidden`, `not_found`, `validation_error`, `conflict`, `rate_limited`, `internal_error`, …'
        message:
          description: Human-readable explanation. Safe to show an operator.
          type: string
        requestId:
          description: 'Present on 5xx: quote it to support.'
          type: string
      required:
      - error
      additionalProperties: {}
      description: Error envelope returned by every failing request.
    OutageSummary:
      type: object
      properties:
        windowDays:
          type: integer
        count:
          type: integer
          description: Unplanned outages in the window.
        byCause:
          type: object
          properties:
            power-loss:
              type: integer
            powered-off:
              type: integer
            os-reboot:
              type: integer
            app-crash:
              type: integer
            app-killed-low-memory:
              type: integer
            app-anr:
              type: integer
            app-restart:
              type: integer
            wifi-dropped:
              type: integer
            wifi-weak:
              type: integer
            wifi-no-internet:
              type: integer
            ethernet-dropped:
              type: integer
            brix-unreachable:
              type: integer
            display-off:
              type: integer
            sleep:
              type: integer
            scheduled-off:
              type: integer
            unknown:
              type: integer
            power-cycle:
              type: integer
            network-only:
              type: integer
          description: Outage count per cause; a cause with none is absent.
        byBucket:
          type: object
          properties:
            app:
              type: integer
            display:
              type: integer
            unknown:
              type: integer
            network:
              type: integer
            power:
              type: integer
            brix:
              type: integer
            planned:
              type: integer
          required:
          - app
          - display
          - unknown
          - network
          - power
          - brix
          - planned
        topCause:
          anyOf:
          - type: string
            enum:
            - power-loss
            - powered-off
            - os-reboot
            - app-crash
            - app-killed-low-memory
            - app-anr
            - app-restart
            - wifi-dropped
            - wifi-weak
            - wifi-no-internet
            - ethernet-dropped
            - brix-unreachable
            - display-off
            - sleep
            - scheduled-off
            - unknown
            - power-cycle
            - network-only
          - type: 'null'
        topCauseShare:
          type: number
        hedgedShare:
          type: number
        lastCause:
          anyOf:
          - type: object
            properties:
              cause:
                type: string
                enum:
                - power-loss
                - powered-off
                - os-reboot
                - app-crash
                - app-killed-low-memory
                - app-anr
                - app-restart
                - wifi-dropped
                - wifi-weak
                - wifi-no-internet
                - ethernet-dropped
                - brix-unreachable
                - display-off
                - sleep
                - scheduled-off
                - unknown
                - power-cycle
                - network-only
              confident:
                type: boolean
                description: False when the cause is a best guess.
            required:
            - cause
            - confident
          - type: 'null'
        lastAt:
          anyOf:
          - type: string
            description: ISO-8601 timestamp (UTC).
          - type: 'null'
        lastKnownCause:
          anyOf:
          - type: object
            properties:
              cause:
                type: string
                enum:
                - power-loss
                - powered-off
                - os-reboot
                - app-crash
                - app-killed-low-memory
                - app-anr
                - app-restart
                - wifi-dropped
                - wifi-weak
                - wifi-no-internet
                - ethernet-dropped
                - brix-unreachable
                - display-off
                - sleep
                - scheduled-off
                - unknown
                - power-cycle
                - network-only
              confident:
                type: boolean
                description: False when the cause is a best guess.
            required:
            - cause
            - confident
          - type: 'null'
        avgRssiDbm:
          anyOf:
          - type: number
          - type: 'null'
        insight:
          anyOf:
          - type: string
          - type: 'null'
          description: The rollup sentence, e.g. `All 6 were Wi-Fi drops.`
      required:
      - windowDays
      - count
      - byCause
      - byBucket
      - topCause
      - topCauseShare
      - hedgedShare
      - lastCause
      - lastAt
      - lastKnownCause
      - avgRssiDbm
      - insight
      description: Outages in a window, by cause.
  securitySchemes:
    bearerAuth:
      type: http
      scheme: bearer
      description: An API key (`ak_…`) or a user session token. API keys carry `resource.verb` permissions.