Skip to main content

Whoop Data Source

Follow the instructions below to create a new data flow that ingests data from a Whoop source in Nexla.
whoop_api.png

Whoop

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 Whoop connector tile from the list of available connectors. Then, select the credential that will be used to connect to the Whoop instance, and click Next; or, create a new Whoop credential for use in this flow.

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

Whoop sources can also be configured manually, allowing you to ingest data from Whoop 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 Whoop endpoints. Each template is designed specifically for the corresponding Whoop 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 Device Metrics for Team

    This endpoint template fetches device metrics for a given team from your Whoop account. Use this template when you need to access device metrics, team performance data, or device analytics for analysis, reporting, or integration purposes.

    • Enter the Team ID in the Team ID field. This should be the Team ID for fetching device metrics. This will be used for issuing a request from /enterprise-service/v1/exports?teamId=<team-id>. The Team ID determines which team's device metrics will be retrieved.
    • Enter the Metrics Date in the Metrics Date field. This should be the date value for getting metrics in yyyy-MM-dd format. You can use Nexla macros like `{now}`, `{now - 1}` etc. The default value is `{now-1}` (yesterday). The Metrics Date determines which date's metrics will be retrieved.

    This endpoint fetches device metrics for a given team from your Whoop account, including device performance data, metrics, and other device analytics. Note that clicking on the TEST button for this template will not display any data as this template processes data in a 2-step sequence for downloading a file from a generated URL.

    For detailed information about device metrics, API response structures, and available device data, see the Whoop API documentation.

    Get Recent Cycles for Users in Lookup

    This endpoint template retrieves recent cycles for a list of users stored in a Nexla lookup table. Note that this call fetches a maximum of 100 recent items per user. Use this template when you need to batch fetch cycle data for multiple users from a lookup table for analysis, reporting, or integration purposes.

    • Select the Lookup for fetching Users List from the Lookup for fetching Users List pulldown menu. This should be the Nexla Lookup that contains Users to iterate over. The Lookup determines which users will be used to fetch cycle data.
    • Enter the User ID column name in Lookup in the User ID column name in Lookup field. This should be the column name in the lookup table that contains the user IDs. The User ID column name determines which column will be used to extract user IDs from the lookup table.

    This endpoint retrieves recent cycles for a list of users stored in a Nexla lookup table, allowing you to batch fetch cycle data for multiple users efficiently. Note that this call fetches a maximum of 100 recent items per user. The endpoint iterates over the lookup table and fetches cycles for each user ID in the specified column.

    For detailed information about cycles, API response structures, and available cycle data, see the Whoop API documentation.

    Get Recent Recoveries for Users in Lookup

    This endpoint template retrieves recoveries for a list of users stored in a Nexla lookup table. Note that this call fetches a maximum of 100 recent items per user. Use this template when you need to batch fetch recovery data for multiple users from a lookup table for analysis, reporting, or integration purposes.

    • Select the Lookup for fetching Users List from the Lookup for fetching Users List pulldown menu. This should be the Nexla Lookup that contains Users to iterate over. The Lookup determines which users will be used to fetch recovery data.
    • Enter the User ID column name in Lookup in the User ID column name in Lookup field. This should be the column name in the lookup table that contains the user IDs. The User ID column name determines which column will be used to extract user IDs from the lookup table.

    This endpoint retrieves recoveries for a list of users stored in a Nexla lookup table, allowing you to batch fetch recovery data for multiple users efficiently. Note that this call fetches a maximum of 100 recent items per user. The endpoint iterates over the lookup table and fetches recoveries for each user ID in the specified column.

    For detailed information about recoveries, API response structures, and available recovery data, see the Whoop API documentation.

    Get Recent Sleeps for Users in Lookup

    This endpoint template retrieves sleeps for a list of users stored in a Nexla lookup table. Note that this call fetches a maximum of 100 recent items per user. Use this template when you need to batch fetch sleep data for multiple users from a lookup table for analysis, reporting, or integration purposes.

    • Select the Lookup for fetching Users List from the Lookup for fetching Users List pulldown menu. This should be the Nexla Lookup that contains Users to iterate over. The Lookup determines which users will be used to fetch sleep data.
    • Enter the User ID column name in Lookup in the User ID column name in Lookup field. This should be the column name in the lookup table that contains the user IDs. The User ID column name determines which column will be used to extract user IDs from the lookup table.

    This endpoint retrieves sleeps for a list of users stored in a Nexla lookup table, allowing you to batch fetch sleep data for multiple users efficiently. Note that this call fetches a maximum of 100 recent items per user. The endpoint iterates over the lookup table and fetches sleeps for each user ID in the specified column.

    For detailed information about sleeps, API response structures, and available sleep data, see the Whoop 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.

