dataengine API definition (1.0.0)

dataengine API definition

/v1/chart-query

/v1/chart-query/

Request Body schema: application/json

individual-id

required

string <uuid>

required

Array of objects

Array

take

required

integer

Default: 5

type

required

string

Enum: "ActiveEnergyBurned" "ActiveTime" "AerobicSteps" "AirQualityIndex" "Auscultation" "BloodGlucose" "BloodPressure" "BodyFatPercentage" "BodyMass" "BodyMassGoal" "BodyMassIndex" "BodyMassLean" "BodyTemperature" "Covid19" "DailyActivity" "DailyHeartRate" "Distance" "Dqv" "FeelingRating" "FluActivity" "ForcedExpiratoryVolume" "HbA1c" "Height" "Hematocrit" "Hemoglobin" "Medication" "Mindfulness" "OxygenSaturation" "PeakFlow" "PeriodicPulse" "PollenCount" "PollenGrassIndex" "PollenRagweedIndex" "PollenTreeIndex" "PotassiumLevel" "Pulse" "SkinTemperature" "SleepAnalysis" "Steps" "Vo2Max" "WaistCircumference" "WaterIntake"

anchor

string <datetime>

clean-output

boolean

Default: false

default-missing-value

number

field

string <= 255 characters

filter-field

string <= 255 characters

filter-values

Array of strings[ items <= 255 characters ]

funcs

Array of strings

Items Enum: "count" "max" "mean" "min" "sum"

interval

string

Enum: "" "daily" "hourly" "monthly" "weekly" "yearly"

organization-id

string <uuid>

output-unit

string <= 255 characters

Default: "None"

object

additional property

object

operator	string Default: "all" Enum: "all" "any"
additional property	object

reverse

boolean

Default: false

round-output

boolean

Default: false

source

string <= 255 characters

summary-funcs

Array of strings

Items Enum: "max" "min"

tz-offset-db-override

boolean

Default: false

tz-offset-mins

integer

Default: 0

zero-fill

boolean

Default: false

Responses

Request samples

Payload

Content type

application/json

{"individual-id": "11111111-1111-1111-1111-111111111111",
"queries": [{"anchor": "string",
"clean-output": false,
"default-missing-value": 0,
"field": "string",
"filter-field": "string",
"filter-values": ["string"
],
"funcs": ["count"
],
"interval": "",
"organization-id": "11111111-1111-1111-1111-111111111111",
"output-unit": "None",
"ranges": {"property1": {"operator": "all",
"property1": {"high": 0,
"low": 0
},
"property2": {"high": 0,
"low": 0
}
},
"property2": {"operator": "all",
"property1": {"high": 0,
"low": 0
},
"property2": {"high": 0,
"low": 0
}
}
},
"reverse": false,
"round-output": false,
"source": "string",
"summary-funcs": ["max"
],
"take": 5,
"type": "ActiveEnergyBurned",
"tz-offset-db-override": false,
"tz-offset-mins": 0,
"zero-fill": false
}
]
}

Response samples

201

Content type

application/vnd.api+json

{"data": [{"data": [{ }
],
"meta": { },
"range-summary": { },
"summary": { }
}
]
}

/v1/data-query

/v1/data-query/

Request Body schema: application/json

individual-id

required

string <uuid>

required

Array of objects

Array

anchor

string <datetime>

begin-datetime

string <datetime>

default-empty-value

boolean

default-missing-value

number

end-datetime

string <datetime>

field

string <= 255 characters

filter-field

string <= 255 characters

filter-values

Array of strings[ items <= 255 characters ]

function

string

Enum: "all_in_range" "any_out_of_range" "daily_totals_in_range" "decreasing" "decreasing_strict" "delta_in_range" "empty" "increasing" "increasing_strict" "mean" "mean_in_range" "nonempty" "pct_change_in_range" "threshold_index" "total_change_in_range" "value" "value_in_range"

high

number

low

number

organization-id

string <uuid>

output-unit

string <= 255 characters

Default: "None"

source

string <= 255 characters

summary-func

string

Enum: "count" "max" "mean" "min" "sum"

