Skip to content
Tidepool API/Data Summary API/Summary

Data Summary 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
summary.v1.json
summary.v1.yaml
Overview
URL

https://www.tidepool.org

Tidepool

support@tidepool.org

License

BSD 2-Clause "Simplified" License

Terms of Service

Languages
Servers
Mock server

https://tidepool.redocly.app/_mock/reference/summary.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

Summary

Summary Data

This API is for a component within the data service that calculates summary statistics for user accounts. These routes are mostly executed by the task and clinic-worker services.

Operations

Get User Summary

Request

Retrieve a summary by user id

Security
sessionToken
Path
summaryTypestring(Summary Type)required

Field which contains a summary type string.

Enum"cgm""bgm""con"
userIdstring(Tidepool User ID)^([0-9a-f]{10}|[0-9a-f]{8}-[0-9a-f]{4}-[0-9a-...read-onlyrequired

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

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

Responses

OK

Bodyapplication/json
idstring(Summary ID)[ 0 .. 24 ] characters^[a-f0-9]{0,24}$

Summary Unique Identifier

Example: "2fe2488217ee43e1b2e83c2f"
typestring(Summary Type)

Field which contains a summary type string.

Enum"cgm""bgm""con"
userIdstring(Tidepool User ID)^([0-9a-f]{10}|[0-9a-f]{8}-[0-9a-f]{4}-[0-9a-...read-only

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

configobject(config.v1)

Summary schema version and calculation configuration

datesobject(summaryDates.v5)

dates tracked for summary calculation

periodscgmperiods.v5 (object) or bgmperiods.v5 (object) or continuousperiods.v5 (object)
One of:

A map to each supported CGM summary period

Response
application/json
{
  "id": "2fe2488217ee43e1b2e83c2f",
  "type": "cgm",
  "userId": "string",
  "config": {
    "schemaVersion": 0,
    "highGlucoseThreshold": 0,
    "veryHighGlucoseThreshold": 0,
    "lowGlucoseThreshold": 0,
    "veryLowGlucoseThreshold": 0
  },
  "dates": {
    "lastUpdatedDate": "2019-08-24T14:15:22Z",
    "lastUpdatedReason": [ … ],
    "firstData": "2019-08-24T14:15:22Z",
    "lastData": "2019-08-24T14:15:22Z",
    "lastUploadDate": "2019-08-24T14:15:22Z",
    "outdatedSince": "2019-08-24T14:15:22Z",
    "outdatedReason": [ … ]
  },
  "periods": {
    "property1": { … },
    "property2": { … }
  }
}