Withings API icon

Withings API

Withings API Integration

Actions11

Activity → Get Summary

AI-generated

Overview

This node interacts with the Withings API to retrieve a summary of user activity 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 customize the data retrieval. This node is useful for scenarios where you want to fetch summarized activity metrics like steps, calories burned, or distance covered over a specified period.

Use Case Examples

  1. Fetching a weekly summary of user activity data for health monitoring.
  2. Retrieving activity summaries to integrate with fitness dashboards or reports.

Properties

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

Output

JSON

  • success - Indicates whether the API call was successful.
  • resource - The resource type, which is 'activity' in this case.
  • operation - The operation performed, which is 'getsummary' for retrieving activity summary.
  • body - The raw response body from the Withings API containing the activity summary data.
  • data - Alternative field containing the activity summary data if 'body' is not present.

Dependencies

  • Withings API
  • OAuth2 credentials or manual access token for authentication

Troubleshooting

  • Authentication errors may occur if the OAuth2 token is expired or invalid. The node attempts to refresh the token automatically if possible.
  • Manual token authentication may fail if the token is expired or incorrect; users should ensure the token is valid and refreshed using a Token Exchange node.
  • API errors returned by Withings are captured and can be handled by enabling 'Continue On Fail' to avoid node execution stopping.
  • Incorrect date formats or timestamps in additional fields may lead to unexpected results or errors.

Links

Discussion