alerts

Description

The /alerts endpoint enables retrieval of user alert records within a provided date range. This includes alerts triggered on the mobile app or receiver.

The alert events can be related to glucose values such as high or low, or system alerts such as noReadings or outOfRange (signal loss)

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.

Dexcom ONE+ does not support the following alerts: Urgent Low, Urgent Low Soon, Rising Fast, Falling Fast.

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

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

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.alert.AlertEvent)

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

Array
recordId
required
string

A unique id (UUID) that identifies the alert.

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.

alertName
required
string

The name of the alert.

Enum: "unknown" "high" "low" "rise" "fall" "outOfRange" "urgentLow" "urgentLowSoon" "noReadings" "fixedLow"
alertState
required
string

The state of the alert.

Enum: "unknown" "inactive" "activeSnoozed" "activeAlarming"
displayDevice
required
string

The type of display device the alert 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"
transmitterId
required
string

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.

displayApp
required
string

App that is installed on the display device. For example, G6, G7, DexcomOne, D1G7.

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"
      }
    ]
}