Receiving results via API polling

Use /bioage endpoint to request users' biological age accelerations after it was calculated.

GET /api/v1.1/bioage

Query Parameters

Name	Type	Description
model_type*	String	Model to use. Either steps or bpm (for heart rate)
device_name*	String	A unique device name like iPhone or Apple Watch
from_date*	String	Start of the requested period. In YYYY-MM-DD format
to_date*	String	End of the requested period. In YYYY-MM-DD format

Headers

Name	Type	Description
Authorization*	String	Bearer <token>
Content-Type*	String	application/json

200: OK Biological age accelerations calculations were done for user

404: Not Found Biological age accelerations calculations were not found for user

REQUEST (EXAMPLE)

 curl 'https://<api-proxy-hostname>/api/v1.1/bioage?model_type=steps&device_name=iPhone&from_date=2023-11-01&to_date=2023-11-11' \
      -H 'accept: application/json' \
      -H 'Authorization: Bearer <token>' \
      -H 'Content-Type: application/json'

200 – RESPONSE (EXAMPLE)

{
  "user_id": "85b4453a-46de-484c-bbc2-12666ebc7ed9",
  "device_name": "iphone",
  "model_type": "steps",
  "bioage": [
    ...
    {"date": "2023-11-06", "value": null},
    {"date": "2023-11-07", "value": 2.68},
    {"date": "2023-11-08", "value": 2.87},
    {"date": "2023-11-09", "value": 2.42},
    {"date": "2023-11-10", "value": 3.21},
    ...
  ]
}

The null value inside bioage array is reserved for cases, when it was not enough data to calculate biological age acceleration for this day.