summary-interval

string

Enum: "" "daily" "hourly" "monthly" "weekly" "yearly"

tag

string <= 255 characters ^[a-zA-Z]+[a-zA-Z0-9]*$

take

integer >= 1

Default: 1

Number of units to take

threshold-margins

Array of numbers

type

string

Enum: "ActiveEnergyBurned" "ActiveTime" "AerobicSteps" "AirQualityIndex" "Auscultation" "BloodGlucose" "BloodPressure" "BodyFatPercentage" "BodyMass" "BodyMassGoal" "BodyMassIndex" "BodyMassLean" "BodyTemperature" "Covid19" "DailyActivity" "DailyHeartRate" "Distance" "Dqv" "FeelingRating" "FluActivity" "ForcedExpiratoryVolume" "HbA1c" "Height" "Hematocrit" "Hemoglobin" "Medication" "Mindfulness" "OxygenSaturation" "PeakFlow" "PeriodicPulse" "PollenCount" "PollenGrassIndex" "PollenRagweedIndex" "PollenTreeIndex" "PotassiumLevel" "Pulse" "SkinTemperature" "SleepAnalysis" "Steps" "Vo2Max" "WaistCircumference" "WaterIntake"

tz-offset-db-override

boolean

Default: false

tz-offset-mins

integer

Default: 0

unit

string

Default: "values"

Enum: "days" "hours" "minutes" "seconds" "values" "weeks"

Array of objects

Array

time required	string <datetime>
diastolic	number
systolic	number
value	number
property name* additional property	any

value-key

string <= 255 characters

Default: "value"

expression

string <= 255 characters ^[a-zA-Z0-9() ]*$

expressions

Array of strings[^[a-zA-Z0-9() ]*$]

Responses

Request samples

Payload

Content type

application/json

{"expression": "string",
"expressions": ["string"
],
"individual-id": "11111111-1111-1111-1111-111111111111",
"queries": [{"anchor": "string",
"begin-datetime": "string",
"default-empty-value": true,
"default-missing-value": 0,
"end-datetime": "string",
"field": "string",
"filter-field": "string",
"filter-values": ["string"
],
"function": "all_in_range",
"high": 0,
"low": 0,
"organization-id": "11111111-1111-1111-1111-111111111111",
"output-unit": "None",
"source": "string",
"summary-func": "count",
"summary-interval": "",
"tag": "string",
"take": 1,
"threshold-margins": [0
],
"type": "ActiveEnergyBurned",
"tz-offset-db-override": false,
"tz-offset-mins": 0,
"unit": "days",
"user-data": [{"diastolic": 0,
"systolic": 0,
"time": "string",
"value": 0
}
],
"value-key": "value"
}
]
}

Response samples

201
4XX

Content type

application/vnd.api+json

{"data": {"expression": true,
"expressions": [true
],
"queries": [true
]
}
}

/v1/interval-statistics-cumulative

/v1/interval-statistics-cumulative/

Request Body schema: application/json

begin-datetime required	string <datetime>
end-datetime required	string <datetime>
individual-id required	string <uuid>
interval required	string Enum: "" "daily" "hourly" "monthly" "weekly" "yearly"
type required	string Enum: "ActiveEnergyBurned" "ActiveTime" "AerobicSteps" "Auscultation" "Distance" "Mindfulness" "Steps" "WaterIntake"
field	string <= 255 characters
filter-field	string <= 255 characters
filter-values	Array of strings[ items <= 255 characters ]
organization-id	string <uuid>
output-unit	string <= 255 characters Default: "None"
reverse	boolean Default: false
round-output	boolean Default: false
source	string <= 255 characters
tz-offset-db-override	boolean Default: false
tz-offset-mins	integer Default: 0
zero-fill	boolean Default: false

Responses

Request samples

Payload

Content type

application/json

