lachesis API definition (1.0.0)

lachesis API definition

/v1/aggregation-requests

/v1/aggregation-requests/

Request Body schema: application/json

required

object

type

required

string

Value: "aggregation-requests"

required

object

required

Array of objects

Array

column required	string <= 64 characters
individual-id required	string <uuid>

meta

object

Responses

Request samples

Payload

Content type

application/json

{"data": {"attributes": {"entries": [{"column": "string",
"individual-id": "11111111-1111-1111-1111-111111111111"
}
]
},
"type": "aggregation-requests"
},
"meta": { }
}

Response samples

201

Content type

application/vnd.api+json

{"data": {"attributes": { },
"id": "11111111-1111-1111-1111-111111111111",
"type": "aggregation-requests"
},
"meta": { }
}

/v1/bulk-metadata

/v1/bulk-metadata/

query Parameters

individual-ids required	Array of strings <uuid> non-empty [ items <uuid > ] Example: individual-ids=11111111-1111-1111-1111-111111111111
begin-datetime	string <datetime>
describe	Array of strings Items Enum: "None" "max-time" "min-time" "num-objects" "object-exists"
end-datetime	string <datetime>
individual-id	string <uuid> Example: individual-id=11111111-1111-1111-1111-111111111111
page[limit]	integer [ 1 .. 1000 ] Default: 500
page[offset]	integer (PageOffset) >= 0 Default: 0
series-id	string <uuid> Example: series-id=11111111-1111-1111-1111-111111111111
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" "PollenGrassIndex" "PollenRagweedIndex" "PollenTreeIndex" "PotassiumLevel" "Pulse" "SkinTemperature" "SleepAnalysis" "Steps" "Vo2Max" "WaistCircumference" "WaterIntake"

Responses

Response samples

200

Content type

application/vnd.api+json

{ }

/v1/bulk-summaries

/v1/bulk-summaries/

query Parameters

begin-datetime required	string <datetime>
end-datetime required	string <datetime>
funcs required	Array of strings Items Enum: "count" "max" "mean" "min" "sum"
individual-id required	string <uuid> Example: individual-id=11111111-1111-1111-1111-111111111111
interval required	string Default: "" Enum: "" "daily" "hourly" "monthly" "weekly" "yearly"
types required	Array of strings non-empty 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" "PollenGrassIndex" "PollenRagweedIndex" "PollenTreeIndex" "PotassiumLevel" "Pulse" "SkinTemperature" "SleepAnalysis" "Steps" "Vo2Max" "WaistCircumference" "WaterIntake"
field	string <= 255 characters
filter-field	string <= 255 characters
filter-values	Array of strings[ items <= 255 characters ]
page[limit]	integer [ 1 .. 1000 ] Default: 500
page[offset]	integer (PageOffset) >= 0 Default: 0
reverse	boolean
source	string <= 255 characters
tz-offset-db-override	boolean
tz-offset-mins	integer

Responses

Response samples

200

Content type

application/vnd.api+json

{ }

/v1/bulk-timeseries

/v1/bulk-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
types required	Array of strings non-empty 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" "PollenGrassIndex" "PollenRagweedIndex" "PollenTreeIndex" "PotassiumLevel" "Pulse" "SkinTemperature" "SleepAnalysis" "Steps" "Vo2Max" "WaistCircumference" "WaterIntake"
filter-field	string <= 255 characters
filter-values	Array of strings[ items <= 255 characters ]
page[limit]	integer [ 1 .. 1000 ] Default: 500
page[offset]	integer (PageOffset) >= 0 Default: 0
reverse	boolean
source	string <= 255 characters

Responses

Response samples

200

Content type

application/vnd.api+json

{ }

/v1/metadata

/v1/metadata/ Deprecated

query Parameters

