{"items":[{"type":"link","label":"Alerts API","link":"/reference/alerts.v1","routeSlug":"/reference/alerts.v1","content":{"contentType":"overview","meta":{"name":"Alerts API"},"children":[{"nodeType":"container","panels":[{"title":"Download OpenAPI description","titleTranslationKey":"download.description.title","children":[{"kind":"download","label":"alerts.v1.json","url":"/_bundle/reference/alerts.v1.json?download"},{"kind":"download","label":"alerts.v1.yaml","url":"/_bundle/reference/alerts.v1.yaml?download"}]},{"title":"Overview","titleTranslationKey":"info.title","children":[{"kind":"externallink","title":"URL","titleTranslationKey":"info.contact.url","label":"https://support.tidepool.org/","url":"https://support.tidepool.org/"},{"kind":"email","title":"API Support","email":"support@tidepool.org","label":"support@tidepool.org","withCopyButton":true,"copyContent":"support@tidepool.org"},{"kind":"externallink","title":"License","titleTranslationKey":"info.license","label":"BSD-2-Clause","url":"https://github.com/tidepool-org/hydrophone/blob/master/LICENSE"},{"kind":"externallink","label":"Terms of Service","labelTranslationKey":"info.termsOfService","url":"https://developer.tidepool.org/terms-of-use/"}]},{"title":"Languages","titleTranslationKey":"languages.title","children":[{"kind":"languages","options":[{"key":"curl","title":"curl","lang":"curl"},{"key":"javascript","title":"JavaScript","lang":"JavaScript"},{"key":"node","title":"Node.js","lang":"Node.js"},{"key":"python","title":"Python","lang":"Python"},{"key":"java","title":"Java","lang":"Java"},{"key":"csharp","title":"C#","lang":"C#"},{"key":"php","title":"PHP","lang":"PHP"},{"key":"go","title":"Go","lang":"Go"},{"key":"ruby","title":"Ruby","lang":"Ruby"},{"key":"r","title":"R","lang":"R"},{"key":"payload","title":"Payload","lang":"Payload"}]}]},{"title":"Servers","titleTranslationKey":"servers.title","children":[{"kind":"servers","servers":[{"url":"/_mock/reference/alerts.v1","description":"Mock server","isMockServer":true},{"url":"https://external.integration.tidepool.org","description":"integration"},{"url":"https://api.tidepool.org","description":"production"},{"url":"https://dev1.dev.tidepool.org","description":"dev1"},{"url":"https://qa1.development.tidepool.org","description":"qa1"},{"url":"https://qa2.development.tidepool.org","description":"qa2"}],"mode":"default"}]}],"children":[{"nodeType":"overview-section-wrapper","children":[{"nodeType":"header","level":1,"label":"Alerts API (1.0)","showPageActions":true},{"nodeType":"overview-section-wrapper","children":[{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The Tidepool API is an HTTP REST API used by Tidepool clients to communicate with the Tidepool Platform."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"For more information, see the "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"/docs/quick-start"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Getting Started"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" section."},"children":[]}]}]}]}],"sectionId":"/reference/alerts.v1"}],"sectionId":"/reference/alerts.v1"}]}]}},{"type":"group","label":"Alerts","link":"/reference/alerts.v1/alerts","routeSlug":"/reference/alerts.v1/alerts","items":[{"label":"Delete an alerts configuration","deprecated":false,"httpVerb":"delete","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/reference/alerts.v1/alerts/deletealertsconfiguration","routeSlug":"/reference/alerts.v1/alerts/deletealertsconfiguration","metadata":{"seo":{"title":"Delete an alerts configuration","description":"Delete an existing alerts configuration."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"DeleteAlertsConfiguration","name":"Delete an alerts configuration","isWebhook":false,"pointer":"/paths/~1v1~1users~1{userId}~1followers~1{followerUserId}~1alerts/delete","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Delete an alerts configuration","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"Delete an existing alerts configuration."},{"nodeType":"security","requirements":[{"schemes":[{"name":"sessionToken","scopes":[],"type":"apiKey","in":"header","paramName":"X-Tidepool-Session-Token","description":"Tidepool Session Token"}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"userId","in":"path","schemaId":"schema_95","description":"Tidepool User ID of the user who granted follow access.","required":true},{"name":"followerUserId","in":"path","schemaId":"schema_95","description":"Tidepool User ID of the care partner to receive alerts.","required":true}],"pointer":"/paths/~1v1~1users~1{userId}~1followers~1{followerUserId}~1alerts/delete/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"DELETE","path":"/v1/users/{userId}/followers/{followerUserId}/alerts","servers":[{"url":"/_mock/reference/alerts.v1","description":"Mock server","isMockServer":true},{"url":"https://external.integration.tidepool.org","description":"integration"},{"url":"https://api.tidepool.org","description":"production"},{"url":"https://dev1.dev.tidepool.org","description":"dev1"},{"url":"https://qa1.development.tidepool.org","description":"qa1"},{"url":"https://qa2.development.tidepool.org","description":"qa2"}],"parameters":{"path":[{"name":"userId","in":"path","required":true,"schemaId":"components/schemas/tidepoolUserId"},{"name":"followerUserId","in":"path","required":true,"schemaId":"components/schemas/tidepoolUserId"}],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"sessionToken","type":"apiKey","name":"X-Tidepool-Session-Token","in":"header"}],"scopes":[]}],"responseCodes":["200","400","401","403","404","500"],"pointer":"/v1/users/{userId}/followers/{followerUserId}/alerts","href":"alerts/deletealertsconfiguration","openApiOperationId":"DeleteAlertsConfiguration","summary":"Delete an alerts configuration"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/reference/alerts.v1","description":"Mock server","isMockServer":true},{"url":"https://external.integration.tidepool.org","description":"integration"},{"url":"https://api.tidepool.org","description":"production"},{"url":"https://dev1.dev.tidepool.org","description":"dev1"},{"url":"https://qa1.development.tidepool.org","description":"qa1"},{"url":"https://qa2.development.tidepool.org","description":"qa2"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"OK"},{"code":"400","description":"Bad Request"},{"code":"401","description":"Unauthorized"},{"code":"403","description":"Forbidden"},{"code":"404","description":"Not Found"},{"code":"500","description":"Server Error"}],"pointer":"/paths/~1v1~1users~1{userId}~1followers~1{followerUserId}~1alerts/delete/responses"}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/alerts/deletealertsconfiguration"}],"panels":[]}]},"httpPath":"/v1/users/{userId}/followers/{followerUserId}/alerts"},{"label":"Get an alerts configuration","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/reference/alerts.v1/alerts/getalertsconfiguration","routeSlug":"/reference/alerts.v1/alerts/getalertsconfiguration","metadata":{"seo":{"title":"Get an alerts configuration","description":"Retrieve an existing alerts configuration."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"GetAlertsConfiguration","name":"Get an alerts configuration","isWebhook":false,"pointer":"/paths/~1v1~1users~1{userId}~1followers~1{followerUserId}~1alerts/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Get an alerts configuration","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"Retrieve an existing alerts configuration."},{"nodeType":"security","requirements":[{"schemes":[{"name":"sessionToken","scopes":[],"type":"apiKey","in":"header","paramName":"X-Tidepool-Session-Token","description":"Tidepool Session Token"}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"userId","in":"path","schemaId":"schema_95","description":"Tidepool User ID of the user who granted follow access.","required":true},{"name":"followerUserId","in":"path","schemaId":"schema_95","description":"Tidepool User ID of the care partner to receive alerts.","required":true}],"pointer":"/paths/~1v1~1users~1{userId}~1followers~1{followerUserId}~1alerts/get/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/v1/users/{userId}/followers/{followerUserId}/alerts","servers":[{"url":"/_mock/reference/alerts.v1","description":"Mock server","isMockServer":true},{"url":"https://external.integration.tidepool.org","description":"integration"},{"url":"https://api.tidepool.org","description":"production"},{"url":"https://dev1.dev.tidepool.org","description":"dev1"},{"url":"https://qa1.development.tidepool.org","description":"qa1"},{"url":"https://qa2.development.tidepool.org","description":"qa2"}],"parameters":{"path":[{"name":"userId","in":"path","required":true,"schemaId":"components/schemas/tidepoolUserId"},{"name":"followerUserId","in":"path","required":true,"schemaId":"components/schemas/tidepoolUserId"}],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"sessionToken","type":"apiKey","name":"X-Tidepool-Session-Token","in":"header"}],"scopes":[]}],"responseCodes":["200","400","401","403","404","500"],"pointer":"/v1/users/{userId}/followers/{followerUserId}/alerts","href":"alerts/getalertsconfiguration","openApiOperationId":"GetAlertsConfiguration","summary":"Get an alerts configuration"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/reference/alerts.v1","description":"Mock server","isMockServer":true},{"url":"https://external.integration.tidepool.org","description":"integration"},{"url":"https://api.tidepool.org","description":"production"},{"url":"https://dev1.dev.tidepool.org","description":"dev1"},{"url":"https://qa1.development.tidepool.org","description":"qa1"},{"url":"https://qa2.development.tidepool.org","description":"qa2"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"Alerts Config","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_96"}},"schemaId":"schema_96"},{"code":"400","description":"Bad Request"},{"code":"401","description":"Unauthorized"},{"code":"403","description":"Forbidden"},{"code":"404","description":"Not Found"},{"code":"500","description":"Server Error"}],"pointer":"/paths/~1v1~1users~1{userId}~1followers~1{followerUserId}~1alerts/get/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"schema_96","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_96"}}},{"code":"400"},{"code":"401"},{"code":"403"},{"code":"404"},{"code":"500"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/alerts/getalertsconfiguration"}],"panels":[]}]},"httpPath":"/v1/users/{userId}/followers/{followerUserId}/alerts"},{"label":"Create or update an alerts configuration","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/reference/alerts.v1/alerts/upsertalertsconfiguration","routeSlug":"/reference/alerts.v1/alerts/upsertalertsconfiguration","metadata":{"seo":{"title":"Create or update an alerts configuration","description":"Create or update an alerts configuration. If no alerts configuration exists, it will be created."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"UpsertAlertsConfiguration","name":"Create or update an alerts configuration","isWebhook":false,"pointer":"/paths/~1v1~1users~1{userId}~1followers~1{followerUserId}~1alerts/post","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Create or update an alerts configuration","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"Create or update an alerts configuration.\nIf no alerts configuration exists, it will be created."},{"nodeType":"security","requirements":[{"schemes":[{"name":"sessionToken","scopes":[],"type":"apiKey","in":"header","paramName":"X-Tidepool-Session-Token","description":"Tidepool Session Token"}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"userId","in":"path","schemaId":"schema_95","description":"Tidepool User ID of the user who granted follow access.","required":true},{"name":"followerUserId","in":"path","schemaId":"schema_95","description":"Tidepool User ID of the care partner to receive alerts.","required":true}],"pointer":"/paths/~1v1~1users~1{userId}~1followers~1{followerUserId}~1alerts/post/parameters"},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","required":true,"mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/alertsconfig.v1"}},"schemaId":"components/schemas/alertsconfig.v1","pointer":"/paths/~1v1~1users~1{userId}~1followers~1{followerUserId}~1alerts/post/requestBody"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"POST","path":"/v1/users/{userId}/followers/{followerUserId}/alerts","servers":[{"url":"/_mock/reference/alerts.v1","description":"Mock server","isMockServer":true},{"url":"https://external.integration.tidepool.org","description":"integration"},{"url":"https://api.tidepool.org","description":"production"},{"url":"https://dev1.dev.tidepool.org","description":"dev1"},{"url":"https://qa1.development.tidepool.org","description":"qa1"},{"url":"https://qa2.development.tidepool.org","description":"qa2"}],"parameters":{"path":[{"name":"userId","in":"path","required":true,"schemaId":"components/schemas/tidepoolUserId"},{"name":"followerUserId","in":"path","required":true,"schemaId":"components/schemas/tidepoolUserId"}],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"sessionToken","type":"apiKey","name":"X-Tidepool-Session-Token","in":"header"}],"scopes":[]}],"requestBody":{"application/json":{"schemaId":"components/schemas/alertsconfig.v1"}},"responseCodes":["200","400","401","403","404","500"],"pointer":"/v1/users/{userId}/followers/{followerUserId}/alerts","href":"alerts/upsertalertsconfiguration","openApiOperationId":"UpsertAlertsConfiguration","summary":"Create or update an alerts configuration"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/reference/alerts.v1","description":"Mock server","isMockServer":true},{"url":"https://external.integration.tidepool.org","description":"integration"},{"url":"https://api.tidepool.org","description":"production"},{"url":"https://dev1.dev.tidepool.org","description":"dev1"},{"url":"https://qa1.development.tidepool.org","description":"qa1"},{"url":"https://qa2.development.tidepool.org","description":"qa2"}],"schemaId":"components/schemas/alertsconfig.v1","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/alertsconfig.v1"}},"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"OK"},{"code":"400","description":"Bad Request"},{"code":"401","description":"Unauthorized"},{"code":"403","description":"Forbidden"},{"code":"404","description":"Not Found"},{"code":"500","description":"Server Error"}],"pointer":"/paths/~1v1~1users~1{userId}~1followers~1{followerUserId}~1alerts/post/responses"}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/alerts/upsertalertsconfiguration"}],"panels":[]}]},"httpPath":"/v1/users/{userId}/followers/{followerUserId}/alerts"}],"content":{"contentType":"group","meta":{"name":"Alerts"},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Alerts","showPageActions":true},{"nodeType":"markdoc","content":"Endpoints related to alert configuration and management."}],"panels":[{"children":[{"kind":"group-items","title":"Operations","titleTranslationKey":"operations","items":[{"title":"/v1/users/{userId}/followers/{followerUserId}/alerts","summary":"Delete an alerts configuration","prefix":{"name":"delete","color":"delete"},"badges":[],"link":"/alerts/deletealertsconfiguration","deprecated":false},{"title":"/v1/users/{userId}/followers/{followerUserId}/alerts","summary":"Get an alerts configuration","prefix":{"name":"get","color":"get"},"badges":[],"link":"/alerts/getalertsconfiguration","deprecated":false},{"title":"/v1/users/{userId}/followers/{followerUserId}/alerts","summary":"Create or update an alerts configuration","prefix":{"name":"post","color":"post"},"badges":[],"link":"/alerts/upsertalertsconfiguration","deprecated":false}]}]}]}]}}],"store":{"schemaStore":{"components/schemas/tidepoolUserId":{"id":"components/schemas/tidepoolUserId","kind":"json-schema","title":"Tidepool User ID","data":{"type":"string","title":"Tidepool User ID","pattern":"^([0-9a-f]{10}|[0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{12})$","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"String representation of a Tidepool User ID. Old style IDs are 10-digit strings consisting of only hexadeximcal digits. New style IDs are 36-digit "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://en.wikipedia.org/wiki/Universally_unique_identifier#Version_4_(random)"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"UUID v4"},"children":[]}]}]}]}],"readOnly":true,"x-go-type":"string"}},"components/schemas/alertsConfigReadOnly":{"id":"components/schemas/alertsConfigReadOnly","kind":"json-schema","title":"alertsConfigReadOnly","data":{"type":"object","properties":{"uploadId":{"$ref":"#/components/schemas/uploadid.v1"},"userId":{"$ref":"#/components/schemas/tidepooluserid"},"followedUserId":{"$ref":"#/components/schemas/tidepooluserid"}}}},"components/schemas/tidepooluserid":{"id":"components/schemas/tidepooluserid","kind":"json-schema","title":"Tidepool User ID","data":{"type":"string","title":"Tidepool User ID","pattern":"^([0-9a-f]{10}|[0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{12})$","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"String representation of a Tidepool User ID. Old style IDs are 10-digit strings consisting of only hexadeximcal digits. New style IDs are 36-digit "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://en.wikipedia.org/wiki/Universally_unique_identifier#Version_4_(random)"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"UUID v4"},"children":[]}]}]}]}],"readOnly":true,"x-go-type":"string"}},"components/schemas/uploadid.v1":{"id":"components/schemas/uploadid.v1","kind":"json-schema","title":"Upload ID","data":{"title":"Upload ID","description":"An upload identifier; this field should be the uploadId of the corresponding upload record","type":"string","pattern":"^([0-9a-f]{32}|upid_[0-9a-f]{12})$","minLength":17,"maxLength":32,"example":"0d92d5c1c22117a18f3620b9e24d3c06","x-tags":["Data"]}},"components/schemas/base.v1":{"id":"components/schemas/base.v1","kind":"json-schema","title":"base.v1","data":{"type":"object","properties":{"enabled":{"type":"boolean","default":false,"description":"A toggle for disabling the alert."}}}},"components/schemas/unitsmgdl.v1":{"id":"components/schemas/unitsmgdl.v1","kind":"json-schema","title":"Blood Unit (mg/dL)","data":{"title":"Blood Unit (mg/dL)","type":"string","enum":["mg/dL","mg/dl"],"example":"mg/dL","x-tags":["Data"]}},"components/schemas/valuemgdl.v1":{"id":"components/schemas/valuemgdl.v1","kind":"json-schema","title":"Blood Value (mg/dL)","data":{"title":"Blood Value (mg/dL)","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"An integer value representing a "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"mg/dL"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" value."},"children":[]}]}]}],"type":"integer","format":"int32","minimum":0,"maximum":1000,"example":105,"x-tags":["Data"]}},"components/schemas/glucosemgdl.v1":{"id":"components/schemas/glucosemgdl.v1","kind":"json-schema","title":"Blood Glucose (mg/dL)","data":{"title":"Blood Glucose (mg/dL)","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Blood glucose value, in "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"mg/dL"},"children":[]}]}]}],"type":"object","properties":{"units":{"$ref":"#/components/schemas/unitsmgdl.v1"},"value":{"$ref":"#/components/schemas/valuemgdl.v1"}},"required":["units","value"],"x-tags":["Data"]}},"components/schemas/unitsmmol.v1":{"id":"components/schemas/unitsmmol.v1","kind":"json-schema","title":"Blood Unit (mmol/L)","data":{"title":"Blood Unit (mmol/L)","type":"string","enum":["mmol/L","mmol/l"],"example":"mmol/L","x-tags":["Data"]}},"components/schemas/valuemmol.v1":{"id":"components/schemas/valuemmol.v1","kind":"json-schema","title":"Blood Value (mmol/L)","data":{"title":"Blood Value (mmol/L)","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"A floating point value representing a "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"mmol/L"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" value."},"children":[]}]}]}],"type":"number","format":"float","minimum":0,"example":5.5,"x-tags":["Data"]}},"components/schemas/glucosemmol.v1":{"id":"components/schemas/glucosemmol.v1","kind":"json-schema","title":"Blood Glucose (mmol/L)","data":{"title":"Blood Glucose (mmol/L)","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Blood glucose value, in "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"mmol/L"},"children":[]}]}]}],"type":"object","properties":{"units":{"$ref":"#/components/schemas/unitsmmol.v1"},"value":{"$ref":"#/components/schemas/valuemmol.v1"}},"required":["units","value"],"x-tags":["Data"]}},"components/schemas/glucose.v1":{"id":"components/schemas/glucose.v1","kind":"json-schema","title":"Blood Glucose","data":{"title":"Blood Glucose","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Blood glucose value, in "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"mg/dL"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" or "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"mmol/L"},"children":[]}]}]}],"oneOf":[{"$ref":"#/components/schemas/glucosemgdl.v1"},{"$ref":"#/components/schemas/glucosemmol.v1"}],"x-tags":["Data"]}},"components/schemas/glucosethreshold.v1":{"id":"components/schemas/glucosethreshold.v1","kind":"json-schema","title":"glucosethreshold.v1","data":{"type":"object","properties":{"threshold":{"$ref":"#/components/schemas/glucose.v1"}},"required":["threshold"]}},"components/schemas/delay.v1":{"id":"components/schemas/delay.v1","kind":"json-schema","title":"delay.v1","data":{"type":"object","properties":{"delay":{"type":"integer","default":0,"minimum":0,"maximum":120,"description":"Duration in minutes to wait before alerting."}}}},"components/schemas/repeat.v1":{"id":"components/schemas/repeat.v1","kind":"json-schema","title":"repeat.v1","data":{"type":"object","properties":{"repeat":{"type":"integer","default":0,"minimum":0,"maximum":240,"description":"Duration in minutes, after which an alert will be repeated.\nA value of 0 disables the repeat functionality."}}}},"components/schemas/alertsconfig.v1":{"id":"components/schemas/alertsconfig.v1","kind":"json-schema","title":"alertsconfig.v1","data":{"type":"object","properties":{"urgentLow":{"allOf":[{"$ref":"#/components/schemas/base.v1"},{"$ref":"#/components/schemas/glucosethreshold.v1"},{"type":"object","description":"Blood glucose measurements at or below this value will trigger an immediate and urgent alert."}]},"low":{"allOf":[{"$ref":"#/components/schemas/base.v1"},{"$ref":"#/components/schemas/delay.v1"},{"$ref":"#/components/schemas/repeat.v1"},{"$ref":"#/components/schemas/glucosethreshold.v1"},{"type":"object","description":"Blood glucose measurements at or below this value will trigger an alert."}]},"high":{"allOf":[{"$ref":"#/components/schemas/base.v1"},{"$ref":"#/components/schemas/delay.v1"},{"$ref":"#/components/schemas/repeat.v1"},{"$ref":"#/components/schemas/glucosethreshold.v1"},{"type":"object","description":"Blood glucose measurements at or above this value will trigger an alert."}]},"noCommunication":{"allOf":[{"$ref":"#/components/schemas/base.v1"},{"$ref":"#/components/schemas/delay.v1"},{"type":"object","description":"An alert sent when issues prevent the display of CGM data."}]},"notLooping":{"allOf":[{"$ref":"#/components/schemas/base.v1"},{"$ref":"#/components/schemas/delay.v1"},{"type":"object","description":"An alert sent when the Tidepool Loop app is unable to loop."}]}},"minProperties":1,"description":"Configuration for alerts triggered in response to the status of a user's device and data."}},"schema_95":{"kind":"json-schema","data":{"$ref":"#/components/schemas/tidepooluserid"},"id":"schema_95"},"schema_96":{"kind":"json-schema","data":{"allOf":[{"$ref":"#/components/schemas/alertsConfigReadOnly"},{"$ref":"#/components/schemas/alertsconfig.v1"}]},"id":"schema_96"}},"exampleStore":{},"securitySchemeStore":{"sessionToken":{"id":"sessionToken","type":"apiKey","description":"Tidepool Session Token","in":"header","paramName":"X-Tidepool-Session-Token"}},"servers":[{"url":"/_mock/reference/alerts.v1","isMockServer":true,"description":"Mock server"},{"url":"https://external.integration.tidepool.org","description":"integration"},{"url":"https://api.tidepool.org","description":"production"},{"url":"https://dev1.dev.tidepool.org","description":"dev1"},{"url":"https://qa1.development.tidepool.org","description":"qa1"},{"url":"https://qa2.development.tidepool.org","description":"qa2"}]},"options":{"hideInfoMetadata":true,"hideSidebar":true,"mockServer":{"url":"/_mock/reference/alerts.v1","position":"first","description":"Mock server"},"disableRouter":true,"downloadUrls":[{"url":"/_bundle/reference/alerts.v1.json?download"},{"url":"/_bundle/reference/alerts.v1.yaml?download"}],"excludeFromSearch":false,"specType":"openapi","markdocOptions":{"tags":{},"nodes":{},"components":{}},"metadata":{"title":"Alerts API","description":"The Tidepool API is an HTTP REST API used by Tidepool clients to communicate with the Tidepool Platform.\n\nFor more information, see the [Getting Started](../docs/quick-start.md) section."}},"baseSlug":"/reference/alerts.v1","routesMapping":{}}