Withings API icon

Withings API

Withings API Integration

Actions11

User → Get Goals

AI-generated

Overview

This node interacts with the Withings API to retrieve user goals data. It supports authentication via OAuth2 credentials or a manual access token. Users can specify additional parameters such as start date, end date, last update timestamp, and offset to filter the goals data retrieved. This node is useful for applications that need to monitor or analyze user fitness or health goals tracked by Withings devices.

Use Case Examples

  1. A fitness app fetching user goals to display progress towards weight loss or activity targets.
  2. A health monitoring system retrieving user goals to customize notifications or recommendations.

Properties

Name Meaning
Authentication Method Specifies how to authenticate with the Withings API, either using stored OAuth2 credentials or a manual token from a previous node.
Access Token (From Previous Node) The access token used for manual authentication, typically obtained from a token exchange node.
Additional Fields Optional parameters to filter the data retrieval, including start date, end date, last update timestamp, and offset for pagination.

Output

JSON

  • success - Indicates if the API call was successful.
  • resource - The resource type, here it will be 'user'.
  • operation - The operation performed, here 'getgoals'.
  • body - The raw response body from the Withings API containing the user goals data.
  • data - Alternative field containing the user goals data if 'body' is not present.

Dependencies

  • Withings API
  • OAuth2 credentials or manual access token

Troubleshooting

  • Common issues include expired or invalid tokens, which result in authentication errors. Refreshing OAuth2 tokens or providing a valid manual token resolves these issues.
  • API errors with status codes and messages are returned if the request parameters are invalid or the API service is unavailable.
  • Ensure the timestamps for start date, end date, and last update are correctly formatted as UNIX timestamps to avoid errors.

Links

Discussion