Skip to content

BodyTimeSeriesApi.md

Latest commit

 

History

History
166 lines (118 loc) · 8.11 KB

BodyTimeSeriesApi.md

File metadata and controls

166 lines (118 loc) · 8.11 KB

fitbit_web_api.BodyTimeSeriesApi

All URIs are relative to https://api.fitbit.com

Method HTTP request Description
get_body_resource_by_date_period GET /1/user/-/body/{resource-path}/date/{date}/{period}.json Get Body Time Series
get_body_resource_by_date_range GET /1/user/-/body/{resource-path}/date/{base-date}/{end-date}.json Get Body Time Series

get_body_resource_by_date_period

GetBodyTimeSeriesResponse get_body_resource_by_date_period(var_resource_path, var_date, period)

Get Body Time Series

Returns time series data in the specified range for a given resource in the format requested using units in the unit system that corresponds to the Accept-Language header provided.

Example

  • OAuth Authentication (oauth2):
import fitbit_web_api
from fitbit_web_api.models.get_body_time_series_response import GetBodyTimeSeriesResponse
from fitbit_web_api.rest import ApiException
from pprint import pprint

# Defining the host is optional and defaults to https://api.fitbit.com
# See configuration.py for a list of all supported configuration parameters.
configuration = fitbit_web_api.Configuration(
    host = "https://api.fitbit.com"
)

# The client must configure the authentication and authorization parameters
# in accordance with the API server security policy.
# Examples for each auth method are provided below, use the example that
# satisfies your auth use case.

configuration.access_token = os.environ["ACCESS_TOKEN"]

# Enter a context with an instance of the API client
async with fitbit_web_api.ApiClient(configuration) as api_client:
    # Create an instance of the API class
    api_instance = fitbit_web_api.BodyTimeSeriesApi(api_client)
    var_resource_path = weight # str | The resource path, which incudes the bmi, fat, or weight options. (default to weight)
    var_date = 'var_date_example' # str | The range start date in the format yyyy-MM-dd or today.
    period = 'period_example' # str | The range for which data will be returned. Options are 1d, 7d, 30d, 1w, 1m, 3m, 6m, 1y, or max.

    try:
        # Get Body Time Series
        api_response = await api_instance.get_body_resource_by_date_period(var_resource_path, var_date, period)
        print("The response of BodyTimeSeriesApi->get_body_resource_by_date_period:\n")
        pprint(api_response)
    except Exception as e:
        print("Exception when calling BodyTimeSeriesApi->get_body_resource_by_date_period: %s\n" % e)

Parameters

Name Type Description Notes
var_resource_path str The resource path, which incudes the bmi, fat, or weight options. [default to weight]
var_date str The range start date in the format yyyy-MM-dd or today.
period str The range for which data will be returned. Options are 1d, 7d, 30d, 1w, 1m, 3m, 6m, 1y, or max.

Return type

GetBodyTimeSeriesResponse

Authorization

oauth2

HTTP request headers

  • Content-Type: Not defined
  • Accept: application/json

HTTP response details

Status code Description Response headers
200 A successful request. -
400 The request had bad syntax or was inherently impossible to be satified. -
401 The request requires user authentication. -

[Back to top] [Back to API list] [Back to Model list] [Back to README]

get_body_resource_by_date_range

GetBodyTimeSeriesResponse get_body_resource_by_date_range(var_resource_path, base_date, end_date)

Get Body Time Series

Returns time series data in the specified range for a given resource in the format requested using units in the unit system that corresponds to the Accept-Language header provided.

Example

  • OAuth Authentication (oauth2):
import fitbit_web_api
from fitbit_web_api.models.get_body_time_series_response import GetBodyTimeSeriesResponse
from fitbit_web_api.rest import ApiException
from pprint import pprint

# Defining the host is optional and defaults to https://api.fitbit.com
# See configuration.py for a list of all supported configuration parameters.
configuration = fitbit_web_api.Configuration(
    host = "https://api.fitbit.com"
)

# The client must configure the authentication and authorization parameters
# in accordance with the API server security policy.
# Examples for each auth method are provided below, use the example that
# satisfies your auth use case.

configuration.access_token = os.environ["ACCESS_TOKEN"]

# Enter a context with an instance of the API client
async with fitbit_web_api.ApiClient(configuration) as api_client:
    # Create an instance of the API class
    api_instance = fitbit_web_api.BodyTimeSeriesApi(api_client)
    var_resource_path = weight # str | The resource path, which incudes the bmi, fat, or weight options. (default to weight)
    base_date = 'base_date_example' # str | The range start date in the format yyyy-MM-dd or today.
    end_date = '2013-10-20' # date | The end date of the range.

    try:
        # Get Body Time Series
        api_response = await api_instance.get_body_resource_by_date_range(var_resource_path, base_date, end_date)
        print("The response of BodyTimeSeriesApi->get_body_resource_by_date_range:\n")
        pprint(api_response)
    except Exception as e:
        print("Exception when calling BodyTimeSeriesApi->get_body_resource_by_date_range: %s\n" % e)

Parameters

Name Type Description Notes
var_resource_path str The resource path, which incudes the bmi, fat, or weight options. [default to weight]
base_date str The range start date in the format yyyy-MM-dd or today.
end_date date The end date of the range.

Return type

GetBodyTimeSeriesResponse

Authorization

oauth2

HTTP request headers

  • Content-Type: Not defined
  • Accept: application/json

HTTP response details

Status code Description Response headers
200 A successful request. -
400 The request had bad syntax or was inherently impossible to be satified. -
401 The request requires user authentication. -

[Back to top] [Back to API list] [Back to Model list] [Back to README]