events

Description

The /events endpoint enables retrieval of a user's event records. This includes carbohydrate intake, insulin doses, exercise, and health events that are entered in the receiver interface or through the mobile app. Event Mobile App Screen

Resource

GET /v3/users/self/events

Authorization

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

Notes

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

  • unknown
  • grams
  • mg/dL
  • minutes
  • units

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=2023-01-01T09:12:35
endDate
required
string <date-time>

End of the time window.

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.event.Event)
Array
systemTime
required
string <date-time>
displayTime
required
string <date-time>
recordId
required
string
eventStatus
required
string
Enum: "created" "updated" "deleted"
eventType
required
string
Enum: "unknown" "insulin" "carbs" "exercise" "health" "bloodGlucose" "notes"
eventSubType
string or null
Enum: "unknown" null "fastActing" "longActing" "light" "medium" "heavy" "illness" "stress" "highSymptoms" "lowSymptoms" "cycle" "alcohol"
value
required
string
unit
string or null

Please see Notes section above for more information on enumeration values

transmitterId
required
string
transmitterGeneration
required
string
Enum: "unknown" "g4" "g5" "g6" "g6+" "dexcomPro" "g7"
displayDevice
required
string
get/v3/users/self/events
Request samples
curl -i -X GET \
  'https://api.dexcom.com/v3/users/self/events?startDate=2023-01-01T09%3A12%3A35&endDate=2023-01-01T09%3A12%3A35' \
  -H 'Authorization: Bearer <YOUR_TOKEN_HERE>'
Response samples
application/json
{
  • "recordType": "events",
  • "recordVersion": "3.0",
  • "userId": "5b329ebcfbf2f0ba7e49d4c5eb57775468f5ee657ac16fcde07e1fd08197b4c7",
  • "records": [
    • {
      • "recordId": "763923b7-5424-451e-b37d-fd8ff635b308",
      • "systemTime": "2022-02-06T09:12:35+00:00",
      • "displayTime": "2022-02-06T01:12:35-08:00",
      • "eventStatus": "created",
      • "eventType": "insulin",
      • "eventSubType": "longActing",
      • "value": 400,
      • "unit": "units",
      • "transmitterId": "d55d01d0341ed0ba2cd99b322e8c5b609254f47d10c7cd12b99b4922effeba44",
      • "transmitterGeneration": "g6",
      • "displayDevice": "android"
      }
    ]
}