egvs

Description

The /egvs endpoint enables retrieval of a user's estimated glucose value (EGV) data, including trend and status information. Scopes And Access

Resource

GET /v3/users/self/egvs

Authorization

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

Notes

The unit enumerations vary between endpoints. For egvs, the values are as follows:

  • unknown
  • mg/dL
  • mmol/L

The rateUnit enumerations for egvs are as follows:

  • unknown
  • mg/dL/min
  • mmol/L/min

For the systemTime and displayTime response fields, records sourced from mobile apps (with displayDevice of “iOS” or “android”) will have UTC offsets; records sourced from receivers (with displayDevice of “receiver”) will not have UTC offsets.

SecurityBearerAuth
Request
query Parameters
startDate
required
string <date-time>

Beginning of the time window.

Example: startDate=2022-02-06T09:12:35
endDate
required
string <date-time>

End of the time window.

Example: endDate=2022-02-06T09:12:35
Responses
200

Ok

Response Schema: application/json
recordType
required
string

The type of records that will be returned in this response. Example: "egv"

recordVersion
required
string

The version of the records that will be returned in this response. Example: “3.0”

userId
required
string

The user ID is unique on a per-Dexcom account, per-Client basis. The ID will not be the same for a user across clients (even if the clients are owned by the same developer).

required
Array of objects (com.dexcom.partner.api.models.proto.v3.egv.EGV)

Array of egvs. The size of the array will be zero if there are no egvs.

Array
recordId
required
string

A unique id (UUID) that identifies EGV record for the given client.

systemTime
required
string <date-time>

The recorded system time of the alerts/egv/calibration/event. This is the ISO 8601 time according to the system clock at which observation was made (UTC). Records sourced from mobile apps (with displayDevice of “iOS” or “android”) will have UTC offsets; records sourced from receivers (with displayDevice of “receiver”) will not have UTC offsets.

displayTime
required
string <date-time>

The recorded display time of the alerts/egv/calibration/event. This is the ISO 8601 time displayed on the receiving device when the observation was made (local). Records sourced from mobile apps (with displayDevice of “iOS” or “android”) will have UTC offsets; records sourced from receivers (with displayDevice of “receiver”) will not have UTC offsets.

transmitterId
string or null

A hashed and encrypted version of the unique ID of the transmitter. This may be used to determine uniqueness of transmitter or associate multiple records with the same transmitter, but it cannot be matched to the real transmitter ID.

transmitterTicks
required
integer <int64>

The count, in seconds, since the transmitter was initiated. Example: 72364324786

value
integer or null <int32>

Estimated glucose value EGV

  • 39: Indicates that the value was calculated, and it was less than 40; the value 39 is used in calculations but is not explicitly displayed to end users
  • 40 to 400: This is the measuring range of the Dexcom CGM.
  • 401: Indicates that the value was calculated, and it was greater than 400; the value 401 is used in calculations but is not explicitly displayed to end users.
status
string or null

Explanation of EGV record; used when the value field is outside the measuring range.

"high": indicates a glucose value of more than 400

"low": indicates a glucose value of less than 40

Enum: "unknown" "high" "low" "ok"
trend
string or null

General trend of EGV value movement; corresponds to the trendRate field:

  • "doubleUp" (+3 ≤ trendRate ≤ +8)
  • "singleUp" (+2 ≤ trendRate < +3)
  • "fortyFiveUp" (+1 ≤ trendRate < +2)
  • "flat" (-1 < trendRate < +1)
  • "fortyFiveDown" (-2 < trendRate ≤ -1)
  • "singleDown" (-3 < trendRate ≤ -2)
  • "doubleDown" (-8 < trendRate ≤ -3)
  • "none" (no arrow (blank))
  • "notComputable" (The algorithm decides that it is not reasonable to compute trend arrow)
  • "rateOutOfRange" (The computed filtered rate is not within the range for assigning the arrows)
Enum: "none" "unknown" "doubleUp" "singleUp" "fortyFiveUp" "flat" "fortyFiveDown" "singleDown" "doubleDown" "notComputable" "rateOutOfRange"
trendRate
number or null <double>

Rate at which glucose value is moving up or down.

unit
required
string

Unit of measurement for value.

Enum: "unknown" "mg/dL" "mmol/L"

Please note all glucose values are reported in units of mg/dL and trend rates in units of mg/dL/min. Conversion of these values into user-preferred units, such as mmol/L, is the responsibility of the client application.

rateUnit
required
string

Unit of measurement for trendRate.

Enum: "mg/dL/min" "mmol/L/min"

Please note all glucose values are reported in units of mg/dL and trend rates in units of mg/dL/min. Conversion of these values into user-preferred units, such as mmol/L, is the responsibility of the client application.

displayDevice
required
string

The type of display device the egv came from. Enum: "unknown""receiver" "iOS" "android"

transmitterGeneration
required
string

The generation of transmitter that was associated with this upload.

Enum: "unknown" "g4" "g5" "g6" "g6+" "dexcomPro" "g7"
get/v3/users/self/egvs
Request samples
curl -i -X GET \
  'https://api.dexcom.com/v3/users/self/egvs?startDate=2022-02-06T09%3A12%3A35&endDate=2022-02-06T09%3A12%3A35' \
  -H 'Authorization: Bearer <YOUR_TOKEN_HERE>'
Response samples
application/json
{
  • "recordType": "egv",
  • "recordVersion": "3.0",
  • "userId": "5b329ebcfbf2f0ba7e49d4c5eb57775468f5ee657ac16fcde07e1fd08197b4c7",
  • "records": [
    • {
      • "recordId": "2cab70ee-d3b4-5a34-9aa9-767513ab72bd",
      • "systemTime": "2022-01-30T23:49:55Z",
      • "displayTime": "2022-01-30T15:49:55-08:00",
      • "transmitterId": "cdb4f8eea4392295413c64d5bc7a9e0e0ee9b215fb43c5a6d71d4431e540046b",
      • "transmitterTicks": 85273,
      • "value": 103,
      • "trend": "flat",
      • "trendRate": 0,
      • "unit": "mg/dL",
      • "rateUnit": "mg/dL/min",
      • "displayDevice": "iOS",
      • "transmitterGeneration": "g6"
      }
    ]
}