Skip to main content

Data Source

Follow the instructions below to create a new data flow that ingests data from an Oura Ring source in Nexla.
ouraring_api.png

Oura Ring

Create a New Data Flow​

  1. To create a new data flow, navigate to the Integrate section, and click the New Data Flow button. Then, select the desired flow type from the list, and click the Create button.

  2. Select the Oura Ring connector tile from the list of available connectors. Then, select the credential that will be used to connect to your Oura Ring account, and click Next; or, create a new Oura Ring credential for use in this flow.

  3. In Nexla, Oura Ring data sources can be created using pre-built endpoint templates, which expedite source setup for common Oura Ring endpoints. Each template is designed specifically for the corresponding Oura Ring endpoint, making source configuration easy and efficient.
    • To configure this source using a template, follow the instructions in Configure Using a Template.

    Oura Ring sources can also be configured manually, allowing you to ingest data from Oura Ring endpoints not included in the pre-built templates or apply further customizations to exactly suit your needs.
    • To configure this source manually, follow the instructions in Configure Manually.

Configure Using a Template​

Nexla provides pre-built templates that can be used to rapidly configure data sources to ingest data from common Oura Ring endpoints. Each template is designed specifically for the corresponding Oura Ring endpoint, making data source setup easy and efficient.

Endpoint Settings​

  • Select the endpoint from which this source will fetch data from the Endpoint pulldown menu. Available endpoint templates are listed in the expandable boxes below. Click on an endpoint to see more information about it and how to configure your data source for this endpoint.

    Get Daily Activity

    This endpoint template returns Oura Daily Activity data for the authenticated Oura user within a given timeframe. Use this template when you need to retrieve daily activity metrics, including steps, calories, active time, and other activity-related data from your Oura Ring device.

    • Enter the start date in the Start Date (yyyy-MM-dd) field. This should be the start date of the activities you wish to fetch (e.g., 2024-01-01). You can also use Nexla macros like {now}, {now - 1}, etc. The start date determines the beginning of the date range for which activity data will be retrieved.
    • Enter the end date in the End Date (yyyy-MM-dd) field. This should be the end date of the activities you wish to fetch (e.g., 2024-01-31). You can also use Nexla macros like {now}, {now - 1}, etc. The end date determines the end of the date range for which activity data will be retrieved.

    This endpoint returns Oura Daily Activity data for the authenticated Oura user within a given timeframe. The endpoint uses token-based pagination with next_token parameter to handle large datasets efficiently. Nexla will automatically fetch subsequent pages of data by using the next token returned in the API response.

    The activity data includes daily metrics such as steps, calories burned, active time, and other activity-related information from your Oura Ring device. For detailed information about activity data, API response structures, pagination, and available activity metrics, see the Oura Ring API documentation.

    Get Daily Sleep

    This endpoint template returns Oura Daily Sleep data for the authenticated Oura user within a given timeframe. Use this template when you need to retrieve daily sleep metrics, including sleep duration, sleep stages, sleep efficiency, and other sleep-related data from your Oura Ring device.

    • Enter the start date in the Start Date (yyyy-MM-dd) field. This should be the start date of the sleep data you wish to fetch (e.g., 2024-01-01). You can also use Nexla macros like {now}, {now - 1}, etc. The start date determines the beginning of the date range for which sleep data will be retrieved.
    • Enter the end date in the End Date (yyyy-MM-dd) field. This should be the end date of the sleep data you wish to fetch (e.g., 2024-01-31). You can also use Nexla macros like {now}, {now - 1}, etc. The end date determines the end of the date range for which sleep data will be retrieved.

    This endpoint returns Oura Daily Sleep data for the authenticated Oura user within a given timeframe. The endpoint uses token-based pagination with next_token parameter to handle large datasets efficiently. Nexla will automatically fetch subsequent pages of data by using the next token returned in the API response.

    The sleep data includes daily metrics such as sleep duration, sleep stages (deep, REM, light), sleep efficiency, and other sleep-related information from your Oura Ring device. For detailed information about sleep data, API response structures, pagination, and available sleep metrics, see the Oura Ring API documentation.

Endpoint Testing​

Once the selected endpoint template has been configured, Nexla can retrieve a sample of the data that will be fetched according to the current settings. This allows users to verify that the source is configured correctly before saving.

  • To test the current endpoint configuration, click the Test button to the right of the endpoint selection menu. Sample data will be fetched & displayed in the Endpoint Test Result panel on the right.

  • If the sample data is not as expected, review the selected endpoint and associated settings, and make any necessary adjustments. Then, click the Test button again, and check the sample data to ensure that the correct information is displayed.

Configure Manually​

Oura Ring data sources can be manually configured to ingest data from any valid Oura Ring API endpoint. Manual configuration provides maximum flexibility for accessing endpoints not covered by pre-built templates or when you need custom API configurations.

With manual configuration, you can also create more complex Oura Ring sources, such as sources that use multiple API calls or sources that require custom query parameters.

API Method​

  1. To manually configure this source, select the Advanced tab at the top of the configuration screen.

  2. Select the API method that will be used for calls to the Oura Ring API from the Method pulldown menu. Oura Ring API typically uses GET method for retrieving data from endpoints.

API Endpoint URL​

  1. Enter the URL of the Oura Ring API endpoint from which this source will fetch data in the Set API URL field. This should be the complete URL to your Oura Ring endpoint (e.g., https://cloud.ouraring.com/v2/usercollection/daily_activity?start={start_date}&end={end_date}). Include any required query parameters in the URL.

Ensure the API endpoint URL is correct and accessible with your current credentials. The Oura Ring API uses token-based pagination with next_token for some endpoints. You can test the endpoint using the Test button after configuring the URL.

Response Data Path​

  1. Enter the JSONPath expression in the Response Data Path field to specify which part of the API response should be treated as the relevant data by Nexla. For Oura Ring API responses, use $.data[*] to extract all items from the data array, depending on your endpoint.

The JSONPath expression must correctly reference the structure of your Oura Ring API response. Oura Ring API responses may have different structures depending on the endpoint. Ensure your JSONPath expression matches the structure returned by your specific endpoint. The JSONPath expression determines which data will be extracted and processed by Nexla.

Pagination (if applicable)​

  1. If your endpoint supports pagination, configure the pagination settings in the Pagination section. Oura Ring API uses token-based pagination with next_token for most endpoints. Select the pagination type that matches your endpoint's pagination mechanism.

  2. Configure the pagination parameters based on your selected pagination type. For token-based pagination, specify the JSONPath expression to the next token in the response ($.next_token) and the parameter name (next_token).

Save the Data Source​

  1. Once all of the relevant steps in the above sections have been completed, click the Next button to proceed with the rest of the data flow configuration, or click Save to save the data source configuration for later use.