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
recordVersion
required
string
userId
required
string
required
Array of objects (com.dexcom.partner.api.models.proto.v3.egv.EGV)
Array
recordId
required
string
systemTime
required
string <date-time>
displayTime
required
string <date-time>
transmitterId
string or null
transmitterTicks
required
integer <int64>
value
integer or null <int32>
status
string or null
Enum: "unknown" "high" "low" "ok"
trend
string or null
Enum: "none" "unknown" "doubleUp" "singleUp" "fortyFiveUp" "flat" "fortyFiveDown" "singleDown" "doubleDown" "notComputable" "rateOutOfRange"
trendRate
number or null <double>
unit
required
string

Please see Notes section above for more information on enumeration values

rateUnit
required
string

Please see Notes section above for more information on enumeration values

displayDevice
required
string
transmitterGeneration
required
string
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"
      }
    ]
}