GET /devices

Description

The /devices endpoint enables retrieval of a user's device information, including G4, G5, and G6 standalone receivers, the G5 and G6 mobile apps, 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 /v2/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": [
    {
      "transmitterGeneration": "g6",
      "displayDevice": "iOS"
      "lastUploadDate": "2017-06-17T00:00:00",
      "alertScheduleList": [
        {
          "alertScheduleSettings":
            {
              "alertScheduleName": "",
              "isEnabled": true,
              "isDefaultSchedule": true
              "startTime": "00:00",
              "endTime": "00:00",
              "daysOfWeek": [
                "sunday",
                "monday",
                "tuesday",
                "wednesday",
                "thursday",
                "friday",
                "saturday"
              ]
            },
          "alertSettings": [
            {
              "systemTime": "2016-07-05T17:49:22",
              "displayTime": "2016-07-05T10:49:22",
              "alertName": "high",
              "value": 200,
              "unit": "mg/dL",
              "snooze": 30,
              "enabled": true
            },
            {
              "systemTime" : "2016-07-05T17:49:22",
              "displayTime" : "2016-07-05T10:49:22",
              "alertName": "low",
              "value": 80,
              "unit": "mg/dL",
              "snooze": 30,
              "enabled": true
            },
            {
              "systemTime" : "2016-07-05T17:49:22",
              "displayTime" : "2016-07-05T10:49:22",
              "alertName": "rise",
              "value": 3,
              "unit": "mg/dL/min",
              "snooze": null,
              "enabled": true
            },           
            {
              "systemTime" : "2016-07-05T17:49:22",
              "displayTime" : "2016-07-05T10:49:22",
              "alertName": "fall",
              "value": 3,
              "unit": "mg/dL/min",
              "snooze": null,
              "enabled": true
            },
            {
              "systemTime" : "2016-07-05T17:49:22",
              "displayTime" : "2016-07-05T10:49:22",
              "alertName": "outOfRange",
              "value": 20,
              "unit": "minutes"
              "snooze": null,
              "enabled": false
            },
            {
              "systemTime" : "2016-07-05T17:49:22",
              "displayTime" : "2016-07-05T10:49:22",
              "alertName": "urgentLow",
              "value": 55,
              "unit": "mg/dL",
              "snooze": 30,
              "enabled": true
            },
            {
              "systemTime" : "2016-07-05T17:49:22",
              "displayTime" : "2016-07-05T10:49:22",
              "alertName": "urgentLowSoon",
              "value": 55,
              "unit": "mg/dL",
              "snooze": 30,
              "enabled": true
            },
            {
              "systemTime" : "2016-07-05T17:49:22",
              "displayTime" : "2016-07-05T10:49:22",
              "alertName": "noReadings",
              "value": 20,
              "unit": "minutes",
              "snooze": null,
              "enabled": true
            }
          ]
        },
        {
          "alertScheduleSettings":
            {
              "alertScheduleName": "Week Night",
              "isEnabled": true,
              "isDefaultSchedule": false
              "startTime": "20:00",
              "endTime": "08:00",
              "daysOfWeek": [
                "sunday",
                "monday",
                "tuesday",
                "wednesday",
                "thursday"
              ]
            },
          "alertSettings": [
            {
              "systemTime" : "2016-07-05T17:49:22",
              "displayTime" : "2016-07-05T10:49:22",
              "alertName": "high",
              "value": 220,
              "unit": "mg/dL"
              "snooze": 30,
              "enabled": true
            },
            {
              "systemTime" : "2016-07-05T17:49:22",
              "displayTime" : "2016-07-05T10:49:22",
              "alertName": "low",
              "value": 100,
              "unit": "mg/dL"
              "snooze": 30,
              "enabled": true
            },
            {
              "systemTime" : "2016-07-05T17:49:22",
              "displayTime" : "2016-07-05T10:49:22",
              "alertName": "rise",
              "value": 3,
              "unit": "mg/dL/min"
              "snooze": null,
              "enabled": false
            },           
            {
              "systemTime" : "2016-07-05T17:49:22",
              "displayTime" : "2016-07-05T10:49:22",
              "alertName": "fall",
              "value": 3,
              "unit": "mg/dL/min"
              "snooze": null,
              "enabled": true
            },
            {
              "systemTime" : "2016-07-05T17:49:22",
              "displayTime" : "2016-07-05T10:49:22",
              "alertName": "outOfRange",
              "value": 20,
              "unit": "minutes"
              "snooze": null,
              "enabled": false
            },
            {
              "systemTime" : "2016-07-05T17:49:22",
              "displayTime" : "2016-07-05T10:49:22",
              "alertName": "urgentLow",
              "value": 55,
              "unit": "mg/dL"
              "snooze": 30,
              "enabled": true
            },
            {
              "systemTime" : "2016-07-05T17:49:22",
              "displayTime" : "2016-07-05T10:49:22",
              "alertName": "urgentLowSoon",
              "value": 55,
              "unit": "mg/dL",
              "snooze": 30,
              "enabled": true
            },
            {
              "systemTime" : "2016-07-05T17:49:22",
              "displayTime" : "2016-07-05T10:49:22",
              "alertName": "noReadings",
              "value": 20,
              "unit": "minutes",
              "snooze": null,
              "enabled": true
            }
          ]
        }
      ]
    }
  ]
}

 

 

