Skip to content
Tidepool API/Data API/
/
Delete All Data for User

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.

Download OpenAPI description
data.v1.json
data.v1.yaml
Overview
URL
https://support.tidepool.org/
Tidepool API Support
support@tidepool.org
License
BSD-2-Clause
Terms of Service
Languages
Servers
Mock server
https://tidepool.redocly.app/_mock/reference/data.v1
integration
https://external.integration.tidepool.org
production
https://api.tidepool.org
dev1
https://dev1.dev.tidepool.org
qa1
https://qa1.development.tidepool.org
qa2
https://qa2.development.tidepool.org

Internal

APIs intended for internal use by Tidepool.

Operations

Data

Manages diabetes data in user's Tidepool account.

Schemas

Update Data Source

dataSetIdsArray of strings(Data Set ID Array)non-emptyuniquerequired

An array of data set IDs. The IDs in the array must be unique.

Example: ["ce8cc5f7595575945f91fc6710db6fef"]
earliestDataTimestring(date-time)(Date/Time)required

RFC 3339 / ISO 8601 timestamp with timezone information

Example: "2017-02-06T02:37:46Z"
errorstring
lastImportTimestring(date-time)(Date/Time)required

RFC 3339 / ISO 8601 timestamp with timezone information

Example: "2017-02-06T02:37:46Z"
latestDataTimestring(date-time)(Date/Time)required

RFC 3339 / ISO 8601 timestamp with timezone information

Example: "2017-02-06T02:37:46Z"
providerSessionIdstring(Provider Session ID)^[0-9a-z]{32}$required
statestring(Data Source State)required

State of the data source.

Enum"connected""disconnected""error"
Example: "connected"
{
  "dataSetIds": [
    "ce8cc5f7595575945f91fc6710db6fef"
  ],
  "earliestDataTime": "2017-02-06T02:37:46Z",
  "error": "string",
  "lastImportTime": "2017-02-06T02:37:46Z",
  "latestDataTime": "2017-02-06T02:37:46Z",
  "providerSessionId": "string",
  "state": "connected"
}

Delete All Data for User

Request

Delete all data for user specified by the userId.

Security
sessionToken
Path
userIdstring(Tidepool User ID)^([0-9a-f]{10}|[0-9a-f]{8}-[0-9a-f]{4}-[0-9a-...read-onlyrequired

Tidepool User ID

curl -i -X DELETE \
  'https://tidepool.redocly.app/_mock/reference/data.v1/v1/users/{userId}/data' \
  -H 'X-Tidepool-Session-Token: YOUR_API_KEY_HERE'

Responses

Success

Bodyapplication/json
object
Response
application/json
{}

Get Data Sets for User

Request

Gets data sets for the user account specified by the userId.

Security
sessionToken
Path
userIdstring(Tidepool User ID)^([0-9a-f]{10}|[0-9a-f]{8}-[0-9a-f]{4}-[0-9a-...read-onlyrequired

Tidepool User ID

curl -i -X GET \
  'https://tidepool.redocly.app/_mock/reference/data.v1/v1/users/{userId}/datasets' \
  -H 'X-Tidepool-Session-Token: YOUR_API_KEY_HERE'

Responses

Data Set List

Bodyapplication/json
dataArray of objects(Tidepool Data Set Array)

Diabetes Data Set Array

Example: [{"type":"upload","client":{"name":"com.devicecorp.tidepooluploader","version":"0.100.0"},"dataSetType":"normal","deduplicator":{"name":"org.tidepool.deduplicator.device.deactivate.hash","version":"1.2.3"},"deviceManufacturers":["DeviceCorp"],"deviceModel":"Devicey McDeviceface","deviceSerialNumber":"B97B6D59","deviceTags":["bgm","cgm","insulin-pump"],"timeProcessing":"none","timezone":"Europe/London","clockDriftOffset":0,"conversionOffset":0,"deviceId":"DevId0987654321","deviceTime":"2016-06-27T18:09:55","time":"2016-06-28T01:09:55.132Z","timezoneOffset":-420}]
Response
application/json
{
  "data": [
    { … }
  ]
}