{"begin-datetime": "string",
"end-datetime": "string",
"field": "string",
"filter-field": "string",
"filter-values": ["string"
],
"individual-id": "11111111-1111-1111-1111-111111111111",
"interval": "",
"organization-id": "11111111-1111-1111-1111-111111111111",
"output-unit": "None",
"reverse": false,
"round-output": false,
"source": "string",
"type": "ActiveEnergyBurned",
"tz-offset-db-override": false,
"tz-offset-mins": 0,
"zero-fill": false
}

Response samples

201

Content type

application/vnd.api+json

{"data": [{ }
],
"meta": { }
}

/v1/interval-statistics-summary

/v1/interval-statistics-summary/

Request Body schema: application/json

begin-datetime required	string <datetime>
end-datetime required	string <datetime>
individual-id required	string <uuid>
interval required	string Enum: "" "daily" "hourly" "monthly" "weekly" "yearly"
type required	string Enum: "ActiveEnergyBurned" "ActiveTime" "AerobicSteps" "AirQualityIndex" "Auscultation" "BloodGlucose" "BloodPressure" "BodyFatPercentage" "BodyMass" "BodyMassGoal" "BodyMassIndex" "BodyMassLean" "BodyTemperature" "Covid19" "DailyActivity" "DailyHeartRate" "Distance" "Dqv" "FeelingRating" "ForcedExpiratoryVolume" "HbA1c" "Height" "Hematocrit" "Hemoglobin" "Medication" "Mindfulness" "OxygenSaturation" "PeakFlow" "PeriodicPulse" "PollenCount" "PollenGrassIndex" "PollenRagweedIndex" "PollenTreeIndex" "PotassiumLevel" "Pulse" "SkinTemperature" "Steps" "Vo2Max" "WaistCircumference" "WaterIntake"
field	string <= 255 characters
filter-field	string <= 255 characters
filter-values	Array of strings[ items <= 255 characters ]
funcs	Array of strings Items Enum: "count" "max" "mean" "min" "sum"
organization-id	string <uuid>
output-unit	string <= 255 characters Default: "None"
reverse	boolean Default: false
round-output	boolean Default: false
source	string <= 255 characters
tz-offset-db-override	boolean Default: false
tz-offset-mins	integer Default: 0
zero-fill	boolean Default: false

Responses

Request samples

Payload

Content type

application/json

{"begin-datetime": "string",
"end-datetime": "string",
"field": "string",
"filter-field": "string",
"filter-values": ["string"
],
"funcs": ["count"
],
"individual-id": "11111111-1111-1111-1111-111111111111",
"interval": "",
"organization-id": "11111111-1111-1111-1111-111111111111",
"output-unit": "None",
"reverse": false,
"round-output": false,
"source": "string",
"type": "ActiveEnergyBurned",
"tz-offset-db-override": false,
"tz-offset-mins": 0,
"zero-fill": false
}

Response samples

201

Content type

application/vnd.api+json

{"data": [{ }
]
}

/v1/rule-query

/v1/rule-query/

Request Body schema: application/json

individual-id

required

string <uuid>

required

Array of objects

Array

actions required	Array of strings[ items <= 255 characters ]
begin-datetime required	string <datetime>
end-datetime required	string <datetime>
high required	number
low required	number
type required	string <= 255 characters
allow-missing	boolean Default: false
field	string <= 255 characters
filter-field	string <= 255 characters
filter-values	Array of strings[ items <= 255 characters ]
function	string Enum: "avg" "count" "max" "mean" "min" "sum"
organization-id	string <uuid>
source	string <= 255 characters

rrule

string <rrule>

Default: "RRULE:INTERVAL=1;FREQ=DAILY"

Responses

Request samples

Payload

Content type

application/json

{"individual-id": "11111111-1111-1111-1111-111111111111",
"rrule": "RRULE:INTERVAL=1;FREQ=DAILY",
"rules": [{"actions": ["string"
],
"allow-missing": false,
"begin-datetime": "string",
"end-datetime": "string",
"field": "string",
"filter-field": "string",
"filter-values": ["string"
],
"function": "avg",
"high": 0,
"low": 0,
"organization-id": "11111111-1111-1111-1111-111111111111",
"source": "string",
"type": "string"
}
]
}

Response samples

201
4XX

Content type

application/vnd.api+json

