Skip to content

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
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.

Operations

New Data Source

New data source

providerNamestring(Provider Name)[ 1 .. 100 ] charactersrequired
Example: "dexcom"
providerSessionIdstring(Provider Session ID)^[0-9a-z]{32}$required
providerTypestring(Provider Type)required
Value"oauth"
Example: "oauth"
statestring(Data Source State)required

State of the data source.

Enum"connected""disconnected""error"
Example: "connected"
{ "providerName": "dexcom", "providerSessionId": "string", "providerType": "oauth", "state": "connected" }

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" }

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
{}