begin-datetime	string <datetime>
describe	Array of strings Items Enum: "None" "max-time" "min-time" "num-objects" "object-exists" "sources"
end-datetime	string <datetime>
filter[organization-id]	string <uuid> Example: filter[organization-id]=11111111-1111-1111-1111-111111111111
individual-id	string <uuid> Example: individual-id=11111111-1111-1111-1111-111111111111
page[limit]	integer [ 1 .. 1000 ] Default: 500
page[offset]	integer (PageOffset) >= 0 Default: 0
series-id	string <uuid> Example: series-id=11111111-1111-1111-1111-111111111111
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" "PollenGrassIndex" "PollenRagweedIndex" "PollenTreeIndex" "PotassiumLevel" "Pulse" "SkinTemperature" "SleepAnalysis" "Steps" "Vo2Max" "WaistCircumference" "WaterIntake"

Responses

Response samples

200
4XX

Content type

application/vnd.api+json

{"data": [{"created-at": "string",
"individual-id": "11111111-1111-1111-1111-111111111111",
"max-time": "string",
"min-time": "string",
"num-objects": 0,
"object-exists": true,
"organization-id": "11111111-1111-1111-1111-111111111111",
"series-id": "11111111-1111-1111-1111-111111111111",
"sources": ["string"
],
"type": "ActiveEnergyBurned"
}
],
"meta": {"page[limit]": 500,
"page[offset]": 0,
"page[total]": 0
}
}

/v1/metadata/ Deprecated

Request Body schema: application/json

required

object

type

required

string

Value: "series-metadata"

required

object

individual-id required	string <uuid>
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" "PollenGrassIndex" "PollenRagweedIndex" "PollenTreeIndex" "PotassiumLevel" "Pulse" "SkinTemperature" "SleepAnalysis" "Steps" "Vo2Max" "WaistCircumference" "WaterIntake"
organization-id	string <uuid>
summary-tables	boolean

meta

object

Responses

Request samples

Payload

Content type

application/json

{"data": {"attributes": {"individual-id": "11111111-1111-1111-1111-111111111111",
"organization-id": "11111111-1111-1111-1111-111111111111",
"summary-tables": true,
"type": "ActiveEnergyBurned"
},
"type": "series-metadata"
},
"meta": { }
}

Response samples

201

Content type

application/vnd.api+json

{"data": {"attributes": {"series-id": "11111111-1111-1111-1111-111111111111"
},
"type": "series-metadata"
},
"meta": { }
}

/v1/metadata/{id}/

path Parameters

id

required

string

Resource identifier

Responses

Response samples

204
4XX

Content type

application/vnd.api+json

null

/v1/metadata/{id}/delete-series/

path Parameters

id

required

string

Resource identifier

Request Body schema: application/json

required

object

type required	string Value: "series-metadata"
attributes required	object

meta

object

Responses

Request samples

Payload

Content type

application/json

{"data": {"attributes": { },
"type": "series-metadata"
},
"meta": { }
}

Response samples

201
4XX

Content type

application/vnd.api+json

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

/v1/metadata/{id}/series-types/

path Parameters

id

required

string

Resource identifier

Responses

Response samples

200

Content type

application/vnd.api+json

{"data": ["ActiveEnergyBurned"
]
}

/v1/purge-data

/v1/purge-data/

Responses

Response samples

200

Content type

application/vnd.api+json

null

/v1/purge-data/

Request Body schema: application/json

required

object

type

required

string

Value: "system-purges"

required

object

entity-id required	string <= 255 characters
entity-type required	string Enum: "individual" "organization" "user"
reference-id required	string <= 255 characters
request-id required	string <= 255 characters
archive	boolean Default: false
property name* additional property	any

meta

object

Responses

Request samples

Payload

Content type

application/json

{"data": {"attributes": {"archive": false,
"entity-id": "string",
"entity-type": "individual",
"reference-id": "string",
"request-id": "string"
},
"type": "system-purges"
},
"meta": { }
}

Response samples

201

Content type

application/vnd.api+json

null

/v1/replicators

/v1/replicators/

query Parameters

filter[classpath]