{"data": [{"actions": ["string"
],
"allow-missing": false,
"begin-datetime": "string",
"end-datetime": "string",
"field": "string",
"filter-field": "string",
"filter-values": ["string"
],
"function": "avg",
"high": 0,
"low": 0,
"organization-id": "11111111-1111-1111-1111-111111111111",
"source": "string",
"type": "string"
}
]
}

/v1/sleep-analysis

/v1/sleep-analysis/

query Parameters

begin-datetime required	string <datetime>
end-datetime required	string <datetime>
individual-id required	string <uuid> Example: individual-id=11111111-1111-1111-1111-111111111111
filter-field	string <= 255 characters
filter-values	Array of strings[ items <= 255 characters ]
organization-id	string <uuid> Example: organization-id=11111111-1111-1111-1111-111111111111
output-unit	string Default: "min" Enum: "hour" "hours" "hr" "min" "minute" "minutes" "s" "second" "seconds"
page[limit]	integer [ 1 .. 1000 ] Default: 500
page[offset]	integer >= 0 Default: 0
reverse	boolean Default: false
round-output	boolean Default: true
source	string <= 255 characters
tz-offset-db-override	boolean Default: false
tz-offset-mins	integer Default: 0

Responses

Response samples

200

Content type

application/vnd.api+json

{"data": [{ }
],
"meta": { }
}

/v1/sniffers

/v1/sniffers/

Responses

Response samples

200

Content type

application/vnd.api+json

{"data": [{"attributes": {"created-time": "string",
"user-id": "11111111-1111-1111-1111-111111111111",
"valid-until": "string"
},
"id": "11111111-1111-1111-1111-111111111111",
"type": "sniffers"
}
],
"meta": { }
}

/v1/sniffers/

Request Body schema: application/json

required

object

type

required

string

Value: "sniffers"

required

object

user-id required	string <uuid>
valid-until required	string <datetime>

Responses

Request samples

Payload

Content type

application/json

{"data": {"attributes": {"user-id": "11111111-1111-1111-1111-111111111111",
"valid-until": "string"
},
"type": "sniffers"
},
"meta": { }
}

Response samples

201

Content type

application/vnd.api+json

{"data": {"attributes": {"created-time": "string",
"user-id": "11111111-1111-1111-1111-111111111111",
"valid-until": "string"
},
"id": "11111111-1111-1111-1111-111111111111",
"type": "sniffers"
},
"meta": { }
}

/v1/sniffers/{id}/

path Parameters

id

required

string

Resource identifier

Responses

Response samples

204

Content type

application/vnd.api+json

null

/v1/sniffers/{id}/

path Parameters

id

required

string

Resource identifier

Responses

Response samples

200

Content type

application/vnd.api+json

{"data": {"attributes": {"created-time": "string",
"user-id": "11111111-1111-1111-1111-111111111111",
"valid-until": "string"
},
"id": "11111111-1111-1111-1111-111111111111",
"type": "sniffers"
},
"meta": { }
}

/v1/sniffers/{id}/get-logs/

path Parameters

id

required

string

Resource identifier

query Parameters

page[limit]	integer (PageLimit) [ 1 .. 1000 ] Default: 100
page[offset]	integer (PageOffset) >= 0 Default: 0

Responses

Response samples

200

Content type

application/vnd.api+json

{"data": [{"attributes": {"body": "string",
"content_type": "string",
"created-time": "string",
"message": "string",
"method": "string",
"path": "string",
"query-string": "string",
"request-id": "string",
"response": "string",
"status-code": 0,
"trace-id": "string",
"user-agent": "string"
},
"id": "11111111-1111-1111-1111-111111111111",
"type": "sniffer-logs"
}
],
"meta": { }
}

/v1/timeline

/v1/timeline/

query Parameters

begin-datetime required	string <datetime>
end-datetime required	string <datetime>
individual-id required	string <uuid> Example: individual-id=11111111-1111-1111-1111-111111111111

Responses

Response samples

200

Content type

application/vnd.api+json