Note that clicking on the TEST button for the "Get Device Metrics for Team" template will not display any data as this template processes data in a 2-step sequence for downloading a file from a generated URL.

Configure Manually​

Whoop data sources can be manually configured to ingest data from any valid Whoop 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 Whoop sources, such as sources that use chained API calls to fetch data from multiple endpoints or sources that require custom authentication headers or request 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 Whoop API from the Method pulldown menu. The most common methods are:

    • GET: For retrieving data from the API (most common for Whoop data sources)

API Endpoint URL​

  1. Enter the URL of the Whoop API endpoint from which this source will fetch data in the Set API URL field. This should be the complete URL including the protocol (https://) and any required path parameters. Whoop API endpoints typically follow the pattern {api_url}/{service}/v1/{endpoint_path} where {api_url} is your API Server URL (e.g., https://api.prod.whoop.com).

Ensure the API endpoint URL is correct and accessible with your current credentials. You can test the endpoint using the Test button after configuring the URL. The endpoint requires Client ID/Secret Key authentication via request headers (CLIENT-ID and CLIENT-SECRET), which is handled automatically by your credential configuration.

Path to Data​

If only a subset of the data that will be returned by API endpoint is needed, you can designate the part(s) of the response that should be included in the Nexset(s) produced from this source by specifying the path to the relevant data within the response. This is particularly useful when API responses contain metadata, pagination information, or other data that you don't need for your analysis.

For example, when a request call is used to fetch a list of cycles, the API will typically return an array of cycle records, along with metadata, in the response. By entering the path to the relevant data, you can configure Nexla to treat each element of the returned array as a record.

Path to Data is essential when Whoop API responses have nested structures. Without specifying the correct path, Nexla might not be able to properly parse and organize your data into usable records.

  • To specify which data should be treated as relevant in responses from this source, enter the path to the relevant data in the Set Path to Data in Response field.

    • For responses in JSON format enter the JSON path that points to the object or array that should be treated as relevant data. JSON paths use dot notation (e.g., $[*] to access an array of items within a response object).

    • For responses in XML format, enter the XPath that points to the object/array containing relevant data. XPath uses slash notation (e.g., /response/items/item to access item elements within an items element).

    Path to Data Example:

    If the Whoop API response is in JSON format and includes a root array that contains the relevant data, the path to the response would be entered as $[*].

Autogenerate Path Suggestions​

Nexla can also autogenerate data path suggestions based on the response from the API endpoint. These suggested paths can be used as-is or modified to exactly suit your needs.

  • To use this feature, click the Test button next to the Set API URL field to fetch a sample response from the API endpoint. Suggested data paths generated based on the content & format of the response will be displayed in the Suggestions box below the Set Path to Data in Response field.

  • Click on a suggestion to automatically populate the Set Path to Data in Response field with the corresponding path. The populated path can be modified directly within the field if further customization is needed.

    PathSuggestions.png

Endpoint Testing (Manual Configuration)​

After configuring all settings for the selected endpoint, Nexla can retrieve a sample of the data that will be fetched according to the current configuration. 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.

Save & Activate the Source​

  1. Once all of the relevant steps in the above sections have been completed, click the Create button in the upper right corner of the screen to save and create the new Whoop data source. Nexla will now begin ingesting data from the configured endpoint and will organize any data that it finds into one or more Nexsets.