GET /devices

This page documents an old version of the endpoint. The newest version, v2, is documented here.

 

Description

The /devices endpoint enables retrieval of a user's device information, including G4 and G5 standalone receivers, the G5 mobile app, and transmitters. The response is an array of all receiver-type devices contributing data to the specified time window, including the alerts and settings associated with each receiver.

Scopes & Access

 

Resource

GET /v1/users/self/devices

 

Authorization

OAuth 2.0 bearer token; see the Authentication section for details on this workflow.

 

Query Parameters

These query parameters specify the time window for the requested data; both are required. See the discussion of time in the Endpoint Overview section for more details on how they relate to device information. Due to the way device upload records are stored, the time components of the startDate and endDate parameters are ignored for the /devices endpoint.

Name

Type

Description

startDate

DateTime

Beginning of the time window

endDate

DateTime

End of the time window

 

Request Example

 

Response Example

{
  "devices": [
    {
      "model": "G5 Mobile App",
      "lastUploadDate": "2017-06-17T00:00:00",
      "alertSettings": [
        {
          "alertName": "high",
          "value": 200,
          "unit": "mg/dL",
          "snooze": 30,
          "delay": 0,
          "enabled": true,
          "systemTime": "2016-08-15T00:00:00",
          "displayTime": "2016-08-14T16:00:00"
        },
        {
          "alertName": "low",
          "value": 80,
          "unit": "mg/dL",
          "snooze": 30,
          "delay": 0,
          "enabled": true,
          "systemTime": "2016-08-15T00:00:00",
          "displayTime": "2016-08-14T16:00:00"
        },
        {
          "alertName": "rise",
          "value": 3,
          "unit": "mg/dL/min",
          "snooze": 30,
          "delay": 0,
          "enabled": true,
          "systemTime": "2016-08-15T00:00:00",
          "displayTime": "2016-08-14T16:00:00"
        },
        {
          "alertName": "fall",
          "value": 3,
          "unit": "mg/dL/min",
          "snooze": 30,
          "delay": 0,
          "enabled": true,
          "systemTime": "2016-08-15T00:00:00",
          "displayTime": "2016-08-14T16:00:00"
        },
        {
          "alertName": "fixedLow",
          "value": 55,
          "unit": "mg/dL",
          "snooze": 30,
          "delay": 0,
          "enabled": true,
          "systemTime": "2016-08-15T00:00:00",
          "displayTime": "2016-08-14T16:00:00"
        },
        {
          "alertName": "outOfRange",
          "value": 20,
          "unit": "minutes",
          "snooze": 30,
          "delay": 0,
          "enabled": true,
          "systemTime": "2016-08-15T00:00:00",
          "displayTime": "2016-08-14T16:00:00"
        }
      ]
    }
  ]
}

 

 

Response Fields

Name

Type

Description

devices

Array

Array of devices

 
The devices array fields are as follows
 

Name

Type

Description

Enumeration

model

String

Device Name

  • "G5 Mobile App"
  • "G5 Receiver"
  • "G4 with Share Receiver"
  • "G4 Receiver"
  • "Unknown"

lastUploadDate

DateTime

Server timestamp, in UTC, of last upload event for the device that contributed data in the specifed time window; note that this may be outside the range defined by the startDate and endDate query parameters

 

alertSettings

Array

Array of alert settings for the device as of the lastUploadDate

(nullable)

 

 

The alertSettings fields are as follows

Name

Type

Description

Enumeration

alertName

String

Name of alert

  • "high" – triggers on a glucose value that crosses a max value
  • "low" – triggers on a glucose value that crosses a min value
  • "rise" – triggers on a glucose rate that crosses a max value
  • "fall" – triggers on a glucose rate that crosses a min value
  • "outOfRange" – triggers an alert when the display is out of communication range after the programmed delay
  • "fixedLow" – the 55 mg/dL alert; note this cannot be disabled and the value is fixed

value

Float

The value at which the alert is set

  • For "high" alert: 120 - 400 mg/dL in 10 mg/dL increments
  • For "low" alert: 60 - 100 mg/dL in 5 mg/dL increments
  • For "rise" alert: 2 or 3 mg/dL/min
  • For "fall" alert: 2 or 3 mg/dL/min
  • For "outOfRange" alert: 20 - 240 minutes in 5 minute increments
  • For "fixedLow" alert: 55 mg/dL (not user-editable)

unit

Float

Unit of measurement for the alert value

  • "mg/dL"
  • "mmol/L"
  • "mg/dL/min"
  • "mmol/L/min"
  • "minutes"

snooze

Integer

Time (in minutes) before resuming alarming after the alert has been acknowledged and cleared

 

delay

Integer

Time (in minutes) before initial alarming after the alert threshold/condition is triggered

 

enabled

Boolean

Indication of whether or not the alert is enabled on the device

 

systemTime

DateTime

Time according to the system clock when alert setting was last adjusted by the user; nominally UTC

 

displayTime

DateTime

Display time when alert setting was last adjusted by the user