Screen quality

get/v1/screens/{screen_id}/stats/quality

This endpoint is in the contract, but the API doesn't serve it during early access. It returns 404 for now.

Per-channel colour and brightness scores against the latest baseline, from scored quality windows. These are the same numbers the screen.quality webhook sends.

curl "https://api.vojo-media.com/v1/screens/$SCREEN_ID/stats/quality" \
  -H "Authorization: Bearer $VOJO_KEY"

const { data, error } = await api.GET("/v1/screens/{screen_id}/stats/quality", {
  params: { path: { screen_id: screenId } },
});
if (error) throw new VojoApiError(error);

Response 200

{
  "data": {
    "channels": [
      {
        "key": "white",
        "score": 99.2,
        "status": "good"
      },
      {
        "key": "red",
        "score": 91,
        "status": "warn"
      }
    ],
    "baseline": {
      "taken_at": "2026-09-30T07:00:00Z",
      "auto": false
    },
    "total_readings": 168
  },
  "meta": {
    "scope": {
      "type": "screen",
      "id": "cm1scr2w6n0001h8d4k9t3m7ve",
      "name": "Lobby North"
    },
    "generated_at": "2026-10-07T09:30:00Z"
  }
}

Access

Authentication: Secret key or OAuth access token.
Scope: stats:read
User permission: networkViewQuality

Path parameters

screen_idstringRequired
Screen id.

Headers

Vojo-Organisationstring
The organisation this request acts on (org id). Required for oauth2 callers — a missing header returns 400 organisation_header_required; an org the user cannot access (a membership or an access grant, and granted to this OAuth client) returns 403 organisation_access_denied. Secret keys are bound to one org: the header may be omitted, and if sent it must match the key's org (else 403). Every query is scoped by the resolved org, never by an id in the body.
Vojo-Versionstring
Optional API version pin (a date). Overrides the version pinned on the secret key / organisation for this request. Echoed in the Vojo-Version response header. Within /v1 only additive changes ship, so most callers can omit it.
date

Response 200

dataobjectRequired
Show 3 fields
- channelsarray of objectsRequired
  Show 3 fields
  - keystringRequired
    One of white, red, green, blue
  - scorenumber or nullRequired
    Measured vs baseline brightness (100 = on target).
  - statusstringRequired
    Traffic-light health score status.
    One of good, warn, bad, unknown
- baselineobject or nullRequired
  The baseline scored against; null when none exists.
  Show 2 fields
  - taken_atstring or nullRequired
    RFC 3339 / ISO-8601 UTC timestamp, or null.
    date-time
  - autobooleanRequired
    Auto-derived from the first reading, not a calibration.
- total_readingsintegerRequired
  at least 0
metaobjectRequired
Metadata for aggregate reads.
Show 2 fields
- scopeobjectRequired
  The scope the aggregate was resolved to, echoed so callers need no extra lookup for a label.
  Show 3 fields
  - typestringRequired
    Slice of the fleet an aggregate is computed over.
    One of org, site, screen, campaign
  - idstring or nullRequired
    Entity id for site / screen / campaign scopes; null for org.
  - namestring or nullRequired
    Display name of the scoped entity; null for org.
- generated_atstringRequired
  When the aggregate was computed.
  date-time

Response headers

Vojo-Versionstring
The API version (date) this response was rendered with — the request's Vojo-Version, else the key/org pin.
RateLimitstring
IETF RateLimit header: remaining quota in the current window, e.g. "default";r=97;t=42.
RateLimit-Policystring
IETF RateLimit-Policy header, e.g. "default";q=100;w=60. Portal OAuth clients get a higher tier.

Errors

Every error is application/problem+json. Branch on its code.

400
Malformed request: invalid JSON, a bad cursor, a missing Vojo-Organisation for an OAuth caller, or an unknown Vojo-Version.
401
Missing, invalid, expired or revoked credential.
403
The caller is authenticated but not allowed: missing scope (insufficient_scope), missing Permissions flag (permission_denied), a client/installer persona on an operator endpoint (operator_access_required), or no access to the requested org (organisation_access_denied).
404
The resource does not exist, or belongs to another organisation. Cross-org ids always 404, never 403.
429
Rate limit exceeded for this principal. Back off for Retry-After seconds.
500
Unexpected server failure.