Response Fields

Name

Type

Description

devices

Array

Array of devices

 

The devices array fields are as follows
 

Name

Type

Description

Enumeration

transmitterGeneration

String

Generation of transmitter associated with the device

(nullable)

  • "g4"
  • "g5"
  • "g6"

displayDevice

String

Type of display device used to receive the transmitter signal

(nullable)

  • "receiver"
  • "shareReceiver"
  • "touchscreenReceiver"
  • "iOS"
  • "android"

lastUploadDate

DateTime

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

 

alertScheduleList

Array

Array of alert schedules and settings for the device as of the lastUploadDate

 

 

The alertScheduleList array fields are as follows
 

Name

Type

Description

alertScheduleSettings

Object

Settings associated with each alert schedule

alertSettings

Array

Array of alert settings for the device as of the lastUploadDate

(nullable)

 

The alertScheduleSettings array fields are as follows
 

Name

Type

Description

alertScheduleName

String

Name of the alert schedule

isEnabled

Boolean

Decribes whether the user has the alert schedule enabled on their display device

isDefaultSchedule

Boolean

The default schedule is the alert schedule used in the absence of other applicable alert schedules

startTime

Time

The time each day when the alert schedule begins; corresponds to the device's display time

endTime

Time

The time each day when the alert schedule begins; corresponds to the device's display time

daysOfWeek

Array

An array containing the days of the week this alert schedule value applies to; this array must contain one (or more) of the following strings in English: "sunday", "monday", "tuesday", "wednesday", "thursday", "friday" and/or "saturday"

 

The alertSettings array fields are as follows
 

Name

Type

Description

Enumeration

alertName

String

Name of alert

  • "high" – triggers on a glucose value that crosses the High value
  • "low" – triggers on a glucose value that crosses the Low value
  • "rise" – triggers on a glucose rate that crosses a Rise Rate value
  • "fall" – triggers on a glucose rate that crosses a Fall Rate value
  • "urgentLow" – triggers on a glucose value that crosses the Urgent Low value
  • "urgentLowSoon" – triggers when system is predicting the user will fall below the Urgent Low value in the near future
  • "outOfRange" – triggers an alert when the display is out of communication range after the programmed delay; corresponds to the Signal Loss alert
  • "noData" – triggers when the display device stops receiving EGV data from the transmitter for a certain amount of time; corresponds to the No Readings alert

value

Float

The value at which the alert is set

(nullable)

  • For "high" alert: 120 - 400 mg/dL
  • For "low" alert: 60 - 100 mg/dL
  • For "rise" alert: 2 or 3 mg/dL/min
  • For "fall" alert: 2 or 3 mg/dL/min
  • For "urgentLow" alert: 55 mg/dL (not user-editable)
  • For "urgentLowSoon" alert: 55 mg/dL (not user-editable)
  • For "outOfRange" alert: 20 - 240 minutes
  • For "noData" alert: 20 minutes (not user-editable)

unit

Float

Unit of measurement for the alert value

(nullable)

  • "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

(nullable)

 

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

 

Notes

 

The documentation for an earlier version of this endpoint is available here.