Dexcom · Schema

AlertsResponse

AlertsResponse schema from Dexcom Developer API

Continuous Glucose MonitoringDiabetesDigital HealthGlucoseHealthcareMedical DevicesWearables

Properties

Name Type Description
recordType string
recordVersion string
userId string
records array
View JSON Schema on GitHub

JSON Schema

dexcom-api-alerts-response-schema.json Raw ↑
{
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "$id": "https://raw.githubusercontent.com/api-evangelist/dexcom/refs/heads/main/json-schema/dexcom-api-alerts-response-schema.json",
  "title": "AlertsResponse",
  "description": "AlertsResponse schema from Dexcom Developer API",
  "type": "object",
  "properties": {
    "recordType": {
      "type": "string",
      "example": "alert"
    },
    "recordVersion": {
      "type": "string",
      "example": "3.0"
    },
    "userId": {
      "type": "string"
    },
    "records": {
      "type": "array",
      "items": {
        "$ref": "#/$defs/AlertRecord"
      }
    }
  },
  "$defs": {
    "AlertRecord": {
      "type": "object",
      "properties": {
        "recordId": {
          "type": "string"
        },
        "systemTime": {
          "$ref": "#/$defs/DateTime"
        },
        "displayTime": {
          "$ref": "#/$defs/DateTime"
        },
        "alertName": {
          "$ref": "#/$defs/AlertName"
        },
        "alertState": {
          "$ref": "#/$defs/AlertState"
        },
        "displayDevice": {
          "type": "string"
        },
        "transmitterGeneration": {
          "$ref": "#/$defs/TransmitterGeneration"
        },
        "transmitterId": {
          "type": "string",
          "nullable": true
        }
      }
    },
    "TransmitterGeneration": {
      "type": "string",
      "enum": [
        "unknown",
        "g4",
        "g5",
        "g6",
        "g6+",
        "dexcomPro",
        "g7"
      ]
    },
    "AlertName": {
      "type": "string",
      "enum": [
        "unknown",
        "high",
        "low",
        "rise",
        "fall",
        "outOfRange",
        "urgentLow",
        "urgentLowSoon",
        "noReadings",
        "fixedLow"
      ]
    },
    "AlertState": {
      "type": "string",
      "enum": [
        "unknown",
        "inactive",
        "activeSnoozed",
        "activeAlarming"
      ]
    },
    "DateTime": {
      "type": "string",
      "format": "date-time",
      "description": "ISO 8601 timestamp."
    }
  }
}