Skip to content
Tidepool API/Clinics API/
/
View TIDE Report

View TIDE Report

Request

Retrieve a report of patients with tags by TIDE categories

Security
sessionToken
Path
clinicIdstring^[a-f0-9]{24}$required
Query
periodstring^(1d|7d|14d|30d)$required

Time Period to display

Example:period=7d
tagsArray of strings, non-emptyrequired

Comma-separated list of patient tag IDs

lastDataCutoffstring, (date-time)required

Inclusive minimum of date of last data from a patient.

categoriesArray of strings

Comma-separated list of TIDE report categories to return in queried order. If omitted or empty, the default TIDE categories will be returned - see example.

Items Enum:"timeInVeryLowPercent""timeInAnyLowPercent""timeInExtremeHighPercent""timeInVeryHighPercent""timeInAnyHighPercent""dropInTimeInTargetPercent""timeInTargetPercent""timeCGMUsePercent""meetingTargets"
Example:categories=timeInVeryLowPercent&categories=timeInAnyLowPercent&categories=timeInVeryHighPercent&categories=timeInAnyHighPercent&categories=dropInTimeI
excludeNoDataboolean

If true, then exclude / omit patients with no data in the TIDE report.

curl -i -X GET \
  'https://tidepool.redocly.app/_mock/reference/clinic.v1/v1/clinics/{clinicId}/tide_report?period=7d&tags=stringstringstringstring&lastDataCutoff=2019-08-24T14%3A15%3A22Z&categories=timeInVeryLowPercent%2CtimeInAnyLowPercent%2CtimeInVeryHighPercent%2CtimeInAnyHighPercent%2CdropInTimeInTargetPercent%2CtimeCGMUsePercent%2CmeetingTargets&excludeNoData=true' \
  -H 'x-tidepool-session-token: YOUR_API_KEY_HERE'

Responses

OK

Bodyapplication/json
configobject(tideconfig.v1)required
resultsobject(tideresults.v1)required
Response
{
  "config": {
    "schemaVersion": 0,
    "clinicId": "2fe2488217ee43e1b2e83c2f",
    "period": "7d",
    "lastDataCutoff": "2019-08-24T14:15:22Z",
    "highGlucoseThreshold": 0,
    "veryHighGlucoseThreshold": 0,
    "extremeHighGlucoseThreshold": 0,
    "lowGlucoseThreshold": 0,
    "veryLowGlucoseThreshold": 0,
    "tags": [ … ],
    "filters": { … }
  },
  "results": {
    "property1": [ … ],
    "property2": [ … ]
  }
}