Returns a list of time series CGM data for a given user.

Request Information

Request Parameters

NameRequired FieldTypeDescription
start_dateoptionalstringThe start date to retrieve user data for. Format: YYYY-MM-DD. Default is current UTC day. Max date range is 30 days.
end_dateoptionalstringThe end date to retrieve user data for. Format: YYYY-MM-DD. Default is current UTC day. Max date range is 30 days.
sourceoptionalstringUsed to filter records to source(s).
Example:
“...?source=abbott,dexcom”
or
“...?source=dexcom”

HTTP Response Status

Response CodeDescription
200 (Ok)Indicates the request was received and a result was returned.
400 (Bad Request)Indicates that there was an error with request

Field Description

NameTypeDescription
versionstringIndicates the resource payload version. Validic will make future updates to the structure of the resource payload where breaking changes will receive a new version.
idstringUnique identifier for the record.
checksumstringA derived value useful when comparing records with the same id for data updates.
typestringThe Validic Resource type. For Intraday records the type will be cgm.
start_timestringThe start time of the event represented in UTC. Format: YYYY-MM-DDThh:mm:ssZ.
end_timestringThe end time of the event represented in UTC. Format: YYYY-MM-DDThh:mm:ssZ.
utc_offsetintegerThe offset in seconds from UTC.
offset_originstringThe source of the UTC offset. Valid values: source (UTC offset received from the original record), profile (UTC offset received from the source's user profile), user_defined (UTC offset provided by user's time zone selection upon authorization through the Validic Marketplace)
userobjectA User object that contains identifiers related to the user.
user>uidstringThe customer's user ID.
user>user_idstringValidic user ID.
user>organization_idstringValidic organization ID.
log_idstringThe unique identifier for the record provided by the source.
sourcestringA source object that contains source specific information.
source>typestringThe source Validic retrieved the data from.source>type
source>devicesobjectA devices object containing information about the devices that generated the data if available.
source>device>idstringThe name of the device.
source>device>manufacturerstringThe manufacturer of the device.
source>device>modelstringThe model of the device.
metricsarrayAn array of Metrics. Refer to the Metrics documentation for further information.
metrics>typestringThe type of metric being reported.
metrics>unitstringThe unit of the metric being reported.
metrics>originstringThe source of the metric. Valid values: device the data source indicated this metric was generated by the device, manual the data source indicated this metric was manually entered, unknown the data source did not indicate an origin for this metric.
metrics>reading_logarrayAn array of times series readings for the given metric.
metrics>reading_log>timestringUTC timestamp for the data point.
metrics>reading_log>valuestringValue for the metric for a specific time series reading.
metrics>reading_log>display_timestringUser local timestamp for the data point if available from the source.
metrics>reading_log>device_idstringSource device identifier for the cgm that captured the reading if available from the source.
metrics>reading_log>scheduledbooleanIndicates the specific time series data point is from a scan pre-scheduled by the sensor/receiver if available from the source.
metrics>reading_log>new_sensorbooleanIndicates whether the reading is the first after a sensor change if available from the source.
created_atstringThe record processed time represented in UTC. Format: YYYY-MM-DDThh:mm:ssZ.

Additional Code Samples

{
  "type": "cgm",
  "checksum": "51502ff934e3b47b3df8284494f814b8",
  "created_at": "2024-09-05T18:23:33.220Z",
  "deleted_at": null,
  "end_time": "2024-09-04T23:59:59Z",
  "id": "7db302193cc6b9b80405f189be67b9c8",
  "log_id": "2024-09-04",
  "metrics": [
    {
      "origin": "device",
      "type": "blood_glucose",
      "unit": "mg/dL",
      "reading_log": [
        {
          "time": "2024-09-04T01:04:48Z",
          "value": 204,
          "display_time": "2024-09-04T07:04:48-08:00",
          "scheduled": true,
          "device_id": "cdb4f8eea4392295413c64..."
        },
        {
          "time": "2024-09-04T01:09:48Z",
          "value": 197,
          "display_time": "2024-09-04T07:09:48-08:00",
          "scheduled": true,
          "device_id": "69bbc1b66cfe49597c5eff1376..."
        }
      ]
    }
  ],
  "source": {
    "type": "dexcom",
    "devices": {
      "cdb4f8eea4392295413c64...": {
        "id": "cdb4f8eea4392295413c64...",
        "manufacturer": "Dexcom",
        "model": "G7"
      },
      "69bbc1b66cfe49597c5eff1376...": {
        "id": "69bbc1b66cfe49597c5eff1376...",
        "manufacturer": "Dexcom",
        "model": "G7"
      }
    }
  },
  "start_time": "2024-09-04T00:00:00Z",
  "tags": [],
  "user": {
    "organization_id": "6584a3e40f32d5000fc254a7",
    "uid": "7fd835687f1f41ed8b125ca0ebfeaeb8",
    "user_id": "66be73022d30800011ae066e"
  },
  "user_notes": [],
  "utc_offset": -18000,
  "offset_origin": "user_defined",
  "version": "1.0"
}
{
  "type": "cgm",
  "checksum": "51502ff934e3b47b3df8284494f814b8",
  "created_at": "2024-09-05T18:23:33.220Z",
  "deleted_at": null,
  "end_time": "2024-09-04T23:59:59Z",
  "id": "7db302193cc6b9b80405f189be67b9c8",
  "log_id": "2024-09-04",
  "metrics": [
    {
      "origin": "device",
      "type": "blood_glucose",
      "unit": "mg/dL",
      "reading_log": [
        {
          "time": "2024-09-04T01:04:48Z",
          "value": 204,
          "display_time": "2024-09-04T07:04:48-08:00",
          "scheduled": true,
          "device_id": "cdb4f8eea4392295413c64...",
          "new_sensor": false
        },
        {
          "time": "2024-09-04T01:09:48Z",
          "value": 197,
          "display_time": "2024-09-04T07:09:48-08:00",
          "scheduled": true,
          "device_id": "abc5jfskd38493842...",
          "new_sensor": true
        }
      ]
    }
  ],
  "source": {
    "type": "abbott",
    "devices": {
      "cdb4f8eea4392295413c64...": {
        "id": "cdb4f8eea4392295413c64...",
        "manufacturer": "Abbott",
        "model": "freestylelibre2"
      },
      "abc5jfskd38493842...": {
        "id": "abc5jfskd38493842...",
        "manufacturer": "Abbott",
        "model": "freestylelibre3"
      }
    }
  },
  "start_time": "2024-09-04T00:00:00Z",
  "tags": [],
  "user": {
    "organization_id": "6584a3e40f32d5000fc254a7",
    "uid": "7fd835687f1f41ed8b125ca0ebfeaeb8",
    "user_id": "66be73022d30800011ae066e"
  },
  "user_notes": [],
  "utc_offset": -18000,
  "offset_origin": "user_defined",
  "version": "1.0"
}
Language
Credentials
Query
Click Try It! to start a request and see the response here!