# fitbit_web_api.BreathingRateIntradayApi

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

| Method                                                                                                             | HTTP request                                             | Description                             |
| ------------------------------------------------------------------------------------------------------------------ | -------------------------------------------------------- | --------------------------------------- |
| [**get_breathing_rate_intraday_by_date**](BreathingRateIntradayApi.md#get_breathing_rate_intraday_by_date)         | **GET** /1/user/-/br/date/{date}/all.json                | Get Breathing Rate Intraday by Date     |
| [**get_breathing_rate_intraday_by_interval**](BreathingRateIntradayApi.md#get_breathing_rate_intraday_by_interval) | **GET** /1/user/-/br/date/{startDate}/{endDate}/all.json | Get Breathing Rate Intraday by Interval |

# **get_breathing_rate_intraday_by_date**

> GetBreathingRateIntradayResponse get_breathing_rate_intraday_by_date(var_date)

Get Breathing Rate Intraday by Date

This endpoint returns intraday breathing rate data for a single date. It measures the average breathing rate throughout the day and categories your breathing rate by sleep stage. Sleep stages vary between light sleep, deep sleep, REM sleep, and full sleep.

### Example

- OAuth Authentication (oauth2):

```python
import fitbit_web_api
from fitbit_web_api.models.get_breathing_rate_intraday_response import GetBreathingRateIntradayResponse
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.BreathingRateIntradayApi(api_client)
    var_date = 'var_date_example' # str | The date in the format of yyyy-MM-dd or today.

    try:
        # Get Breathing Rate Intraday by Date
        api_response = await api_instance.get_breathing_rate_intraday_by_date(var_date)
        print("The response of BreathingRateIntradayApi->get_breathing_rate_intraday_by_date:\n")
        pprint(api_response)
    except Exception as e:
        print("Exception when calling BreathingRateIntradayApi->get_breathing_rate_intraday_by_date: %s\n" % e)
```

### Parameters

| Name         | Type    | Description                                    | Notes |
| ------------ | ------- | ---------------------------------------------- | ----- |
| **var_date** | **str** | The date in the format of yyyy-MM-dd or today. |

### Return type

[**GetBreathingRateIntradayResponse**](GetBreathingRateIntradayResponse.md)

### Authorization

[oauth2](../README.md#oauth2)

### HTTP request headers

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

### HTTP response details

| Status code | Description                                                       | Response headers |
| ----------- | ----------------------------------------------------------------- | ---------------- |
| **200**     | A successful request.                                             | -                |
| **401**     | The request requires user authentication.                         | -                |
| **403**     | The server understood the request, but is refusing to fulfill it. | -                |

[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md)

# **get_breathing_rate_intraday_by_interval**

> GetBreathingRateIntradayResponse get_breathing_rate_intraday_by_interval(start_date, end_date)

Get Breathing Rate Intraday by Interval

This endpoint returns intraday breathing rate data for a date range. It measures the average breathing rate throughout the day and categories your breathing rate by sleep stage. Sleep stages vary between light sleep, deep sleep, REM sleep, and full sleep.

### Example

- OAuth Authentication (oauth2):

```python
import fitbit_web_api
from fitbit_web_api.models.get_breathing_rate_intraday_response import GetBreathingRateIntradayResponse
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.BreathingRateIntradayApi(api_client)
    start_date = 'start_date_example' # str | The date in the format of yyyy-MM-dd or today.
    end_date = 'end_date_example' # str | The date in the format of yyyy-MM-dd or today.

    try:
        # Get Breathing Rate Intraday by Interval
        api_response = await api_instance.get_breathing_rate_intraday_by_interval(start_date, end_date)
        print("The response of BreathingRateIntradayApi->get_breathing_rate_intraday_by_interval:\n")
        pprint(api_response)
    except Exception as e:
        print("Exception when calling BreathingRateIntradayApi->get_breathing_rate_intraday_by_interval: %s\n" % e)
```

### Parameters

| Name           | Type    | Description                                    | Notes |
| -------------- | ------- | ---------------------------------------------- | ----- |
| **start_date** | **str** | The date in the format of yyyy-MM-dd or today. |
| **end_date**   | **str** | The date in the format of yyyy-MM-dd or today. |

### Return type

[**GetBreathingRateIntradayResponse**](GetBreathingRateIntradayResponse.md)

### Authorization

[oauth2](../README.md#oauth2)

### HTTP request headers

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

### HTTP response details

| Status code | Description                                                       | Response headers |
| ----------- | ----------------------------------------------------------------- | ---------------- |
| **200**     | A successful request.                                             | -                |
| **401**     | The request requires user authentication.                         | -                |
| **403**     | The server understood the request, but is refusing to fulfill it. | -                |

[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md)
