GET /egvs
Description
The /egvs
endpoint enables retrieval of a user's estimated glucose value (EGV) data, including trend and status information.
Resource
GET /v2/users/self/egvs
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.
Name |
Type |
Description |
---|---|---|
|
DateTime |
Beginning of the time window |
|
DateTime |
End of the time window |
Request Example
Response Example
Response Fields
Name |
Type |
Description |
Enumeration |
---|---|---|---|
|
String |
Unit of measurement for |
|
|
String |
Unit of measurement for |
|
|
Array |
Array of estimated glucose values |
egvs
array fields are as follows
Name |
Type |
Description |
Enumeration |
---|---|---|---|
|
DateTime |
Time according to the system clock at which observation was made; nominally UTC |
|
|
DateTime |
Time displayed on the receiving device when the observation was made |
|
|
Float |
Estimated glucose value For G4 and G5 devices, equal to For G6 devices, equal to See the Notes section below for more details |
|
|
Float |
Estimated glucose value presented on receiving device in realtime See the Notes section below for more details |
See enumeration for |
|
Float |
Estimated glucose value presented retrospectively on receiving device after smoothing; G6 devices only See the Notes section below for more details (nullable) |
See enumeration for |
|
String |
Explanation of EGV record; used when the (nullable) |
|
|
String |
General trend of EGV value movement; corresponds to (nullable) |
|
|
Float |
Rate at which glucose value is moving up or down (nullable) |
Notes
The G6 generation of sensors and transmitters introduced the concept of retrospective data smoothing to estimated glucose values. This smoothing incorporates three consecutive EGVs to produce a clearer, more readable trace for the user. Because three consecutive EGVs are not always available—for example, at the beginning or end of a sensor session—some EGVs cannot be smoothed. In these cases, the realtimeValue
will be populated with a number, but the smoothedValue
will be null.
The rules for the value
field are as follows:
- If
smoothedValue
is not null,value
is equal tosmoothedValue
- If
smoothedValue
is null,value
is equal torealtimeValue
The recommended method for consuming the /egvs
endpoint is to use the value
field.
Due to how data is uploaded and processed, some records that initially have a null smoothedValue
may later have this field populated, with the value
field also changing per the rules above.
For EGVs generated by G4 and G5 devices, the smoothedValue
field will always return null as these systems do not have retrospective data smoothing.
The documentation for an earlier version of this endpoint is available here.