calibrations

Description

The /calibrations endpoint enables retrieval of a user's calibration events. Calibration events are where the user enters the glucose value that they obtain from testing a fingerstick blood sample with their blood glucose meter into the CGM. These readings are used as a reference point for calculating EGV from the sensor signal. Calibration Mobile App Screen

Resource

GET /v3/users/self/calibrations

Authorization

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

Notes

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

  • unknown
  • mg/dL
  • mmol/L

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 /calibrations endpoint and will return an empty array.

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

Beginning of the time window; see the discussion of time in the Endpoint Overview section for more details on how they relate to device information

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

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

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.calibration.Calibration)

Array of calibrations. This field will display an empty array in case of no calibrations.

Array
recordId
required
string

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

unit
string or null

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.

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.

value
required
integer <int32>

Calibration value entered by the user. Example: 86

displayDevice
required
string

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

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.

transmitterTicks
required
integer <int64>

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

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/calibrations
Request samples
curl -i -X GET \
  'https://api.dexcom.com/v3/users/self/calibrations?startDate=2023-01-01T09%3A12%3A35&endDate=2023-01-01T09%3A12%3A35' \
  -H 'Authorization: Bearer <YOUR_TOKEN_HERE>'
Response samples
application/json
{
  • "recordType": "calibrations",
  • "recordVersion": "3.0",
  • "userId": "5b329ebcfbf2f0ba7e49d4c5eb57775468f5ee657ac16fcde07e1fd08197b4c7",
  • "records": [
    • {
      • "recordId": "763923b7-5424-451e-b37d-fd8ff635b308",
      • "systemTime": "2022-06-17T03:59:11",
      • "displayTime": "2022-06-16T19:59:11",
      • "unit": "mg/dL",
      • "value": 124,
      • "displayDevice": "android",
      • "transmitterId": "d55d01d0341ed0ba2cd99b322e8c5b609254f47d10c7cd12b99b4922effeba44",
      • "transmitterTicks": 72364324786,
      • "transmitterGeneration": "g6"
      }
    ]
}