Workout Swimming Stroke

curl --request GET \
     --url {{BASE_URL}}/v2/timeseries/{user_id}/workout_swimming_stroke/grouped?start_date={{START_DATE}}&end_date={{END_DATE}} \
     --header 'Accept: application/json' \
     --header 'x-vital-api-key: <API_KEY>'

{
  "groups": {
    "oura": [
      {
        "data": [
          {
            "end": "2023-02-13T14:57:24+00:00",
            "start": "2023-02-13T14:30:52+00:00",
            "timestamp": "2023-02-13T14:30:52+00:00",
            "unit": "count",
            "value": 37
          }
        ],
        "source": {
          "provider": "oura",
          "type": "ring"
        }
      }
    ]
  }
}

GET

timeseries

{user_id}

workout_swimming_stroke

grouped

curl --request GET \
     --url {{BASE_URL}}/v2/timeseries/{user_id}/workout_swimming_stroke/grouped?start_date={{START_DATE}}&end_date={{END_DATE}} \
     --header 'Accept: application/json' \
     --header 'x-vital-api-key: <API_KEY>'

{
  "groups": {
    "oura": [
      {
        "data": [
          {
            "end": "2023-02-13T14:57:24+00:00",
            "start": "2023-02-13T14:30:52+00:00",
            "timestamp": "2023-02-13T14:30:52+00:00",
            "unit": "count",
            "value": 37
          }
        ],
        "source": {
          "provider": "oura",
          "type": "ring"
        }
      }
    ]
  }
}

View Full Response Schema »

The Response section on the page still needs work. Click here to check out the complete schema.

curl --request GET \
     --url {{BASE_URL}}/v2/timeseries/{user_id}/workout_swimming_stroke/grouped?start_date={{START_DATE}}&end_date={{END_DATE}} \
     --header 'Accept: application/json' \
     --header 'x-vital-api-key: <API_KEY>'

{
  "groups": {
    "oura": [
      {
        "data": [
          {
            "end": "2023-02-13T14:57:24+00:00",
            "start": "2023-02-13T14:30:52+00:00",
            "timestamp": "2023-02-13T14:30:52+00:00",
            "unit": "count",
            "value": 37
          }
        ],
        "source": {
          "provider": "oura",
          "type": "ring"
        }
      }
    ]
  }
}

Authorizations

x-vital-api-key

string

header

required

Vital Team API Key

Path Parameters

user_id

string<uuid>

required

Query Parameters

cursor

string | null

deprecated

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

next_cursor

string | null

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

provider

string

default:""

Provider oura/strava etc Provider oura/strava etc

start_date

string

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 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_date

string | null

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 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

groups

Groups · object

required

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

Show child attributes

groups.{key}

GroupedWorkoutSwimmingStroke · object[]

Show child attributes

groups.{key}.source

Source · object

required

Source summarizes where a sample or a summary is sourced from. At minimum, the source provider is always included.

Show child attributes

groups.{key}.source.provider

string

required

Provider slug. e.g., oura, fitbit, garmin.

groups.{key}.source.type

string

default:unknown

The type of the data source (app or device) by which the summary or the timeseries data were recorded. This defaults to unknown when Vital cannot extract or infer that information

groups.{key}.source.app_id

string | null

The identifier of the app which recorded this summary. This is only applicable to multi-source providers like Apple Health and Android Health Connect.

groups.{key}.source.device_id

string<uuid> | null

The identifier of the device which recorded this summary.

groups.{key}.source.sport

string | null

For workout stream timeseries, this is the standard sport slug of the workout with which the timeseries data are associated.

For the distance timeseries, this is wheelchair_pushing if the user is a wheelchair user, or null otherwise.

For all summary types and non-workout timeseries, this is always null.

groups.{key}.source.workout_id

string<uuid> | null

For workout stream timeseries, this is the workout ID with which the timeseries data are associated.

For all other types, this is always null.

groups.{key}.source.name

string

default:""

deprecated

Deprecated. Subject to removal after 1 Jan 2024.

groups.{key}.source.slug

string

default:""

deprecated

Deprecated. Use provider instead. Subject to removal after 1 Jan 2024.

groups.{key}.source.logo

string

default:""

deprecated

Deprecated. Subject to removal after 1 Jan 2024.

Example:

{ "provider": "oura", "type": "ring" }

groups.{key}.data

ClientFacingWorkoutSwimmingStrokeSample · object[]

required

Show child attributes

groups.{key}.data.unit

string

required

Allowed value: "count"

groups.{key}.data.timestamp

string<date-time>

required

Depracated. The start time (inclusive) of the interval.

groups.{key}.data.start

string<date-time>

required

The start time (inclusive) of the interval.

groups.{key}.data.end

string<date-time>

required

The end time (exclusive) of the interval.

groups.{key}.data.value

number

required

The recorded value for the interval.

groups.{key}.data.id

integer | null

Deprecated

groups.{key}.data.timezone_offset

integer | null

Time zone UTC offset in seconds. Positive offset indicates east of UTC; negative offset indicates west of UTC; and null indicates the time zone information is unavailable at source.

groups.{key}.data.type

string | null

Type is always null for this resource.

string | null

deprecated

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

next_cursor

string | null

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

Workout Distance Sleep Apnea Alert

⌘I

Debugging

Device

Sleep

Sleep Cycle

Meal

Workouts

Profile

Activity

Body

Menstrual Cycle

Electrocardiogram

Vitals Timeseries

Body Timeseries

Activity Timeseries

Workout Stream Timeseries

Wellness Timeseries

Diary Timeseries

Nutrition Timeseries

Workout Swimming Stroke

View Full Response Schema »

Authorizations

Path Parameters

Query Parameters

Response