{"data": [{"attributes": {"description": "string",
"event-type": "date",
"status": "Active"
},
"id": "11111111-1111-1111-1111-111111111111",
"time": "string",
"type": "immunizations"
}
]
}

/v1/timeseries

/v1/timeseries/

query Parameters

begin-datetime required	string <datetime>
end-datetime required	string <datetime>
individual-id required	string <uuid> Example: individual-id=11111111-1111-1111-1111-111111111111
type required	string Enum: "ActiveEnergyBurned" "ActiveTime" "AerobicSteps" "AirQualityIndex" "Auscultation" "BloodGlucose" "BloodPressure" "BodyFatPercentage" "BodyMass" "BodyMassGoal" "BodyMassIndex" "BodyMassLean" "BodyTemperature" "Covid19" "DailyActivity" "DailyHeartRate" "Distance" "Dqv" "FeelingRating" "FluActivity" "ForcedExpiratoryVolume" "HbA1c" "Height" "Hematocrit" "Hemoglobin" "Medication" "Mindfulness" "OxygenSaturation" "PeakFlow" "PeriodicPulse" "PollenCount" "PollenGrassIndex" "PollenRagweedIndex" "PollenTreeIndex" "PotassiumLevel" "Pulse" "SkinTemperature" "SleepAnalysis" "Steps" "Vo2Max" "WaistCircumference" "WaterIntake"
filter-field	string <= 255 characters
filter-values	Array of strings[ items <= 255 characters ]
include-count	boolean Default: false When true, include full record count in response meta, else just include total for page being fetched
include-prior	boolean Default: false When true, include record just before provided time range (does not work with DailyActivity or SleepAnalysis)
organization-id	string <uuid> Example: organization-id=11111111-1111-1111-1111-111111111111
output-unit	string <= 255 characters Default: "None"
page[limit]	integer [ 1 .. 1000 ] Default: 500
page[offset]	integer >= 0 Default: 0
reverse	boolean Default: false
round-output	boolean Default: false
source	string <= 255 characters

Responses

Response samples

200
4XX

Content type

application/vnd.api+json

{"data": [{ }
],
"meta": { }
}

/v1/timeseries/

Request Body schema: application/json

required

object

type

required

string

Value: "time-series"

required

object

Array of objects

Array

source	string <= 255 characters
tz-offset-mins	integer Default: 0
property name* additional property	any

individual-id

string <uuid>

input-unit

string <= 255 characters

Default: "None"

organization-id

string <uuid>

type

string

Enum: "ActiveEnergyBurned" "ActiveTime" "AerobicSteps" "AirQualityIndex" "Auscultation" "BloodGlucose" "BloodPressure" "BodyFatPercentage" "BodyMass" "BodyMassGoal" "BodyMassIndex" "BodyMassLean" "BodyTemperature" "Covid19" "DailyActivity" "DailyHeartRate" "Distance" "Dqv" "FeelingRating" "FluActivity" "ForcedExpiratoryVolume" "HbA1c" "Height" "Hematocrit" "Hemoglobin" "Medication" "Mindfulness" "OxygenSaturation" "PeakFlow" "PeriodicPulse" "PollenCount" "PollenGrassIndex" "PollenRagweedIndex" "PollenTreeIndex" "PotassiumLevel" "Pulse" "SkinTemperature" "SleepAnalysis" "Steps" "Vo2Max" "WaistCircumference" "WaterIntake"

tz-offset-mins

integer

Default: 0

Responses

Request samples

Payload

Content type

application/json

{"data": {"attributes": {"data": [{"source": "string",
"tz-offset-mins": 0
}
],
"individual-id": "11111111-1111-1111-1111-111111111111",
"input-unit": "None",
"organization-id": "11111111-1111-1111-1111-111111111111",
"type": "ActiveEnergyBurned",
"tz-offset-mins": 0
},
"type": "time-series"
},
"meta": { }
}

Response samples

201

Content type

application/vnd.api+json

{"data": {"attributes": {"num-created": 0
},
"type": "time-series"
},
"meta": { }
}

/v1/timeseries/{id}/

path Parameters

id

required

string