string <= 255 characters

Responses

Response samples

200

Content type

application/vnd.api+json

{"data": [{"attributes": {"classpath": "string",
"created-time": "string",
"last-poll-time": "string"
},
"id": "11111111-1111-1111-1111-111111111111",
"type": "replicators"
}
],
"meta": { }
}

/v1/replicators/{id}/

path Parameters

id

required

string

Resource identifier

Responses

Response samples

200

Content type

application/vnd.api+json

{"data": {"attributes": {"classpath": "string",
"created-time": "string",
"last-poll-time": "string"
},
"id": "11111111-1111-1111-1111-111111111111",
"type": "replicators"
},
"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>

meta

object

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/source-summaries

/v1/source-summaries/ Deprecated

Request Body schema: application/json

begin-datetime required	string <datetime>
end-datetime required	string <datetime>
func required	string Enum: "count" "max" "mean" "min" "sum"
individual-ids required	Array of strings <uuid> non-empty [ items <uuid > ]
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" "PollenGrassIndex" "PollenRagweedIndex" "PollenTreeIndex" "PotassiumLevel" "Pulse" "SkinTemperature" "SleepAnalysis" "Steps" "Vo2Max" "WaistCircumference" "WaterIntake"

Responses

Request samples

Payload

Content type

application/json

{"begin-datetime": "string",
"end-datetime": "string",
"func": "count",
"individual-ids": ["11111111-1111-1111-1111-111111111111"
],
"type": "ActiveEnergyBurned"
}

Response samples

201
4XX

Content type

application/vnd.api+json

{"data": [{"individual-id": "11111111-1111-1111-1111-111111111111",
"source": "string",
"value": 0
}
]
}

/v1/summary

/v1/summary/

query Parameters

begin-datetime required	string <datetime>
end-datetime required	string <datetime>
funcs required	Array of strings Items Enum: "count" "max" "mean" "min" "sum"
individual-id required	string <uuid> Example: individual-id=11111111-1111-1111-1111-111111111111
interval required	string Default: "" 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" "FluActivity" "ForcedExpiratoryVolume" "HbA1c" "Height" "Hematocrit" "Hemoglobin" "Medication" "Mindfulness" "OxygenSaturation" "PeakFlow" "PeriodicPulse" "PollenGrassIndex" "PollenRagweedIndex" "PollenTreeIndex" "PotassiumLevel" "Pulse" "SkinTemperature" "SleepAnalysis" "Steps" "Vo2Max" "WaistCircumference" "WaterIntake"
field	string <= 255 characters
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
page[limit]	integer [ 1 .. 1000 ] Default: 500
page[offset]	integer (PageOffset) >= 0 Default: 0
reverse	boolean
source	string <= 255 characters
tz-offset-db-override	boolean
tz-offset-mins	integer

Responses

Response samples

200
4XX

Content type

application/vnd.api+json

{"data": [{"max": 0,
"mean": 0,
"min": 0,
"time": "string"
}
]
}

/v1/tasks

/v1/tasks/{id}/

path Parameters

id

required

string

Resource identifier

Responses

Response samples

200

Content type

application/vnd.api+json

{"data": {"attributes": {"created-time": "string",
"last-modified-time": "string",
"result": null,
"status": "string"
},
"id": "string",
"type": "tasks"
},
"meta": { }
}

/v1/tca

/v1/tca/

query Parameters

individual-id required	string <uuid> Example: individual-id=11111111-1111-1111-1111-111111111111
alerter-ids	Array of strings <uuid> [ items <uuid > ] Example: alerter-ids=11111111-1111-1111-1111-111111111111
alerter-type	string Default: "Watermark" Enum: "Range" "Watermark"
is-active	boolean
page[limit]	integer [ 1 .. 1000 ] Default: 500
page[offset]	integer (PageOffset) >= 0 Default: 0

Responses

Response samples

200

Content type

application/vnd.api+json

{"data": [{"callback": "http://example.com",
"field": "string",
"id": "11111111-1111-1111-1111-111111111111",
"is-active": true,
"registered-at": "string",
"type": "ActiveEnergyBurned"
}
],
"meta": {"page[limit]": 500,
"page[offset]": 0,
"page[total]": 0
}
}

/v1/tca/ Deprecated

Request Body schema: application/json

required

object

type

required

string

Value: "time-series-tca"

required

object

callback required	string <uri> non-empty
high required	number
low required	number
threshold required	string Enum: "HIGH" "LOW"
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" "PollenGrassIndex" "PollenRagweedIndex" "PollenTreeIndex" "PotassiumLevel" "Pulse" "SkinTemperature" "SleepAnalysis" "Steps" "Vo2Max" "WaistCircumference" "WaterIntake"
anchor-time	string <datetime>
field	string <= 255 characters
filter-field	string <= 255 characters
filter-values	Array of strings[ items <= 255 characters ]
individual-id	string <uuid>

meta

object

Responses

Request samples

Payload

Content type

application/json

{"data": {"attributes": {"anchor-time": "string",
"callback": "http://example.com",
"field": "string",
"filter-field": "string",
"filter-values": ["string"
],
"high": 0,
"individual-id": "11111111-1111-1111-1111-111111111111",
"low": 0,
"threshold": "HIGH",
"type": "ActiveEnergyBurned"
},
"type": "time-series-tca"
},
"meta": { }
}

Response samples

201
4XX

Content type

application/vnd.api+json

{"data": {"attributes": { },
"id": "11111111-1111-1111-1111-111111111111",
"type": "time-series-tca"
},
"meta": { }
}

/v1/tca/{id}/

path Parameters

id

required

string

Resource identifier

Responses

Response samples

204
4XX

Content type

application/vnd.api+json

null

Only applies to range-alerter

path Parameters

id

required

string

Resource identifier

Request Body schema: application/json

required

object

type

required

string

Value: "time-series-tca"

required

object

alert-on-first-data	boolean
allow-consecutive	boolean
callback	string <uri> non-empty
range-boundaries	Array of numbers

id

required

string <uuid>

meta

object

Responses

Request samples

Payload

Content type

application/json

{"data": {"attributes": {"alert-on-first-data": true,
"allow-consecutive": true,
"callback": "http://example.com",
"range-boundaries": [0
]
},
"id": "11111111-1111-1111-1111-111111111111",
"type": "time-series-tca"
},
"meta": { }
}

Response samples

200
4XX

Content type

application/vnd.api+json

{"data": {"callback": "http://example.com",
"field": "string",
"id": "11111111-1111-1111-1111-111111111111",
"is-active": true,
"registered-at": "string",
"type": "ActiveEnergyBurned"
}
}

/v1/tca/{id}/alerts/

path Parameters

id

required

string

Resource identifier

query Parameters

alert-ids	Array of strings <uuid> [ items <uuid > ] Example: alert-ids=11111111-1111-1111-1111-111111111111
alerter-ids	Array of strings <uuid> [ items <uuid > ] Example: alerter-ids=11111111-1111-1111-1111-111111111111
alerter-type	string Default: "Watermark" Enum: "Range" "Watermark"
is-active	boolean
is-confirmed	boolean
page[limit]	integer [ 1 .. 1000 ] Default: 500
page[offset]	integer (PageOffset) >= 0 Default: 0

Responses

Response samples

200

Content type

application/vnd.api+json

{"data": [{"activated-at": "string",
"activating-callback-posted": true,
"activating-ts": "string",
"alerter-id": "11111111-1111-1111-1111-111111111111",
"cleared-at": "string",
"clearing-callback-posted": true,
"clearing-ts": "string",
"confirmation-ts": "string",
"confirmation-user-id": "11111111-1111-1111-1111-111111111111",
"field": "string",
"id": "11111111-1111-1111-1111-111111111111",
"is-active": true,
"type": "ActiveEnergyBurned"
}
],
"meta": {"page[limit]": 500,
"page[offset]": 0,
"page[total]": 0
}
}

/v1/tca/{id}/confirm-alert/

path Parameters

id

required

string

Resource identifier

Request Body schema: application/json

required

object

type

required

string

Value: "time-series-tca"

required

object

alert-id

required

string <uuid>

meta

object

Responses

Request samples

Payload

Content type

application/json

{"data": {"attributes": {"alert-id": "11111111-1111-1111-1111-111111111111"
},
"type": "time-series-tca"
},
"meta": { }
}

Response samples

201
4XX

Content type

application/vnd.api+json

{"data": {"attributes": {"already-confirmed": true
},
"type": "time-series-tca"
},
"meta": { }
}

/v1/tca/{id}/range-alerter/

path Parameters

id

required

string

Resource identifier

Request Body schema: application/json

required

object

type

required

string

Value: "time-series-tca"

required

object

callback required	string <uri> non-empty
range-boundaries required	Array of numbers
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" "PollenGrassIndex" "PollenRagweedIndex" "PollenTreeIndex" "PotassiumLevel" "Pulse" "SkinTemperature" "SleepAnalysis" "Steps" "Vo2Max" "WaistCircumference" "WaterIntake"
alert-on-first-data	boolean Default: false
allow-consecutive	boolean Default: false
anchor-time	string <datetime>
field	string <= 255 characters
filter-field	string <= 255 characters
filter-values	Array of strings[ items <= 255 characters ]

meta

object

Responses

Request samples

Payload

Content type

application/json

{"data": {"attributes": {"alert-on-first-data": false,
"allow-consecutive": false,
"anchor-time": "string",
"callback": "http://example.com",
"field": "string",
"filter-field": "string",
"filter-values": ["string"
],
"range-boundaries": [0
],
"type": "ActiveEnergyBurned"
},
"type": "time-series-tca"
},
"meta": { }
}

Response samples

201
4XX

Content type

application/vnd.api+json

{"data": {"attributes": { },
"id": "11111111-1111-1111-1111-111111111111",
"type": "time-series-tca"
},
"meta": { }
}

/v1/tca/{id}/watermark-alerter/

path Parameters

id

required

string

Resource identifier

Request Body schema: application/json

required

object

type

required

string

Value: "time-series-tca"

required

object

callback required	string <uri> non-empty
high required	number
low required	number
threshold required	string Enum: "HIGH" "LOW"
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" "PollenGrassIndex" "PollenRagweedIndex" "PollenTreeIndex" "PotassiumLevel" "Pulse" "SkinTemperature" "SleepAnalysis" "Steps" "Vo2Max" "WaistCircumference" "WaterIntake"
anchor-time	string <datetime>
field	string <= 255 characters
filter-field	string <= 255 characters
filter-values	Array of strings[ items <= 255 characters ]
individual-id	string <uuid>

meta

object

Responses

Request samples

Payload

Content type

application/json

{"data": {"attributes": {"anchor-time": "string",
"callback": "http://example.com",
"field": "string",
"filter-field": "string",
"filter-values": ["string"
],
"high": 0,
"individual-id": "11111111-1111-1111-1111-111111111111",
"low": 0,
"threshold": "HIGH",
"type": "ActiveEnergyBurned"
},
"type": "time-series-tca"
},
"meta": { }
}

Response samples

201
4XX

Content type

application/vnd.api+json

{"data": {"attributes": { },
"id": "11111111-1111-1111-1111-111111111111",
"type": "time-series-tca"
},
"meta": { }
}

/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" "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: true
include-created-at	boolean Default: false
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
page[limit]	integer [ 1 .. 1000 ] Default: 500
page[offset]	integer (PageOffset) >= 0 Default: 0
reverse	boolean
source	string <= 255 characters

Responses

Response samples

200
4XX

Content type

application/vnd.api+json

{"data": [{ }
]
}

/v1/timeseries/

Request Body schema: application/json

required

object

type

required

string

Value: "time-series"

required

object

Array of objects

Array

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

individual-copy

boolean

Default: true

individual-id

string <uuid>

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" "PollenGrassIndex" "PollenRagweedIndex" "PollenTreeIndex" "PotassiumLevel" "Pulse" "SkinTemperature" "SleepAnalysis" "Steps" "Vo2Max" "WaistCircumference" "WaterIntake"

tz-offset-mins

integer

meta

object

Responses

Request samples

Payload

Content type

application/json

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

Response samples

201
4XX

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" "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
source	string <= 255 characters
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" "PollenGrassIndex" "PollenRagweedIndex" "PollenTreeIndex" "PotassiumLevel" "Pulse" "SkinTemperature" "SleepAnalysis" "Steps" "Vo2Max" "WaistCircumference" "WaterIntake"

meta

object

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

Content type

application/vnd.api+json

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

/v1/timeseries-bundle

/v1/timeseries-bundle/

query Parameters

filter[series-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" "PollenGrassIndex" "PollenRagweedIndex" "PollenTreeIndex" "PotassiumLevel" "Pulse" "SkinTemperature" "SleepAnalysis" "Steps" "Vo2Max" "WaistCircumference" "WaterIntake"
filter[cmp-created-at]	Array of strings [ 1 .. 2 ] items [ items <= 32 characters ]
filter[cmp-timestamp]	Array of strings [ 1 .. 2 ] items [ items <= 32 characters ]
page[limit]	integer [ 1 .. 1000 ] Default: 500
page[offset]	integer (PageOffset) >= 0 Default: 0

Responses

Response samples

200
4XX

Content type

application/vnd.api+json

{"data": [{"created-at": "string",
"individual-id": "11111111-1111-1111-1111-111111111111"
}
],
"meta": {"page[limit]": 500,
"page[offset]": 0,
"page[total]": 0
}
}

/v1/timeseries-metadata

/v1/timeseries-metadata/

query Parameters

begin-datetime	string <datetime>
describe	Array of strings Items Enum: "None" "max-time" "min-time" "num-objects" "object-exists" "sources"
end-datetime	string <datetime>
filter[organization-id]	string <uuid> Example: filter[organization-id]=11111111-1111-1111-1111-111111111111
individual-id	string <uuid> Example: individual-id=11111111-1111-1111-1111-111111111111
page[limit]	integer [ 1 .. 1000 ] Default: 500
page[offset]	integer (PageOffset) >= 0 Default: 0
series-id	string <uuid> Example: series-id=11111111-1111-1111-1111-111111111111
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" "PollenGrassIndex" "PollenRagweedIndex" "PollenTreeIndex" "PotassiumLevel" "Pulse" "SkinTemperature" "SleepAnalysis" "Steps" "Vo2Max" "WaistCircumference" "WaterIntake"

Responses

Response samples

200
4XX

Content type

application/vnd.api+json

{"data": [{"attributes": {"created-at": "string",
"individual-id": "11111111-1111-1111-1111-111111111111",
"max-time": "string",
"min-time": "string",
"num-objects": 0,
"object-exists": true,
"organization-id": "11111111-1111-1111-1111-111111111111",
"sources": ["string"
],
"type": "ActiveEnergyBurned"
},
"id": "11111111-1111-1111-1111-111111111111",
"type": "timeseries-metadata"
}
],
"meta": { }
}

/v1/timeseries-metadata/

Request Body schema: application/json

required

object

type

required

string

Value: "series-metadata"

required

object

individual-id required	string <uuid>
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" "PollenGrassIndex" "PollenRagweedIndex" "PollenTreeIndex" "PotassiumLevel" "Pulse" "SkinTemperature" "SleepAnalysis" "Steps" "Vo2Max" "WaistCircumference" "WaterIntake"
organization-id	string <uuid>
summary-tables	boolean

meta

object

Responses

Request samples

Payload

Content type

application/json

{"data": {"attributes": {"individual-id": "11111111-1111-1111-1111-111111111111",
"organization-id": "11111111-1111-1111-1111-111111111111",
"summary-tables": true,
"type": "ActiveEnergyBurned"
},
"type": "series-metadata"
},
"meta": { }
}

Response samples

201

Content type

application/vnd.api+json

{"data": {"attributes": {"created-at": "string",
"individual-id": "11111111-1111-1111-1111-111111111111",
"max-time": "string",
"min-time": "string",
"num-objects": 0,
"object-exists": true,
"organization-id": "11111111-1111-1111-1111-111111111111",
"sources": ["string"
],
"type": "ActiveEnergyBurned"
},
"id": "11111111-1111-1111-1111-111111111111",
"type": "timeseries-metadata"
},
"meta": { }
}

/v1/timeseries-metadata/{id}/

path Parameters

id

required

string

Resource identifier

Responses

Response samples

204
4XX

Content type

application/vnd.api+json

null

/v1/timeseries-metadata/{id}/delete-series/

path Parameters

id

required

string

Resource identifier

Request Body schema: application/json

required

object

type required	string Value: "series-metadata"
attributes required	object

meta

object

Responses

Request samples

Payload

Content type

application/json

{"data": {"attributes": { },
"type": "series-metadata"
},
"meta": { }
}

Response samples

201
4XX

Content type

application/vnd.api+json

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

/v1/timeseries-metadata/{id}/series-types/

path Parameters

id

required

string

Resource identifier

Responses

Response samples

200

Content type

application/vnd.api+json

{"data": ["ActiveEnergyBurned"
]
}

/v1/timeseries-notifications

/v1/timeseries-notifications/

query Parameters

individual-id required	string <uuid> Example: individual-id=11111111-1111-1111-1111-111111111111
page[limit]	integer (PageLimit) [ 1 .. 1000 ] Default: 100
page[offset]	integer (PageOffset) >= 0 Default: 0

Responses

Response samples

200
4XX

Content type

application/vnd.api+json

{"data": [{"attributes": {"created-at": "string",
"individual-id": "11111111-1111-1111-1111-111111111111",
"type": "string"
},
"id": "11111111-1111-1111-1111-111111111111",
"type": "timeseries-notifications"
}
],
"meta": { }
}

/v1/timeseries-notifications/

Request Body schema: application/json

required

object

type

required

string

Value: "timeseries-notifications"

required

object

individual-id	string <uuid>
type	string Enum: "BloodGlucose" "BloodPressure" "BodyMass"

meta

object

Responses

Request samples

Payload

Content type

application/json

{"data": {"attributes": {"individual-id": "11111111-1111-1111-1111-111111111111",
"type": "BloodGlucose"
},
"type": "timeseries-notifications"
},
"meta": { }
}

Response samples

201
4XX

Content type

application/vnd.api+json

{"data": {"attributes": {"created-at": "string",
"individual-id": "11111111-1111-1111-1111-111111111111",
"type": "string"
},
"id": "11111111-1111-1111-1111-111111111111",
"type": "timeseries-notifications"
},
"meta": { }
}

/v1/timeseries-notifications/{id}/

path Parameters

id

required

string

Resource identifier

Responses

Response samples

204
4XX

Content type

application/vnd.api+json

null

/v1/timeseries-notifications/{id}/

path Parameters

id

required

string

Resource identifier

Responses

Response samples

200
4XX

Content type

application/vnd.api+json

{"data": {"attributes": {"created-at": "string",
"individual-id": "11111111-1111-1111-1111-111111111111",
"type": "string"
},
"id": "11111111-1111-1111-1111-111111111111",
"type": "timeseries-notifications"
},
"meta": { }
}

/v1/timeseries-sources

/v1/timeseries-sources/

query Parameters

individual-id required	string <uuid> Example: individual-id=11111111-1111-1111-1111-111111111111
filter[source]	string <= 255 characters
page[limit]	integer (PageLimit) [ 1 .. 1000 ] Default: 100
page[offset]	integer (PageOffset) >= 0 Default: 0

Responses

Response samples

200
4XX

Content type

application/vnd.api+json

{"data": [{"attributes": {"individual-id": "11111111-1111-1111-1111-111111111111",
"organization-id": "11111111-1111-1111-1111-111111111111",
"registered-at": "string",
"series-id": "11111111-1111-1111-1111-111111111111",
"source": "string",
"type": "string"
},
"id": "11111111-1111-1111-1111-111111111111",
"type": "timeseries-sources"
}
],
"meta": { }
}

/v1/timeseries-sources/{id}/

path Parameters

id

required

string

Resource identifier

Responses

Response samples

202
4XX

Content type

application/vnd.api+json

{"task-id": "11111111-1111-1111-1111-111111111111"
}

/v1/timeseries-sources/{id}/

path Parameters

id

required

string

Resource identifier

Responses

Response samples

200
4XX

Content type

application/vnd.api+json

{"data": {"attributes": {"individual-id": "11111111-1111-1111-1111-111111111111",
"organization-id": "11111111-1111-1111-1111-111111111111",
"registered-at": "string",
"series-id": "11111111-1111-1111-1111-111111111111",
"source": "string",
"type": "string"
},
"id": "11111111-1111-1111-1111-111111111111",
"type": "timeseries-sources"
},
"meta": { }
}

/v2/source-summaries

Creates a source-summary request

Request Body schema: application/json

required

object

type

required

string

Value: "source-summaries"

required

object

begin-datetime required	string <datetime>
end-datetime required	string <datetime>
func required	string Enum: "count" "max" "mean" "min" "sum"
individual-ids required	Array of strings <uuid> non-empty [ items <uuid > ]
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" "PollenGrassIndex" "PollenRagweedIndex" "PollenTreeIndex" "PotassiumLevel" "Pulse" "SkinTemperature" "SleepAnalysis" "Steps" "Vo2Max" "WaistCircumference" "WaterIntake"

meta

object

Responses

Request samples

Payload

Content type

application/json

{"data": {"attributes": {"begin-datetime": "string",
"end-datetime": "string",
"func": "count",
"individual-ids": ["11111111-1111-1111-1111-111111111111"
],
"type": "ActiveEnergyBurned"
},
"type": "source-summaries"
},
"meta": { }
}

Response samples

201
4XX

Content type

application/vnd.api+json

{"data": {"attributes": {"begin-datetime": "string",
"end-datetime": "string",
"error": "string",
"func": "count",
"individual-ids": ["11111111-1111-1111-1111-111111111111"
],
"last-modified-at": "string",
"result": {"values": [{"individual-id": "11111111-1111-1111-1111-111111111111",
"source": "string",
"value": 0
}
]
},
"state": "completed",
"type": "ActiveEnergyBurned"
},
"id": "11111111-1111-1111-1111-111111111111",
"type": "source-summaries"
},
"meta": { }
}

Deletes an existing source-summary request

path Parameters

id

required

string

Resource identifier

Responses

Response samples

204
4XX

Content type

application/vnd.api+json

null

Returns specific source-summary request

path Parameters

id

required

string

Resource identifier

Responses

Response samples

200
4XX

Content type

application/vnd.api+json

{"data": {"attributes": {"begin-datetime": "string",
"end-datetime": "string",
"error": "string",
"func": "count",
"individual-ids": ["11111111-1111-1111-1111-111111111111"
],
"last-modified-at": "string",
"result": {"values": [{"individual-id": "11111111-1111-1111-1111-111111111111",
"source": "string",
"value": 0
}
]
},
"state": "completed",
"type": "ActiveEnergyBurned"
},
"id": "11111111-1111-1111-1111-111111111111",
"type": "source-summaries"
},
"meta": { }
}