APIs intended for internal use by Tidepool.
- Delete Data from Data Set
Data API (1.0)
The Tidepool API is an HTTP REST API used by Tidepool clients use to communicate with the Tidepool Platform.
For more information, see the Getting Started section.
https://tidepool.redocly.app/_mock/reference/data.v1/
https://external.integration.tidepool.org/
https://api.tidepool.org/
https://dev1.dev.tidepool.org/
https://qa1.development.tidepool.org/
https://qa2.development.tidepool.org/
- Alert
- Basal Automated
- Basal Scheduled
- Basal Suspend
- Basal Temporary
- Continuous Glucose
- Self Monitored Glucose
- Blood Ketone
- Bolus Automated
- Bolus Combination
- Bolus Extended
- Bolus Normal
- Bolus Calculator
- CGM Settings
- Controller Settings
- Controller Status
- Device Alarm
- Device Calibration
- Device Delivery Status
- Device Prime Event
- Device Pump Settings Override Event
- Device Reservoir Change
- DeviceSensorEvent [Proposed]
- Device Settings Change [Proposed]
- Device Time Change
- DeviceTransmitterEvent [Proposed]
- Dosing Decision
- Food
- Insulin
- Physical Activity
- Pump Settings
- Pump Status
- Reported State
- Settings
- Upload
- Water Consumption
An abstract base data type for all Tidepool diabetes data objects.
An array of annotations.
An array of associations for the resource.
Clock drift offset, expressed as milliseconds.
Conversion offset, expressed as milliseconds.
Globally unique to device and repeatable with each upload, e.g. device make and model with serial number
Location information associated with the resource. One or both of name
and gps
must be specified.
Grab bag field for data that isn't yet part of the data model. The maximum size is 4K bytes.
A string timezone name from the IANA timezone database
Time zone offset, expressed as positive or negative number of minutes from UTC.
Data type
An upload identifier; this field should be the uploadId of the corresponding upload record
- Mock server
https://tidepool.redocly.app/_mock/reference/data.v1/v1/data_sets/{dataSetId}/data
- integration
https://external.integration.tidepool.org/v1/data_sets/{dataSetId}/data
- production
https://api.tidepool.org/v1/data_sets/{dataSetId}/data
- dev1
https://dev1.dev.tidepool.org/v1/data_sets/{dataSetId}/data
- qa1
https://qa1.development.tidepool.org/v1/data_sets/{dataSetId}/data
- qa2
https://qa2.development.tidepool.org/v1/data_sets/{dataSetId}/data
- curl
- JavaScript
- Node.js
- Python
- Java
- C#
- PHP
- Go
- Ruby
- R
- Payload
curl -i -X POST \
https://tidepool.redocly.app/_mock/reference/data.v1/v1/data_sets/ce8cc5f7595575945f91fc6710db6fef/data \
-H 'Content-Type: application/json' \
-H 'X-Tidepool-Session-Token: YOUR_API_KEY_HERE' \
-d '[
{
"annotations": [
{
"code": "wrong-device-time"
}
],
"archivedDatasetId": "ce8cc5f7595575945f91fc6710db6fef",
"associations": [
{
"type": "blob",
"reason": "string",
"id": "string",
"url": "http://example.com"
}
],
"clockDriftOffset": 0,
"conversionOffset": 0,
"createdTime": "2017-02-06T02:37:46Z",
"deduplicator": {
"hash": "string",
"version": "2.36.1",
"name": "org.tidepool.uploader"
},
"deletedTime": "2017-02-06T02:37:46Z",
"deviceId": "MMT-1711:12345678",
"deviceTime": "2017-02-06T02:37:46",
"guid": "string",
"history": [
{
"time": "2017-02-06T02:37:46Z",
"changes": {
"op": "add",
"path": "string",
"value": null
}
}
],
"id": "ce8cc5f7595575945f91fc6710db6fef",
"location": {
"name": "string",
"gps": {
"origin": {
"id": "string",
"name": "string",
"payload": {},
"time": "2017-02-06T02:37:46Z",
"type": "device",
"version": "string"
},
"longitude": {
"units": "degrees",
"value": -122.1625595
},
"latitude": {
"units": "degrees",
"value": 37.4454404
},
"horizontalAccuracy": {
"value": 42,
"units": "meters"
},
"verticalAccuracy": {
"value": 42,
"units": "meters"
},
"floor": -1000,
"elevation": {
"units": "meters",
"value": 42
}
}
},
"modifiedTime": "2017-02-06T02:37:46Z",
"notes": [
"string"
],
"origin": {
"id": "string",
"name": "string",
"payload": {},
"time": "2017-02-06T02:37:46Z",
"type": "device",
"version": "string"
},
"payload": {},
"source": "carelink",
"tags": [
"string"
],
"time": "2017-02-06T02:37:46Z",
"timezone": "Europe/London",
"timezoneOffset": -420,
"type": "alert",
"uploadId": "0d92d5c1c22117a18f3620b9e24d3c06",
"name": "string",
"priority": "critical",
"trigger": "delayed",
"triggerDelay": 86400,
"sound": "name",
"soundName": "string",
"issuedTime": "2017-02-06T02:37:46Z",
"acknowledgedTime": "2017-02-06T02:37:46Z",
"retractedTime": "2017-02-06T02:37:46Z"
}
]'
Data List
- Alert
- Basal Automated
- Basal Scheduled
- Basal Suspend
- Basal Temporary
- Continuous Glucose
- Self Monitored Glucose
- Blood Ketone
- Bolus Automated
- Bolus Combination
- Bolus Extended
- Bolus Normal
- Bolus Calculator
- CGM Settings
- Controller Settings
- Controller Status
- Device Alarm
- Device Calibration
- Device Delivery Status
- Device Prime Event
- Device Pump Settings Override Event
- Device Reservoir Change
- DeviceSensorEvent [Proposed]
- Device Settings Change [Proposed]
- Device Time Change
- DeviceTransmitterEvent [Proposed]
- Dosing Decision
- Food
- Insulin
- Physical Activity
- Pump Settings
- Pump Status
- Reported State
- Settings
- Upload
- Water Consumption
An abstract base data type for all Tidepool diabetes data objects.
An array of annotations.
An array of associations for the resource.
Clock drift offset, expressed as milliseconds.
Conversion offset, expressed as milliseconds.
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 UUID v4
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 UUID v4
Globally unique to device and repeatable with each upload, e.g. device make and model with serial number
Location information associated with the resource. One or both of name
and gps
must be specified.
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 UUID v4
Grab bag field for data that isn't yet part of the data model. The maximum size is 4K bytes.
A string timezone name from the IANA timezone database
Time zone offset, expressed as positive or negative number of minutes from UTC.
Data type
An upload identifier; this field should be the uploadId of the corresponding upload record
[ { "annotations": [ … ], "archivedTime": "2017-02-06T02:37:46Z", "archivedDatasetId": "ce8cc5f7595575945f91fc6710db6fef", "associations": [ … ], "clockDriftOffset": 0, "conversionOffset": 0, "createdTime": "2017-02-06T02:37:46Z", "createdUserId": "string", "deduplicator": { … }, "deletedTime": "2017-02-06T02:37:46Z", "deletedUserId": "string", "deviceId": "MMT-1711:12345678", "deviceTime": "2017-02-06T02:37:46", "guid": "string", "history": [ … ], "id": "ce8cc5f7595575945f91fc6710db6fef", "location": { … }, "modifiedTime": "2017-02-06T02:37:46Z", "modifiedUserId": "string", "notes": [ … ], "origin": { … }, "payload": {}, "source": "carelink", "tags": [ … ], "time": "2017-02-06T02:37:46Z", "timezone": "Europe/London", "timezoneOffset": -420, "type": "alert", "uploadId": "0d92d5c1c22117a18f3620b9e24d3c06", "name": "string", "priority": "critical", "trigger": "delayed", "triggerDelay": 86400, "sound": "name", "soundName": "string", "issuedTime": "2017-02-06T02:37:46Z", "acknowledgedTime": "2017-02-06T02:37:46Z", "retractedTime": "2017-02-06T02:37:46Z" } ]
- Mock server
https://tidepool.redocly.app/_mock/reference/data.v1/v1/data_sets/{dataSetId}/data
- integration
https://external.integration.tidepool.org/v1/data_sets/{dataSetId}/data
- production
https://api.tidepool.org/v1/data_sets/{dataSetId}/data
- dev1
https://dev1.dev.tidepool.org/v1/data_sets/{dataSetId}/data
- qa1
https://qa1.development.tidepool.org/v1/data_sets/{dataSetId}/data
- qa2
https://qa2.development.tidepool.org/v1/data_sets/{dataSetId}/data
- curl
- JavaScript
- Node.js
- Python
- Java
- C#
- PHP
- Go
- Ruby
- R
- Payload
curl -i -X DELETE \
https://tidepool.redocly.app/_mock/reference/data.v1/v1/data_sets/ce8cc5f7595575945f91fc6710db6fef/data \
-H 'X-Tidepool-Session-Token: YOUR_API_KEY_HERE'
Upload ID. Search for data by uploadId
. Only objects with a uploadId
field matching the specified uploadId
parameter will be returned.
Device ID. Search for data by deviceId
. Only objects with a deviceId
field matching the specified uploadId
parameter will be returned.
Upload Type. The data type to search for. Only objects with a type
field matching the specified type
parameter will be returned. It can be a single value like /data/userid?type=smbg
or a comma separated list like /data/userid?type=smgb,cbg
. If is a comma separated list, then objects matching any of the types will be returned.
Sub Type. The data subtype to search for. Only objects with a subType
field matching the specified subType
parameter will be returned. It can be a single value like ?subtype=physicalactivity
or a comma separated list like ?subtypetype=physicalactivity,steps
. If it is a comma separated list, then objects matching any of the types will be returned.
Start Date. Only objects with time
field equal to or greater than start date will be returned. Must be in ISO 8601 date/time format e.g. 2015-10-10T15:00:00.000Z
.
End Date. Only objects with time
field less than to or equal to start date will be returned. Must be in ISO 8601 date/time format e.g. 2015-10-10T15:00:00.000Z
.
Latest Data. Returns only the most recent results for each type
matching the results filtered by the other query parameters.
- Mock server
https://tidepool.redocly.app/_mock/reference/data.v1/data/{userId}
- integration
https://external.integration.tidepool.org/data/{userId}
- production
https://api.tidepool.org/data/{userId}
- dev1
https://dev1.dev.tidepool.org/data/{userId}
- qa1
https://qa1.development.tidepool.org/data/{userId}
- qa2
https://qa2.development.tidepool.org/data/{userId}
- curl
- JavaScript
- Node.js
- Python
- Java
- C#
- PHP
- Go
- Ruby
- R
- Payload
curl -i -X GET \
'https://tidepool.redocly.app/_mock/reference/data.v1/data/{userId}?uploadId=0d92d5c1c22117a18f3620b9e24d3c06&deviceId=MMT-1711%3A12345678&type=cbg%2Csmbg&subType=scanned&startDate=2017-02-06T02%3A37%3A46Z&endDate=2017-02-06T02%3A37%3A46Z&latest=false&dexcom=false&carelink=false&medtronic=false' \
-H 'X-Tidepool-Session-Token: YOUR_API_KEY_HERE'
Data List
- Alert
- Basal Automated
- Basal Scheduled
- Basal Suspend
- Basal Temporary
- Continuous Glucose
- Self Monitored Glucose
- Blood Ketone
- Bolus Automated
- Bolus Combination
- Bolus Extended
- Bolus Normal
- Bolus Calculator
- CGM Settings
- Controller Settings
- Controller Status
- Device Alarm
- Device Calibration
- Device Delivery Status
- Device Prime Event
- Device Pump Settings Override Event
- Device Reservoir Change
- DeviceSensorEvent [Proposed]
- Device Settings Change [Proposed]
- Device Time Change
- DeviceTransmitterEvent [Proposed]
- Dosing Decision
- Food
- Insulin
- Physical Activity
- Pump Settings
- Pump Status
- Reported State
- Settings
- Upload
- Water Consumption
An abstract base data type for all Tidepool diabetes data objects.
An array of annotations.
An array of associations for the resource.
Clock drift offset, expressed as milliseconds.
Conversion offset, expressed as milliseconds.
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 UUID v4
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 UUID v4
Globally unique to device and repeatable with each upload, e.g. device make and model with serial number
Location information associated with the resource. One or both of name
and gps
must be specified.
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 UUID v4
Grab bag field for data that isn't yet part of the data model. The maximum size is 4K bytes.
A string timezone name from the IANA timezone database
Time zone offset, expressed as positive or negative number of minutes from UTC.
Data type
An upload identifier; this field should be the uploadId of the corresponding upload record
[ { "annotations": [ … ], "archivedTime": "2017-02-06T02:37:46Z", "archivedDatasetId": "ce8cc5f7595575945f91fc6710db6fef", "associations": [ … ], "clockDriftOffset": 0, "conversionOffset": 0, "createdTime": "2017-02-06T02:37:46Z", "createdUserId": "string", "deduplicator": { … }, "deletedTime": "2017-02-06T02:37:46Z", "deletedUserId": "string", "deviceId": "MMT-1711:12345678", "deviceTime": "2017-02-06T02:37:46", "guid": "string", "history": [ … ], "id": "ce8cc5f7595575945f91fc6710db6fef", "location": { … }, "modifiedTime": "2017-02-06T02:37:46Z", "modifiedUserId": "string", "notes": [ … ], "origin": { … }, "payload": {}, "source": "carelink", "tags": [ … ], "time": "2017-02-06T02:37:46Z", "timezone": "Europe/London", "timezoneOffset": -420, "type": "alert", "uploadId": "0d92d5c1c22117a18f3620b9e24d3c06", "name": "string", "priority": "critical", "trigger": "delayed", "triggerDelay": 86400, "sound": "name", "soundName": "string", "issuedTime": "2017-02-06T02:37:46Z", "acknowledgedTime": "2017-02-06T02:37:46Z", "retractedTime": "2017-02-06T02:37:46Z" } ]