Resource identifier

query Parameters

type required	string Enum: "ActiveEnergyBurned" "ActiveTime" "AerobicSteps" "AirQualityIndex" "Auscultation" "BloodGlucose" "BloodPressure" "BodyFatPercentage" "BodyMass" "BodyMassGoal" "BodyMassIndex" "BodyMassLean" "BodyTemperature" "Covid19" "DailyActivity" "DailyHeartRate" "Distance" "Dqv" "FeelingRating" "FluActivity" "ForcedExpiratoryVolume" "HbA1c" "Height" "Hematocrit" "Hemoglobin" "Medication" "Mindfulness" "OxygenSaturation" "PeakFlow" "PeriodicPulse" "PollenCount" "PollenGrassIndex" "PollenRagweedIndex" "PollenTreeIndex" "PotassiumLevel" "Pulse" "SkinTemperature" "SleepAnalysis" "Steps" "Vo2Max" "WaistCircumference" "WaterIntake"
begin-time	string <datetime>
end-time	string <datetime>
include-participant	boolean
organization-id	string <uuid> Example: organization-id=11111111-1111-1111-1111-111111111111
time	string <datetime>

Responses

Response samples

200
4XX

Content type

application/vnd.api+json

{"data": {"attributes": {"num-deleted": 0
},
"type": "time-series"
},
"meta": { }
}

/v1/timeseries/{id}/bulk-delete/

path Parameters

id

required

string

Resource identifier

Request Body schema: application/json

required

object

type

required

string

Value: "time-series"

required

object

data required	Array of objects
organization-id	string <uuid>
type	string Enum: "ActiveEnergyBurned" "ActiveTime" "AerobicSteps" "AirQualityIndex" "Auscultation" "BloodGlucose" "BloodPressure" "BodyFatPercentage" "BodyMass" "BodyMassGoal" "BodyMassIndex" "BodyMassLean" "BodyTemperature" "Covid19" "DailyActivity" "DailyHeartRate" "Distance" "Dqv" "FeelingRating" "FluActivity" "ForcedExpiratoryVolume" "HbA1c" "Height" "Hematocrit" "Hemoglobin" "Medication" "Mindfulness" "OxygenSaturation" "PeakFlow" "PeriodicPulse" "PollenCount" "PollenGrassIndex" "PollenRagweedIndex" "PollenTreeIndex" "PotassiumLevel" "Pulse" "SkinTemperature" "SleepAnalysis" "Steps" "Vo2Max" "WaistCircumference" "WaterIntake"

Responses

Request samples

Payload

Content type

application/json

{"data": {"attributes": {"data": [{ }
],
"organization-id": "11111111-1111-1111-1111-111111111111",
"type": "ActiveEnergyBurned"
},
"type": "time-series"
},
"meta": { }
}

Response samples

201
4XX

Content type

application/vnd.api+json

{"data": {"attributes": {"num-deleted": 0
},
"type": "time-series"
},
"meta": { }
}

/v1/units

/v1/units/

query Parameters

types

Array of strings

Items Enum: "ActiveEnergyBurned" "ActiveTime" "AerobicSteps" "AirQualityIndex" "Auscultation" "BloodGlucose" "BloodPressure" "BodyFatPercentage" "BodyMass" "BodyMassGoal" "BodyMassIndex" "BodyMassLean" "BodyTemperature" "Covid19" "DailyActivity" "DailyHeartRate" "Distance" "Dqv" "FeelingRating" "FluActivity" "ForcedExpiratoryVolume" "HbA1c" "Height" "Hematocrit" "Hemoglobin" "Medication" "Mindfulness" "OxygenSaturation" "PeakFlow" "PeriodicPulse" "PollenCount" "PollenGrassIndex" "PollenRagweedIndex" "PollenTreeIndex" "PotassiumLevel" "Pulse" "SkinTemperature" "SleepAnalysis" "Steps" "Vo2Max" "WaistCircumference" "WaterIntake"

Responses

Response samples

200

Content type

application/vnd.api+json

{"data": [{"type": "string",
"units": ["string"
]
}
]
}