alerts

Description

The /alerts endpoint was not previously available to data partners in version 2 of The Dexcom API. This endpoint provides EGV alerts for a user, such as High or Low, within a provided date range.

Resource

GET /v3/users/self/alerts

Authorization

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

Notes

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>

Lower bound (inclusive) of the time window in which to look for data.

Example: startDate=2023-01-01T09:12:35
endDate
required
string <date-time>

Upper bound (exclusive) of the time window in which to look for data.

Example: endDate=2023-01-01T09: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.alert.AlertEvent)
Array
recordId
required
string
systemTime
required
string <date-time>
displayTime
required
string <date-time>
alertName
required
string
Enum: "unknown" "high" "low" "rise" "fall" "outOfRange" "urgentLow" "urgentLowSoon" "noReadings" "fixedLow"
alertState
required
string
Enum: "unknown" "inactive" "activeSnoozed" "activeAlarming"
displayDevice
required
string
transmitterGeneration
required
string
Enum: "unknown" "g4" "g5" "g6" "g6+" "dexcomPro" "g7"
transmitterId
required
string
displayApp
required
string
get/v3/users/self/alerts
Request samples
curl -i -X GET \
  'https://api.dexcom.com/v3/users/self/alerts?startDate=2023-01-01T09%3A12%3A35&endDate=2023-01-01T09%3A12%3A35' \
  -H 'Authorization: Bearer <YOUR_TOKEN_HERE>'
Response samples
application/json
{
  • "recordType": "alerts",
  • "recordVersion": "3.0",
  • "userId": "5b329ebcfbf2f0ba7e49d4c5eb57775468f5ee657ac16fcde07e1fd08197b4c7",
  • "records": [
    • {
      • "recordId": "3cb368a9-7b7c-45dc-850a-33f62118bfd5",
      • "systemTime": "2022-12-05T15:00:25.438Z",
      • "displayTime": "2022-12-05T15:00:25.438Z",
      • "alertName": "high",
      • "alertState": "activeAlarming",
      • "displayDevice": "receiver",
      • "transmitterGeneration": "g6",
      • "transmitterId": "d55d01d0341ed0ba2cd99b322e8c5b609254f47d10c7cd12b99b4922effeba44"
      }
    ]
}