# Displaying Device Health
Display the health status of your end users' devices in your app.
To display the health—that is, the online/offline status—of your end users' devices in your app, you can use the following Seam mechanisms: * [Use the `properties.online` property of the `device` object.](#get-device-status-using-device-properties) * [Use the `device.connected` and `device.disconnected` events.](#get-device-status-using-connection-related-events) ## Get Device Status Using Device Properties Seam polls connected devices and accounts every ten minutes and updates the Boolean [`device.properties.online`](https://docs.seam.co/latest/~/revisions/DFdrUdS2jQOnbJTNDT5a/api/devices#device.properties-properties) property accordingly. Use a [Get Device](https://docs.seam.co/latest/~/revisions/DFdrUdS2jQOnbJTNDT5a/api/devices/get) request to retrieve the current online/offline status of a device. Then, display the device status in your app. {% hint style="info" %} You can also use the prebuilt [device details Seam Component](https://docs.seam.co/latest/~/revisions/DFdrUdS2jQOnbJTNDT5a/ui-components/overview/react-components/device-details), which includes a device status display. {% endhint %} {% tabs %} {% tab title="Python" %} **Request:** ```python device = seam.devices.get("36cf1a96-196d-41b0-9804-88154387f1f9") pprint("Online: " + str(device.properties.online)) ``` **Response:** ``` 'Online: True' ``` {% endtab %} {% tab title="cURL (bash)" %} **Request:** ```bash # Use GET or POST. curl -X 'GET' \ 'https://connect.getseam.com/devices/get' \ -H 'accept: application/json' \ -H 'Authorization: Bearer ${API_KEY}' \ -H 'Content-Type: application/json' \ -d '{ "device_id": "36cf1a96-196d-41b0-9804-88154387f1f9" }' | jq -r '"Online: " + (.device.properties.online | tostring)' ``` **Response:** ``` Online: true ``` {% endtab %} {% tab title="JavaScript" %} **Request:** ```javascript const device = await seam.devices.get({device_id: "36cf1a96-196d-41b0-9804-88154387f1f9"}); console.log("Online:", device.properties.online); ``` **Response:** ``` Online: true ``` {% endtab %} {% tab title="Ruby" %} **Request:** ```ruby device = client.devices.get(device_id: "36cf1a96-196d-41b0-9804-88154387f1f9") puts "Online: " + device.properties.online.to_s ``` **Response:** ``` Online: true ``` {% endtab %} {% tab title="PHP" %} **Request:** ```php $device = $seam->devices->get(device_id: "36cf1a96-196d-41b0-9804-88154387f1f9"); if ($device->properties->online === true) { echo "Online: true\n"; } else { echo "Online: false\n"; } ``` **Response:** ``` Online: true ``` {% endtab %} {% tab title="C#" %} **Request:** ```csharp var device = seam.Devices.Get(deviceId: "36cf1a96-196d-41b0-9804-88154387f1f9"); Console.WriteLine("Online: " + device.Properties.Online); ``` **Response:** ``` Online: True ``` {% endtab %} {% tab title="Java" %} **Request:** ```java Device device = seam.devices() .get(DevicesGetRequest.builder() .deviceId("36cf1a96-196d-41b0-9804-88154387f1f9") .build()); System.out.println("Online: " + device.getProperties().getOnline()); ``` **Response:** ``` Online: true ``` {% endtab %} {% tab title="Go" %} **Request:** ```go device, err := client.Devices.Get( context.Background(), &api.DevicesGetRequest{ DeviceId: api.String("36cf1a96-196d-41b0-9804-88154387f1f9"), }, ) if err != nil { return err } fmt.Println("Online:", device.Properties.Online) return nil ``` **Response:** ``` Online: true ``` {% endtab %} {% endtabs %} ## Get Device Status Using Connection-Related Events When a device connection or disconnection occurs, Seam generates a [`device.connected`](https://docs.seam.co/latest/~/revisions/DFdrUdS2jQOnbJTNDT5a/api/events#event-types) or [`device.disconnected`](https://docs.seam.co/latest/~/revisions/DFdrUdS2jQOnbJTNDT5a/api/events#event-types) event, respectively. You can retrieve these events using a [List Events](https://docs.seam.co/latest/~/revisions/DFdrUdS2jQOnbJTNDT5a/api/events/list) request or through [webhooks](https://docs.seam.co/latest/~/revisions/DFdrUdS2jQOnbJTNDT5a/developer-tools/webhooks) and then display the corresponding status in your app. {% hint style="info" %} To help you test your app against events—like device disconnection or removal—that are difficult to orchestrate in a QA environment using real devices, Seam provides a suite of `simulate` endpoints that you can use in a [sandbox workspace](https://docs.seam.co/latest/~/revisions/DFdrUdS2jQOnbJTNDT5a/workspaces#sandbox-workspaces). See [Testing Your App Against Device Disconnection and Removal](https://docs.seam.co/latest/~/revisions/DFdrUdS2jQOnbJTNDT5a/core-concepts/devices/testing-your-app-against-device-disconnection-and-removal). {% endhint %} ### Get Connection-Related Events Using a List Events Request When issuing a [List Events](https://docs.seam.co/latest/~/revisions/DFdrUdS2jQOnbJTNDT5a/api/events/list) request to retrieve [`device.connected`](https://docs.seam.co/latest/~/revisions/DFdrUdS2jQOnbJTNDT5a/api/events#event-types) or [`device.disconnected`](https://docs.seam.co/latest/~/revisions/DFdrUdS2jQOnbJTNDT5a/api/events#event-types) events for a specific device, include the following parameters:
ParameterTypeDescription
device_idString (UUID)ID of the device for which you want to retrieve device.connected or device.disconnected events
event_typeStringEvent type that you want to retrieve, that is, device.connected or device.disconnected
sinceStringDesired starting event generation date and time
You must include since or between.
betweenSet of two stringsDesired starting and ending event generation dates and times
For example:
["2024-01-01T00:00:00Z", "2024-02-01T00:00:00Z"]
You must include between or since.
The following example uses the List Events request to retrieve all `device.connected` events for a specific device since January 1, 2024: {% tabs %} {% tab title="Python" %} **Request:** ```python device_connected_events = seam.events.list( device_id = "36cf1a96-196d-41b0-9804-88154387f1f9", event_type = "device.connected", since = "2024-01-01T00:00:00Z" ) pprint(device_connected_events) ``` **Response:** ``` [{'connected_account_id': 'c1413928-f527-4e12-abf9-d5e18d92dd33', 'created_at': '2024-02-04T21:55:09.681Z', 'device_id': '36cf1a96-196d-41b0-9804-88154387f1f9', 'event_id': 'ca3114b2-088d-43f9-bb5e-ded5d19ad053', 'event_type': 'device.connected', 'occurred_at': '2024-02-04T21:55:09.681Z', 'workspace_id': '398d80b7-3f96-47c2-b85a-6f8ba21d07be'}, {'connected_account_id': 'c1413928-f527-4e12-abf9-d5e18d92dd33', 'created_at': '2024-02-03T04:54:39.744Z', 'device_id': '36cf1a96-196d-41b0-9804-88154387f1f9', 'event_id': '39fcb512-82a4-431d-969f-3935eeba8929', 'event_type': 'device.connected', 'occurred_at': '2024-02-03T04:54:39.744Z', 'workspace_id': '398d80b7-3f96-47c2-b85a-6f8ba21d07be'}] ``` {% endtab %} {% tab title="cURL (bash)" %} **Request:** ```bash # Use GET or POST. curl -X 'GET' \ 'https://connect.getseam.com/devices/list' \ -H 'accept: application/json' \ -H 'Authorization: Bearer ${API_KEY}' \ -H 'Content-Type: application/json' \ -d '{ "device_id": "36cf1a96-196d-41b0-9804-88154387f1f9", "event_type": "device.connected", "since": "2024-01-01T00:00:00Z" }' ``` **Response:** ```json { "events": [ { "event_id": "ca3114b2-088d-43f9-bb5e-ded5d19ad053", "device_id": "36cf1a96-196d-41b0-9804-88154387f1f9", "event_type": "device.connected", "workspace_id": "398d80b7-3f96-47c2-b85a-6f8ba21d07be", "created_at": "2024-02-04T21:55:09.681Z", "occurred_at": "2024-02-04T21:55:09.681Z", "connected_account_id": "c1413928-f527-4e12-abf9-d5e18d92dd33" }, { "event_id": "39fcb512-82a4-431d-969f-3935eeba8929", "device_id": "36cf1a96-196d-41b0-9804-88154387f1f9", "event_type": "device.connected", "workspace_id": "398d80b7-3f96-47c2-b85a-6f8ba21d07be", "created_at": "2024-02-03T04:54:39.744Z", "occurred_at": "2024-02-03T04:54:39.744Z", "connected_account_id": "c1413928-f527-4e12-abf9-d5e18d92dd33" } ], "ok": true } ``` {% endtab %} {% tab title="JavaScript" %} **Request:** ```javascript const device_connected_events = await seam.events.list({ device_id: "36cf1a96-196d-41b0-9804-88154387f1f9", event_type: "device.connected", since: "2024-01-01T00:00:00Z" }) console.log(device_connected_events) ``` **Response:** ```json [ { event_id: 'ca3114b2-088d-43f9-bb5e-ded5d19ad053', device_id: '36cf1a96-196d-41b0-9804-88154387f1f9', event_type: 'device.connected', workspace_id: '398d80b7-3f96-47c2-b85a-6f8ba21d07be', created_at: '2024-02-04T21:55:09.681Z', occurred_at: '2024-02-04T21:55:09.681Z', connected_account_id: 'c1413928-f527-4e12-abf9-d5e18d92dd33' }, { event_id: '39fcb512-82a4-431d-969f-3935eeba8929', device_id: '36cf1a96-196d-41b0-9804-88154387f1f9', event_type: 'device.connected', workspace_id: '398d80b7-3f96-47c2-b85a-6f8ba21d07be', created_at: '2024-02-03T04:54:39.744Z', occurred_at: '2024-02-03T04:54:39.744Z', connected_account_id: 'c1413928-f527-4e12-abf9-d5e18d92dd33' } ] ``` {% endtab %} {% tab title="Ruby" %} **Request:** ```ruby device_connected_events = client.events.list( device_id: "36cf1a96-196d-41b0-9804-88154387f1f9", event_type: "device.connected", since: "2024-01-01T00:00:00Z" ) puts device_connected_events.inspect ``` **Response:** ``` [, ] ``` {% endtab %} {% tab title="PHP" %} **Request:** ```php $device_connected_events = $seam->events->list( device_id: "36cf1a96-196d-41b0-9804-88154387f1f9", event_type: "device.connected", since: "2024-01-01T00:00:00Z" ); echo json_encode($device_connected_events), "\n"; ``` **Response:** {% code overflow="wrap" %} ```json [{"event_id":"ca3114b2-088d-43f9-bb5e-ded5d19ad053","device_id":"36cf1a96-196d-41b0-9804-88154387f1f9","event_type":"device.connected","workspace_id":"398d80b7-3f96-47c2-b85a-6f8ba21d07be","created_at":"2024-02-04T21:55:09.681Z","occurred_at":"2024-02-04T21:55:09.681Z"},{"event_id":"39fcb512-82a4-431d-969f-3935eeba8929","device_id":"36cf1a96-196d-41b0-9804-88154387f1f9","event_type":"device.connected","workspace_id":"398d80b7-3f96-47c2-b85a-6f8ba21d07be","created_at":"2024-02-03T04:54:39.744Z","occurred_at":"2024-02-03T04:54:39.744Z"}] ``` {% endcode %} {% endtab %} {% tab title="C#" %} **Request:** ```csharp var device_connected_events = seam.Events.List( deviceId: "36cf1a96-196d-41b0-9804-88154387f1f9", eventType: Seam.Api.Events.ListRequest.EventTypeEnum.DeviceConnected, since: "2024-01-01T00:00:00Z" ); foreach (var device_connected_event in device_connected_events) { Console.WriteLine(device_connected_event); } ``` **Response:** ```json { "event_id": "ca3114b2-088d-43f9-bb5e-ded5d19ad053", "device_id": "36cf1a96-196d-41b0-9804-88154387f1f9", "event_type": "device.connected", "workspace_id": "398d80b7-3f96-47c2-b85a-6f8ba21d07be", "created_at": "2024-02-04T21:55:09.681Z", "occurred_at": "2024-02-04T21:55:09.681Z" } { "event_id": "39fcb512-82a4-431d-969f-3935eeba8929", "device_id": "36cf1a96-196d-41b0-9804-88154387f1f9", "event_type": "device.connected", "workspace_id": "398d80b7-3f96-47c2-b85a-6f8ba21d07be", "created_at": "2024-02-03T04:54:39.744Z", "occurred_at": "2024-02-03T04:54:39.744Z" } ``` {% endtab %} {% tab title="Java" %} **Request:** ```java var deviceConnectedEvents = seam.events() .list(EventsListRequest.builder() .deviceId("36cf1a96-196d-41b0-9804-88154387f1f9") .eventType(EventsListRequestEventType.DEVICE_CONNECTED) .since("2024-01-01T00:00:00Z") .build()); System.out.println(deviceConnectedEvents); ``` **Response:** ```json [{ "event_id" : "ca3114b2-088d-43f9-bb5e-ded5d19ad053", "device_id" : "36cf1a96-196d-41b0-9804-88154387f1f9", "event_type" : "device.connected", "workspace_id" : "398d80b7-3f96-47c2-b85a-6f8ba21d07be", "created_at" : "2024-02-04T21:55:09.681Z", "occurred_at" : "2024-02-04T21:55:09.681Z", "connected_account_id" : "c1413928-f527-4e12-abf9-d5e18d92dd33" }, { "event_id" : "39fcb512-82a4-431d-969f-3935eeba8929", "device_id" : "36cf1a96-196d-41b0-9804-88154387f1f9", "event_type" : "device.connected", "workspace_id" : "398d80b7-3f96-47c2-b85a-6f8ba21d07be", "created_at" : "2024-02-03T04:54:39.744Z", "occurred_at" : "2024-02-03T04:54:39.744Z", "connected_account_id" : "c1413928-f527-4e12-abf9-d5e18d92dd33" }] ``` {% endtab %} {% tab title="Go" %} **Request:** ```go device_connected_events, err := client.Events.List( context.Background(), &api.EventsListRequest{ DeviceId: api.String("36cf1a96-196d-41b0-9804-88154387f1f9"), EventType: api.EventTypeDeviceConnected.Ptr(), Since: api.String("2024-01-01T00:00:00Z"), }, ) if err != nil { return err } fmt.Println(device_connected_events) return nil ``` **Response:** ```json [{ "event_id": "ca3114b2-088d-43f9-bb5e-ded5d19ad053", "device_id": "36cf1a96-196d-41b0-9804-88154387f1f9", "event_type": "device.connected", "workspace_id": "398d80b7-3f96-47c2-b85a-6f8ba21d07be", "created_at": "2024-02-04T21:55:09.681Z", "occurred_at": "2024-02-04T21:55:09.681Z", "connected_account_id": "c1413928-f527-4e12-abf9-d5e18d92dd33" } { "event_id": "39fcb512-82a4-431d-969f-3935eeba8929", "device_id": "36cf1a96-196d-41b0-9804-88154387f1f9", "event_type": "device.connected", "workspace_id": "398d80b7-3f96-47c2-b85a-6f8ba21d07be", "created_at": "2024-02-03T04:54:39.744Z", "occurred_at": "2024-02-03T04:54:39.744Z", "connected_account_id": "c1413928-f527-4e12-abf9-d5e18d92dd33" }] ``` {% endtab %} {% endtabs %} ### Receive Connection-Related Events Using a Webhook You can set up webhook endpoints to receive `device.connected` and `device.disconnected` events. Then, you can use the receipt of these events to display the corresponding device status in your app. For more information about configuring webhooks, see [Webhooks](https://docs.seam.co/latest/~/revisions/DFdrUdS2jQOnbJTNDT5a/developer-tools/webhooks).