Skip to main content
GET
JavaScript
Reports the state of the visual overlay that the device’s automation service can draw over the screen.
Not every device draws an overlay. Devices without one always report visible: false.

Authorizations

Authorization
string
header
required

Bearer token via Authorization header

Headers

X-Device-Display-ID
integer<int64>
default:0
Required range: x >= 0

Path Parameters

deviceId
string
required

Response

OK

visible
boolean
required
$schema
string<uri>
read-only

A URL to the JSON Schema for this object.

Example:

"https://example.com/schemas/OverlayVisibleBody.json"