List records
curl --request GET \
--url https://vitalog-api.example.com/v1/records \
--header 'Authorization: Bearer <token>'import requests
url = "https://vitalog-api.example.com/v1/records"
headers = {"Authorization": "Bearer <token>"}
response = requests.get(url, headers=headers)
print(response.text)const options = {method: 'GET', headers: {Authorization: 'Bearer <token>'}};
fetch('https://vitalog-api.example.com/v1/records', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));<?php
$curl = curl_init();
curl_setopt_array($curl, [
CURLOPT_URL => "https://vitalog-api.example.com/v1/records",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "GET",
CURLOPT_HTTPHEADER => [
"Authorization: Bearer <token>"
],
]);
$response = curl_exec($curl);
$err = curl_error($curl);
curl_close($curl);
if ($err) {
echo "cURL Error #:" . $err;
} else {
echo $response;
}package main
import (
"fmt"
"net/http"
"io"
)
func main() {
url := "https://vitalog-api.example.com/v1/records"
req, _ := http.NewRequest("GET", url, nil)
req.Header.Add("Authorization", "Bearer <token>")
res, _ := http.DefaultClient.Do(req)
defer res.Body.Close()
body, _ := io.ReadAll(res.Body)
fmt.Println(string(body))
}HttpResponse<String> response = Unirest.get("https://vitalog-api.example.com/v1/records")
.header("Authorization", "Bearer <token>")
.asString();require 'uri'
require 'net/http'
url = URI("https://vitalog-api.example.com/v1/records")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Get.new(url)
request["Authorization"] = 'Bearer <token>'
response = http.request(request)
puts response.read_body{
"catalog_version": "1.0.4",
"records": [
{
"id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"record_type": "measurement",
"version": 123,
"occurred_on": "2023-12-25",
"occurred_at": "2023-11-07T05:31:56Z",
"ended_at": "2023-11-07T05:31:56Z",
"timezone": "<string>",
"time_precision": "date",
"date_basis": "reported_date",
"recorded_at": "2023-11-07T05:31:56Z",
"updated_at": "2023-11-07T05:31:56Z",
"status": "active",
"validity": "valid",
"provenance": {
"source_type": "manual",
"value_kind": "measured",
"source_description": "<string>",
"source_locator": "<string>",
"assumptions": [
"<string>"
],
"field_overrides": {}
},
"schema_version": 2,
"data": {
"kind": "scalar",
"metric_key": "weight",
"value": 123,
"unit": "<string>",
"original_value": "<string>",
"original_unit": "<string>",
"comparator": "eq",
"uncertainty": {
"note": "<string>",
"confidence_label": "<string>",
"lower": 123,
"upper": 123,
"original_value_text": "<string>"
},
"specimen": "whole_blood",
"specimen_context": {
"type": "whole_blood",
"site": "<string>",
"collection_method": "<string>",
"collection_context": "spot",
"container": "<string>",
"additive": "<string>",
"quality_flags": [
"<string>"
],
"duration_seconds": 1,
"volume": {
"kind": "quantity",
"value": 123,
"unit": "<string>",
"original_unit": "<string>",
"original_value": "<string>",
"comparator": "eq",
"reported_precision": 7
}
},
"measurement_site": "<string>",
"body_region": "<string>",
"laterality": "left",
"body_position": "seated",
"method": {
"name": "<string>",
"assay": "<string>",
"assay_version": "<string>",
"instrument": "<string>",
"model": "<string>",
"firmware_version": "<string>",
"software_version": "<string>",
"equation": "<string>",
"reference_basis": "<string>",
"calibration": "<string>"
},
"device_context": {
"name": "<string>",
"assay": "<string>",
"assay_version": "<string>",
"instrument": "<string>",
"model": "<string>",
"firmware_version": "<string>",
"software_version": "<string>",
"equation": "<string>",
"reference_basis": "<string>",
"calibration": "<string>"
},
"resting_state": "resting",
"fasting_state": "fasting",
"meal_state": "fasting",
"time_since_meal_minutes": 1,
"challenge_context": {
"label": "<string>",
"dose": {
"kind": "quantity",
"value": 123,
"unit": "<string>",
"original_unit": "<string>",
"original_value": "<string>",
"comparator": "eq",
"reported_precision": 7
},
"elapsed_seconds": 1,
"procedure": "<string>"
},
"hydration_context": "<string>",
"exercise_context": "<string>",
"oxygen_context": {
"support": "room_air",
"flow": {
"kind": "quantity",
"value": 123,
"unit": "<string>",
"original_unit": "<string>",
"original_value": "<string>",
"comparator": "eq",
"reported_precision": 7
},
"fio2": {
"kind": "quantity",
"value": 123,
"unit": "<string>",
"original_unit": "<string>",
"original_value": "<string>",
"comparator": "eq",
"reported_precision": 7
}
},
"temperature_site": "<string>",
"source_reference_range": {
"lower": 123,
"upper": 123,
"lower_inclusive": true,
"upper_inclusive": true,
"unit": "<string>",
"text": "<string>",
"age_band": {
"unit": "years",
"lower": 1,
"upper": 1
},
"sex_context": "<string>",
"specimen": "whole_blood",
"method": "<string>",
"fasting_state": "<string>",
"pregnancy_context": "<string>",
"gestational_context": "<string>",
"source_version": "<string>"
},
"reported_predicted_value": {
"kind": "quantity",
"value": 123,
"unit": "<string>",
"original_unit": "<string>",
"original_value": "<string>",
"comparator": "eq",
"reported_precision": 7
},
"reported_percent_predicted": 1,
"reported_lower_limit_normal": {
"kind": "quantity",
"value": 123,
"unit": "<string>",
"original_unit": "<string>",
"original_value": "<string>",
"comparator": "eq",
"reported_precision": 7
},
"reported_z_score": 123,
"reference_equation": {
"name": "<string>",
"assay": "<string>",
"assay_version": "<string>",
"instrument": "<string>",
"model": "<string>",
"firmware_version": "<string>",
"software_version": "<string>",
"equation": "<string>",
"reference_basis": "<string>",
"calibration": "<string>"
},
"classification_metadata": {
"frequency_hz": 1,
"conduction": "air",
"masking": true,
"corrected_vision": true,
"viewing_distance": {
"kind": "quantity",
"value": 123,
"unit": "<string>",
"original_unit": "<string>",
"original_value": "<string>",
"comparator": "eq",
"reported_precision": 7
},
"qt_correction_formula": "<string>",
"lead": "<string>",
"rhythm_context": "<string>",
"beat_context": "<string>",
"view": "<string>",
"chamber": "<string>",
"strain_convention": "<string>",
"vertebral_levels_included": [
"<string>"
],
"vertebral_levels_excluded": [
"<string>"
],
"reference_database": "<string>",
"comparison_information": "<string>",
"precision_information": "<string>",
"relaxed_flexed": "relaxed",
"landmark": "<string>",
"reading_sequence": 500000000,
"cuff_size": "<string>",
"rest_seconds": 1,
"medication_timing": "<string>",
"observation_window_seconds": 1,
"recovery_kind": "actual_heart_rate",
"recovery_interval_seconds": 1,
"recovery_mode": "active",
"bronchodilator_state": "pre",
"bronchodilator_agent": "<string>",
"bronchodilator_dose": {
"kind": "quantity",
"value": 123,
"unit": "<string>",
"original_unit": "<string>",
"original_value": "<string>",
"comparator": "eq",
"reported_precision": 7
},
"bronchodilator_elapsed_seconds": 1,
"quality_grade": "<string>",
"repeatability": "<string>",
"dlco_corrections": [
"<string>"
],
"inspired_volume": {
"kind": "quantity",
"value": 123,
"unit": "<string>",
"original_unit": "<string>",
"original_value": "<string>",
"comparator": "eq",
"reported_precision": 7
},
"protocol": "<string>",
"test_duration_seconds": 1,
"assistance": "<string>",
"walking_aid": "<string>",
"attempt_number": 500000000
},
"source_status": "preliminary",
"related_record_ids": [
{
"record_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"relationship": "same_event"
}
],
"notes": "<string>"
},
"time_context": {
"original_occurred_at": "2023-11-07T05:31:56Z",
"original_ended_at": "2023-11-07T05:31:56Z",
"supplied_timezone": "<string>"
},
"attachment_ids": [
"3c90c3cc-0d44-4b50-8888-8dd25736052a"
]
}
],
"returned_count": 500000000,
"has_more": true,
"next_cursor": "<string>"
}{
"code": "VALIDATION_ERROR",
"message": "<string>",
"catalog_version": "<string>",
"issues": [
{
"path": "<string>",
"reason": "<string>",
"message": "<string>",
"suggested_keys": [
"<string>"
],
"discovery": {}
}
],
"existing_id": "<string>",
"current_version": 123,
"current_catalog_version": "<string>"
}{
"code": "VALIDATION_ERROR",
"message": "<string>",
"catalog_version": "<string>",
"issues": [
{
"path": "<string>",
"reason": "<string>",
"message": "<string>",
"suggested_keys": [
"<string>"
],
"discovery": {}
}
],
"existing_id": "<string>",
"current_version": 123,
"current_catalog_version": "<string>"
}{
"code": "VALIDATION_ERROR",
"message": "<string>",
"catalog_version": "<string>",
"issues": [
{
"path": "<string>",
"reason": "<string>",
"message": "<string>",
"suggested_keys": [
"<string>"
],
"discovery": {}
}
],
"existing_id": "<string>",
"current_version": 123,
"current_catalog_version": "<string>"
}{
"code": "VALIDATION_ERROR",
"message": "<string>",
"catalog_version": "<string>",
"issues": [
{
"path": "<string>",
"reason": "<string>",
"message": "<string>",
"suggested_keys": [
"<string>"
],
"discovery": {}
}
],
"existing_id": "<string>",
"current_version": 123,
"current_catalog_version": "<string>"
}{
"code": "VALIDATION_ERROR",
"message": "<string>",
"catalog_version": "<string>",
"issues": [
{
"path": "<string>",
"reason": "<string>",
"message": "<string>",
"suggested_keys": [
"<string>"
],
"discovery": {}
}
],
"existing_id": "<string>",
"current_version": 123,
"current_catalog_version": "<string>"
}{
"code": "VALIDATION_ERROR",
"message": "<string>",
"catalog_version": "<string>",
"issues": [
{
"path": "<string>",
"reason": "<string>",
"message": "<string>",
"suggested_keys": [
"<string>"
],
"discovery": {}
}
],
"existing_id": "<string>",
"current_version": 123,
"current_catalog_version": "<string>"
}{
"code": "VALIDATION_ERROR",
"message": "<string>",
"catalog_version": "<string>",
"issues": [
{
"path": "<string>",
"reason": "<string>",
"message": "<string>",
"suggested_keys": [
"<string>"
],
"discovery": {}
}
],
"existing_id": "<string>",
"current_version": 123,
"current_catalog_version": "<string>"
}{
"code": "VALIDATION_ERROR",
"message": "<string>",
"catalog_version": "<string>",
"issues": [
{
"path": "<string>",
"reason": "<string>",
"message": "<string>",
"suggested_keys": [
"<string>"
],
"discovery": {}
}
],
"existing_id": "<string>",
"current_version": 123,
"current_catalog_version": "<string>"
}{
"code": "VALIDATION_ERROR",
"message": "<string>",
"catalog_version": "<string>",
"issues": [
{
"path": "<string>",
"reason": "<string>",
"message": "<string>",
"suggested_keys": [
"<string>"
],
"discovery": {}
}
],
"existing_id": "<string>",
"current_version": 123,
"current_catalog_version": "<string>"
}{
"code": "VALIDATION_ERROR",
"message": "<string>",
"catalog_version": "<string>",
"issues": [
{
"path": "<string>",
"reason": "<string>",
"message": "<string>",
"suggested_keys": [
"<string>"
],
"discovery": {}
}
],
"existing_id": "<string>",
"current_version": 123,
"current_catalog_version": "<string>"
}List records
Page through recorded observations using allowlisted dates, types and source filters; no arbitrary predicates.
GET
/
v1
/
records
List records
curl --request GET \
--url https://vitalog-api.example.com/v1/records \
--header 'Authorization: Bearer <token>'import requests
url = "https://vitalog-api.example.com/v1/records"
headers = {"Authorization": "Bearer <token>"}
response = requests.get(url, headers=headers)
print(response.text)const options = {method: 'GET', headers: {Authorization: 'Bearer <token>'}};
fetch('https://vitalog-api.example.com/v1/records', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));<?php
$curl = curl_init();
curl_setopt_array($curl, [
CURLOPT_URL => "https://vitalog-api.example.com/v1/records",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "GET",
CURLOPT_HTTPHEADER => [
"Authorization: Bearer <token>"
],
]);
$response = curl_exec($curl);
$err = curl_error($curl);
curl_close($curl);
if ($err) {
echo "cURL Error #:" . $err;
} else {
echo $response;
}package main
import (
"fmt"
"net/http"
"io"
)
func main() {
url := "https://vitalog-api.example.com/v1/records"
req, _ := http.NewRequest("GET", url, nil)
req.Header.Add("Authorization", "Bearer <token>")
res, _ := http.DefaultClient.Do(req)
defer res.Body.Close()
body, _ := io.ReadAll(res.Body)
fmt.Println(string(body))
}HttpResponse<String> response = Unirest.get("https://vitalog-api.example.com/v1/records")
.header("Authorization", "Bearer <token>")
.asString();require 'uri'
require 'net/http'
url = URI("https://vitalog-api.example.com/v1/records")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Get.new(url)
request["Authorization"] = 'Bearer <token>'
response = http.request(request)
puts response.read_body{
"catalog_version": "1.0.4",
"records": [
{
"id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"record_type": "measurement",
"version": 123,
"occurred_on": "2023-12-25",
"occurred_at": "2023-11-07T05:31:56Z",
"ended_at": "2023-11-07T05:31:56Z",
"timezone": "<string>",
"time_precision": "date",
"date_basis": "reported_date",
"recorded_at": "2023-11-07T05:31:56Z",
"updated_at": "2023-11-07T05:31:56Z",
"status": "active",
"validity": "valid",
"provenance": {
"source_type": "manual",
"value_kind": "measured",
"source_description": "<string>",
"source_locator": "<string>",
"assumptions": [
"<string>"
],
"field_overrides": {}
},
"schema_version": 2,
"data": {
"kind": "scalar",
"metric_key": "weight",
"value": 123,
"unit": "<string>",
"original_value": "<string>",
"original_unit": "<string>",
"comparator": "eq",
"uncertainty": {
"note": "<string>",
"confidence_label": "<string>",
"lower": 123,
"upper": 123,
"original_value_text": "<string>"
},
"specimen": "whole_blood",
"specimen_context": {
"type": "whole_blood",
"site": "<string>",
"collection_method": "<string>",
"collection_context": "spot",
"container": "<string>",
"additive": "<string>",
"quality_flags": [
"<string>"
],
"duration_seconds": 1,
"volume": {
"kind": "quantity",
"value": 123,
"unit": "<string>",
"original_unit": "<string>",
"original_value": "<string>",
"comparator": "eq",
"reported_precision": 7
}
},
"measurement_site": "<string>",
"body_region": "<string>",
"laterality": "left",
"body_position": "seated",
"method": {
"name": "<string>",
"assay": "<string>",
"assay_version": "<string>",
"instrument": "<string>",
"model": "<string>",
"firmware_version": "<string>",
"software_version": "<string>",
"equation": "<string>",
"reference_basis": "<string>",
"calibration": "<string>"
},
"device_context": {
"name": "<string>",
"assay": "<string>",
"assay_version": "<string>",
"instrument": "<string>",
"model": "<string>",
"firmware_version": "<string>",
"software_version": "<string>",
"equation": "<string>",
"reference_basis": "<string>",
"calibration": "<string>"
},
"resting_state": "resting",
"fasting_state": "fasting",
"meal_state": "fasting",
"time_since_meal_minutes": 1,
"challenge_context": {
"label": "<string>",
"dose": {
"kind": "quantity",
"value": 123,
"unit": "<string>",
"original_unit": "<string>",
"original_value": "<string>",
"comparator": "eq",
"reported_precision": 7
},
"elapsed_seconds": 1,
"procedure": "<string>"
},
"hydration_context": "<string>",
"exercise_context": "<string>",
"oxygen_context": {
"support": "room_air",
"flow": {
"kind": "quantity",
"value": 123,
"unit": "<string>",
"original_unit": "<string>",
"original_value": "<string>",
"comparator": "eq",
"reported_precision": 7
},
"fio2": {
"kind": "quantity",
"value": 123,
"unit": "<string>",
"original_unit": "<string>",
"original_value": "<string>",
"comparator": "eq",
"reported_precision": 7
}
},
"temperature_site": "<string>",
"source_reference_range": {
"lower": 123,
"upper": 123,
"lower_inclusive": true,
"upper_inclusive": true,
"unit": "<string>",
"text": "<string>",
"age_band": {
"unit": "years",
"lower": 1,
"upper": 1
},
"sex_context": "<string>",
"specimen": "whole_blood",
"method": "<string>",
"fasting_state": "<string>",
"pregnancy_context": "<string>",
"gestational_context": "<string>",
"source_version": "<string>"
},
"reported_predicted_value": {
"kind": "quantity",
"value": 123,
"unit": "<string>",
"original_unit": "<string>",
"original_value": "<string>",
"comparator": "eq",
"reported_precision": 7
},
"reported_percent_predicted": 1,
"reported_lower_limit_normal": {
"kind": "quantity",
"value": 123,
"unit": "<string>",
"original_unit": "<string>",
"original_value": "<string>",
"comparator": "eq",
"reported_precision": 7
},
"reported_z_score": 123,
"reference_equation": {
"name": "<string>",
"assay": "<string>",
"assay_version": "<string>",
"instrument": "<string>",
"model": "<string>",
"firmware_version": "<string>",
"software_version": "<string>",
"equation": "<string>",
"reference_basis": "<string>",
"calibration": "<string>"
},
"classification_metadata": {
"frequency_hz": 1,
"conduction": "air",
"masking": true,
"corrected_vision": true,
"viewing_distance": {
"kind": "quantity",
"value": 123,
"unit": "<string>",
"original_unit": "<string>",
"original_value": "<string>",
"comparator": "eq",
"reported_precision": 7
},
"qt_correction_formula": "<string>",
"lead": "<string>",
"rhythm_context": "<string>",
"beat_context": "<string>",
"view": "<string>",
"chamber": "<string>",
"strain_convention": "<string>",
"vertebral_levels_included": [
"<string>"
],
"vertebral_levels_excluded": [
"<string>"
],
"reference_database": "<string>",
"comparison_information": "<string>",
"precision_information": "<string>",
"relaxed_flexed": "relaxed",
"landmark": "<string>",
"reading_sequence": 500000000,
"cuff_size": "<string>",
"rest_seconds": 1,
"medication_timing": "<string>",
"observation_window_seconds": 1,
"recovery_kind": "actual_heart_rate",
"recovery_interval_seconds": 1,
"recovery_mode": "active",
"bronchodilator_state": "pre",
"bronchodilator_agent": "<string>",
"bronchodilator_dose": {
"kind": "quantity",
"value": 123,
"unit": "<string>",
"original_unit": "<string>",
"original_value": "<string>",
"comparator": "eq",
"reported_precision": 7
},
"bronchodilator_elapsed_seconds": 1,
"quality_grade": "<string>",
"repeatability": "<string>",
"dlco_corrections": [
"<string>"
],
"inspired_volume": {
"kind": "quantity",
"value": 123,
"unit": "<string>",
"original_unit": "<string>",
"original_value": "<string>",
"comparator": "eq",
"reported_precision": 7
},
"protocol": "<string>",
"test_duration_seconds": 1,
"assistance": "<string>",
"walking_aid": "<string>",
"attempt_number": 500000000
},
"source_status": "preliminary",
"related_record_ids": [
{
"record_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"relationship": "same_event"
}
],
"notes": "<string>"
},
"time_context": {
"original_occurred_at": "2023-11-07T05:31:56Z",
"original_ended_at": "2023-11-07T05:31:56Z",
"supplied_timezone": "<string>"
},
"attachment_ids": [
"3c90c3cc-0d44-4b50-8888-8dd25736052a"
]
}
],
"returned_count": 500000000,
"has_more": true,
"next_cursor": "<string>"
}{
"code": "VALIDATION_ERROR",
"message": "<string>",
"catalog_version": "<string>",
"issues": [
{
"path": "<string>",
"reason": "<string>",
"message": "<string>",
"suggested_keys": [
"<string>"
],
"discovery": {}
}
],
"existing_id": "<string>",
"current_version": 123,
"current_catalog_version": "<string>"
}{
"code": "VALIDATION_ERROR",
"message": "<string>",
"catalog_version": "<string>",
"issues": [
{
"path": "<string>",
"reason": "<string>",
"message": "<string>",
"suggested_keys": [
"<string>"
],
"discovery": {}
}
],
"existing_id": "<string>",
"current_version": 123,
"current_catalog_version": "<string>"
}{
"code": "VALIDATION_ERROR",
"message": "<string>",
"catalog_version": "<string>",
"issues": [
{
"path": "<string>",
"reason": "<string>",
"message": "<string>",
"suggested_keys": [
"<string>"
],
"discovery": {}
}
],
"existing_id": "<string>",
"current_version": 123,
"current_catalog_version": "<string>"
}{
"code": "VALIDATION_ERROR",
"message": "<string>",
"catalog_version": "<string>",
"issues": [
{
"path": "<string>",
"reason": "<string>",
"message": "<string>",
"suggested_keys": [
"<string>"
],
"discovery": {}
}
],
"existing_id": "<string>",
"current_version": 123,
"current_catalog_version": "<string>"
}{
"code": "VALIDATION_ERROR",
"message": "<string>",
"catalog_version": "<string>",
"issues": [
{
"path": "<string>",
"reason": "<string>",
"message": "<string>",
"suggested_keys": [
"<string>"
],
"discovery": {}
}
],
"existing_id": "<string>",
"current_version": 123,
"current_catalog_version": "<string>"
}{
"code": "VALIDATION_ERROR",
"message": "<string>",
"catalog_version": "<string>",
"issues": [
{
"path": "<string>",
"reason": "<string>",
"message": "<string>",
"suggested_keys": [
"<string>"
],
"discovery": {}
}
],
"existing_id": "<string>",
"current_version": 123,
"current_catalog_version": "<string>"
}{
"code": "VALIDATION_ERROR",
"message": "<string>",
"catalog_version": "<string>",
"issues": [
{
"path": "<string>",
"reason": "<string>",
"message": "<string>",
"suggested_keys": [
"<string>"
],
"discovery": {}
}
],
"existing_id": "<string>",
"current_version": 123,
"current_catalog_version": "<string>"
}{
"code": "VALIDATION_ERROR",
"message": "<string>",
"catalog_version": "<string>",
"issues": [
{
"path": "<string>",
"reason": "<string>",
"message": "<string>",
"suggested_keys": [
"<string>"
],
"discovery": {}
}
],
"existing_id": "<string>",
"current_version": 123,
"current_catalog_version": "<string>"
}{
"code": "VALIDATION_ERROR",
"message": "<string>",
"catalog_version": "<string>",
"issues": [
{
"path": "<string>",
"reason": "<string>",
"message": "<string>",
"suggested_keys": [
"<string>"
],
"discovery": {}
}
],
"existing_id": "<string>",
"current_version": 123,
"current_catalog_version": "<string>"
}{
"code": "VALIDATION_ERROR",
"message": "<string>",
"catalog_version": "<string>",
"issues": [
{
"path": "<string>",
"reason": "<string>",
"message": "<string>",
"suggested_keys": [
"<string>"
],
"discovery": {}
}
],
"existing_id": "<string>",
"current_version": 123,
"current_catalog_version": "<string>"
}Authorizations
staticKeyapiKeybrowserSession
Environment AUTH_KEY. Full ledger access and primary API-key administration. Not OAuth or JWT.
Query Parameters
Exactly one parameter; booleans are true/false, arrays are comma-separated. Empty values are rejected.
Required array length:
1 - 8 elementsAvailable options:
measurement, nutrition, hydration, activity, sleep, checkin, intake, lab_result Exactly one parameter; booleans are true/false, arrays are comma-separated. Empty values are rejected.
Pattern:
^(?:(?:\d\d[2468][048]|\d\d[13579][26]|\d\d0[48]|[02468][048]00|[13579][26]00)-02-29|\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\d|30)|(?:02)-(?:0[1-9]|1\d|2[0-8])))$Exactly one parameter; booleans are true/false, arrays are comma-separated. Empty values are rejected.
Pattern:
^(?:(?:\d\d[2468][048]|\d\d[13579][26]|\d\d0[48]|[02468][048]00|[13579][26]00)-02-29|\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\d|30)|(?:02)-(?:0[1-9]|1\d|2[0-8])))$Exactly one parameter; booleans are true/false, arrays are comma-separated. Empty values are rejected.
Exactly one parameter; booleans are true/false, arrays are comma-separated. Empty values are rejected.
Available options:
manual, device, laboratory, calculated, other Exactly one parameter; booleans are true/false, arrays are comma-separated. Empty values are rejected.
Required string length:
1 - 200Exactly one parameter; booleans are true/false, arrays are comma-separated. Empty values are rejected.
Available options:
valid, suspect, invalid Exactly one parameter; booleans are true/false, arrays are comma-separated. Empty values are rejected.
Available options:
active, voided, all Exactly one parameter; booleans are true/false, arrays are comma-separated. Empty values are rejected.
Available options:
weight, height, waist_circumference, hip_circumference, chest_circumference, neck_circumference, upper_arm_circumference, thigh_circumference, calf_circumference, body_fat_percent, fat_mass, lean_mass, fat_free_mass, skeletal_muscle_mass, appendicular_lean_mass, body_water_percent, total_body_water, intracellular_water, extracellular_water, extracellular_total_water_ratio, visceral_fat_area, visceral_fat_level, segmental_fat_mass, segmental_lean_mass, segmental_body_fat_percent, phase_angle, skinfold_thickness, bmi, waist_hip_ratio, waist_height_ratio, fat_mass_index, fat_free_mass_index, appendicular_lean_mass_index, body_surface_area, blood_pressure, heart_rate, heart_rate_recovery, hrv_sdnn, hrv_rmssd, hrv_pnn50, pulse_pressure, mean_arterial_pressure, pulse_wave_velocity, ankle_brachial_index, pr_interval, qrs_duration, qt_interval, qtc_interval, p_axis, qrs_axis, t_axis, atrial_fibrillation_burden, premature_ventricular_contraction_count, left_ventricular_ejection_fraction, global_longitudinal_strain, oxygen_saturation, respiratory_rate, body_temperature, skin_temperature, skin_temperature_deviation, peripheral_perfusion_index, peak_expiratory_flow, fev1, fvc, fev1_fvc_ratio, fev1_vc_ratio, fef25_75, slow_vital_capacity, total_lung_capacity, residual_volume, functional_residual_capacity, diffusing_capacity_co, carbon_monoxide_transfer_coefficient, fractional_exhaled_nitric_oxide, blood_glucose, interstitial_glucose, blood_beta_hydroxybutyrate, blood_ketones, breath_acetone, vo2_max_absolute, vo2_max_relative, ventilatory_threshold_oxygen_uptake, ventilatory_threshold_heart_rate, ventilatory_threshold_power, grip_strength, gait_speed, six_minute_walk_distance, timed_up_and_go_duration, sit_to_stand_repetitions, sit_to_stand_duration, single_leg_stance_duration, bone_mineral_density_areal, bone_mineral_content, bone_density_t_score, bone_density_z_score, visual_acuity_snellen, visual_acuity_logmar, intraocular_pressure, spherical_refraction, cylindrical_refraction, refraction_axis, hearing_threshold, cgm_summary, ambulatory_bp_summary, spirometry_summary, body_composition_summary, dxa_summary, ecg_summary, echocardiography_summary, functional_test_summary Exactly one parameter; booleans are true/false, arrays are comma-separated. Empty values are rejected.
Available options:
acth, active_b12_holotranscobalamin, albumin, albumin_globulin_ratio, aldosterone, aldosterone_renin_ratio, allergen_specific_ige, alp, alpha_fetoprotein, alt, aluminum, amh, ammonia, amylase, ana_pattern, ana_screen, ana_titer, anca_pattern, anca_screen, anca_titer, androstenedione, anion_gap, anti_beta2_glycoprotein_igg, anti_beta2_glycoprotein_igm, anti_cardiolipin_igg, anti_cardiolipin_igm, anti_ccp, anti_centromere, anti_dsdna, anti_factor_xa, anti_jo1, anti_mpo, anti_pr3, anti_rnp, anti_scl70, anti_smith, anti_ssa_ro, anti_ssb_la, antimicrobial_susceptibility, antithrombin_activity, apob_apoa1_ratio, apolipoprotein_a1, apolipoprotein_b, aptt, aptt_ratio, arsenic_inorganic, arsenic_total, ast, ast_alt_ratio, band_neutrophils_absolute, band_neutrophils_percent, base_excess, basophils_absolute, basophils_percent, beta2_microglobulin, beta_carotene, beta_ctx, beta_hydroxybutyrate, bicarbonate, bile_acids_total, bilirubin_direct, bilirubin_indirect, bilirubin_total, blood_gas_bicarbonate_standard, blood_gas_ph, blood_glucose, blood_group_abo, blood_ketones, bnp, bone_specific_alp, bun, bun_creatinine_ratio, c3_complement, c4_complement, c_peptide, ca_125, ca_15_3, ca_19_9, cadmium, calcitonin, calcium_ionized, calcium_total, calculated_osmolality, carbamazepine, carbon_dioxide_total, carboxyhemoglobin, cea, ceruloplasmin, ch50, chloride, chromium, ck_mb_activity, ck_mb_mass, copper, cortisol, cotinine, creatine_kinase, creatinine, creatinine_clearance, crp, cyclosporine, cystatin_c, d_dimer_ddu, d_dimer_feu, deamidated_gliadin_peptide_iga, deamidated_gliadin_peptide_igg, dengue_igg, dengue_igm, dengue_ns1_antigen, dheas, digoxin, direct_antiglobulin_test, drvvt_confirm_ratio, drvvt_screen_ratio, egfr, egfr_creatinine_cystatin_c, egfr_cystatin_c, endomysial_antibody_iga, eosinophils_absolute, eosinophils_percent, esr, estimated_average_glucose, estradiol, ethanol, fecal_calprotectin, fecal_fat_24h, fecal_fat_qualitative, fecal_lactoferrin, fecal_pancreatic_elastase, ferritin, fib4_reported, fibrin_degradation_products, fibrinogen_activity, fibrinogen_antigen, folate_rbc, folate_serum, free_t3, free_t4, fructosamine, fsh, g6pd_activity, gastrin, gastrointestinal_pathogen_pcr, gentamicin, ggt, globulin, glycated_albumin, growth_hormone, haptoglobin, hba1c, hcg_qualitative, hcg_quantitative, hdl_cholesterol, hdl_particle_number, hematocrit, hemoglobin, hemoglobin_a2_percent, hemoglobin_a_percent, hemoglobin_c_percent, hemoglobin_e_percent, hemoglobin_f_percent, hemoglobin_s_percent, hemoglobin_variant_identification, hemolysis_index, hepatitis_a_antibody_total, hepatitis_a_igm, hepatitis_b_core_antibody_igm, hepatitis_b_core_antibody_total, hepatitis_b_dna, hepatitis_b_e_antibody, hepatitis_b_e_antigen, hepatitis_b_surface_antibody, hepatitis_b_surface_antigen, hepatitis_c_antibody, hepatitis_c_rna, hiv_1_2_antigen_antibody, hiv_1_antibody, hiv_1_rna, hiv_2_antibody, homa_ir_reported, homocysteine, hs_crp, hs_troponin_i, hs_troponin_t, icterus_index, igf_1, immature_granulocytes_absolute, immature_granulocytes_percent, immature_reticulocyte_fraction, immunoglobulin_a, immunoglobulin_e_total, immunoglobulin_g, immunoglobulin_g1, immunoglobulin_g2, immunoglobulin_g3, immunoglobulin_g4, immunoglobulin_m, inhibin_b, inr, insulin, iodine, ionized_calcium_blood_gas, iron, lactate, ldh, ldl_cholesterol, ldl_hdl_ratio, ldl_particle_number, ldl_particle_size, lead, lh, lipase, lipemia_index, lipoprotein_a_mass, lipoprotein_a_molar, lithium, lupus_anticoagulant_screen, lymphocytes_absolute, lymphocytes_percent, magnesium, magnesium_rbc, malaria_parasite_test, manganese, mch, mchc, mcv, measured_osmolality, mercury_total, metanephrine_free, methemoglobin, methylmalonic_acid, molybdenum, monocytes_absolute, monocytes_percent, mpv, myoglobin, neutrophils_absolute, neutrophils_percent, non_hdl_cholesterol, normetanephrine_free, nt_probnp, nucleated_rbc_absolute, nucleated_rbc_per_100_wbc, organism_culture_identification, osteocalcin, oxygen_content, oxygen_saturation_blood_gas, pancreatic_amylase, parathyroid_hormone_intact, parathyroid_hormone_whole, partial_pressure_carbon_dioxide, partial_pressure_oxygen, pathogen_nucleic_acid, pdw, peripheral_smear_findings, phenytoin_free, phenytoin_total, phosphate, platelet_count, platelet_large_cell_ratio, platelet_morphology, plateletcrit, potassium, prealbumin, procalcitonin, procollagen_type_1_n_terminal_propeptide, progesterone, prolactin, protein_c_activity, protein_s_activity, prothrombin_time, psa_free, psa_free_total_ratio, psa_total, rbc_count, rbc_morphology, rdw_cv, rdw_sd, red_cell_antibody_identification, red_cell_antibody_screen, remnant_cholesterol, renin_activity, renin_concentration, respiratory_pathogen_pcr, reticulocyte_hemoglobin, reticulocytes_absolute, reticulocytes_percent, reverse_t3, rhd_type, rheumatoid_factor, rpr_qualitative, rpr_titer, selenium, semen_leukocytes, semen_liquefaction_time, semen_ph, semen_viscosity, semen_volume, seventeen_hydroxyprogesterone, shbg, sirolimus, small_ldl_particle_number, sodium, soluble_transferrin_receptor, sperm_agglutination, sperm_concentration, sperm_dna_fragmentation_index, sperm_immotile_percent, sperm_nonprogressive_motility, sperm_normal_morphology, sperm_progressive_motility, sperm_total_count, sperm_total_motility, sperm_vitality, stool_clostridioides_difficile_toxin, stool_collection_duration, stool_collection_mass, stool_helicobacter_pylori_antigen, stool_hemoglobin_fit, stool_occult_blood_guaiac, stool_ova_parasites, stool_ph, stool_rbc, stool_reducing_substances, stool_wbc, syphilis_treponemal_antibody, tacrolimus, testosterone_bioavailable, testosterone_free, testosterone_total, thrombin_time, thyroglobulin, thyroglobulin_antibodies, thyroid_stimulating_immunoglobulin, tibc, tissue_transglutaminase_iga, tissue_transglutaminase_igg, total_cholesterol, total_cholesterol_hdl_ratio, total_protein, total_t3, total_t4, tpo_antibodies, transferrin, transferrin_saturation, triglyceride_hdl_ratio, triglycerides, troponin_i, troponin_t, tsh, tsh_receptor_antibodies, uibc, urea, uric_acid, urine_albumin, urine_albumin_creatinine_ratio, urine_albumin_excretion_rate, urine_bacteria, urine_bilirubin, urine_blood, urine_calcium_24h, urine_calcium_concentration, urine_clarity, urine_collection_duration, urine_collection_volume, urine_color, urine_cortisol_free_24h, urine_creatinine, urine_creatinine_24h, urine_crystals, urine_glucose, urine_granular_casts, urine_hyaline_casts, urine_ketones, urine_leukocyte_esterase, urine_mucus, urine_nitrite, urine_osmolality, urine_ph, urine_phosphate_24h, urine_phosphate_concentration, urine_potassium_24h, urine_potassium_concentration, urine_protein, urine_protein_24h, urine_protein_concentration, urine_protein_creatinine_ratio, urine_rbc, urine_rbc_casts, urine_renal_epithelial_cells, urine_sodium_24h, urine_sodium_concentration, urine_specific_gravity, urine_squamous_epithelial_cells, urine_transitional_epithelial_cells, urine_urea_nitrogen_24h, urine_uric_acid_24h, urine_uric_acid_concentration, urine_urobilinogen, urine_waxy_casts, urine_wbc, urine_wbc_casts, urine_yeast, valproic_acid_free, valproic_acid_total, vancomycin, vitamin_a_retinol, vitamin_b12, vitamin_b1_thiamine, vitamin_b1_thiamine_diphosphate, vitamin_b2_riboflavin, vitamin_b6_pyridoxal_phosphate, vitamin_c, vitamin_d_1_25_dihydroxy, vitamin_d_25_oh_d2, vitamin_d_25_oh_d3, vitamin_d_25_oh_total, vitamin_e_alpha_tocopherol, vitamin_e_gamma_tocopherol, vitamin_k1, vldl_cholesterol, wbc_count, wbc_morphology, zinc Exactly one parameter; booleans are true/false, arrays are comma-separated. Empty values are rejected.
Required string length:
1 - 100Exactly one parameter; booleans are true/false, arrays are comma-separated. Empty values are rejected.
Required range:
1 <= x <= 200Exactly one parameter; booleans are true/false, arrays are comma-separated. Empty values are rejected.
Required string length:
1 - 2000Response
Successful domain response
Allowed value:
"1.0.4"Maximum array length:
200- Option 1
- Option 2
- Option 3
- Option 4
- Option 5
- Option 6
- Option 7
- Option 8
- Option 9
Show child attributes
Show child attributes
Required range:
0 <= x <= 1000000000Required string length:
1 - 2000Was this page helpful?