TRtryvital
timeseries

Note

Changed on
get/v2/timeseries/{user_id}/note/grouped

Request

  • Base URL
    https://api.us.junction.com
  • URL
    https://api.us.junction.com/v2/timeseries/{user_id}/note/grouped
  • Auth
    API key in header x-vital-api-key

Path parameters

user_idstring uuid required

Query parameters

cursorstring nullable

The cursor for fetching the next page, or null to fetch the first page.

next_cursorstring nullable

The cursor for fetching the next page, or null to fetch the first page.

providerstring

Provider oura/strava etc

start_datestring required

Date from in YYYY-MM-DD or ISO formatted date time. If a date is provided without a time, the time will be set to 00:00:00

end_datestring nullable

Date to YYYY-MM-DD or ISO formatted date time. If a date is provided without a time, the time will be set to 23:59:59

Response

Successful Response

groupsobject required

For each matching provider or lab, a list of grouped timeseries values.

nextstring nullable

The cursor for fetching the next page, or null if there is no more data.

next_cursorstring nullable

The cursor for fetching the next page, or null if there is no more data.

Example response

{
  "groups": {
    "oura": [
      {
        "data": [
          {
            "end": "2023-02-13T14:30:52+00:00",
            "start": "2023-02-13T14:30:52+00:00",
            "tags": [
              "food",
              "exercise"
            ],
            "unit": "text",
            "value": "Lorem ipsum dolor sit amet"
          }
        ],
        "source": {
          "provider": "oura",
          "type": "ring"
        }
      }
    ]
  }
}

Changes

  • 366ac8fa8d19Revision changes
    • warning

      removed the optional property //// from the response with the status

    • warning

      removed the optional property //// from the response with the status

    • warning

      removed the optional property //// from the response with the status