new
Integrations Web API
Partial Summaries
This new functionality allows API-based customers to access regular updates of their users' body and physical summaries without waiting until the end of the day.
The end of waiting for daily progress
Previously, the processing of data for daily summaries relied on a final daily synchronization, resulting in periods without information during the day. This limitation prevented clients from providing immediate feedback or behavioral adjustments based on the user's current progress.
With Partial Summaries, this behavior is being addressed by delivering summary updates at four-hour intervals for the pillar of Physical. This solution ensures that information flows continuously through the APIs, automatically consolidating with the final summary, as has been the practice, at the end of the day.
Technical innovation and efficiency
The projectIt has been designed to streamline data visibility while minimizing the consumption of unnecessary resources:
- Data query: The system performs automatic queries every four hours to refresh the data.
- Optimization via Webhooks:If a webhook delivers information before the scheduled cycle, it will be delivering the data while avoiding polling, making it more efficient.
- Detecting changes in Body Summary: Because metrics like height are mostly static, the system only processes updates when it detects manual changes or new, specific measurements.
- Advanced state management: We have implemented specific logic for sources like Polar, correctly interpreting codes to ensure an uninterrupted flow of data.
Compatibility and Integrity
To facilitate a seamless implementation, partial summaries maintain full consistency with the ROOK structure. This ensures that teams can integrate this functionality into their existing pipelines without modifying their current analysis processes.
The availability of the information is still linked to how often the user syncs their wearable with the original source, but now the ROOK team ensures that, once synced, the data is continuously available.
Likewise, this feature is only available for summaries extracted via the ROOK API from Fitbit, Oura, Polar, Whoop, and Withings.
Frequently Asked Questions
What are Partial Summaries?
It is a ROOK feature that allows customers to access updates to the pillar of Physical in four-hour intervals. Instead of waiting for a single summary at the end of the day, we deliver data periodically to improve visibility of user progress.
What problem does this feature solve?
Previously, there were periods of information "blindness" because the system relied on end-of-day synchronization. This latency prevented applications from providing immediate feedback or behavioral adjustments based on recent user activity.
Do partial summaries replace the final daily summary?
No. These summaries are consolidated and synchronized with the Summary final at the end of the day. The goal is to provide ongoing understanding without losing the integrity of the final consolidated data.
How often is the data updated?
We perform automated polling of source endpoints every four hours. However, if a webhook delivers information before this period, the system logs the data and skips the redundant poll to optimize traffic.
How does this affect API and resource consumption?
The system prioritizes querying dynamic metrics such as steps, activity, and nutrition.
Should I change my current integration structure?
It is not necessary. Partial summaries are consistent with the structure of the ROOK Version 2. This ensures that our customers' existing integration pipelines are compatible without requiring modifications.
Is the data available if the user does not sync their device?
The availability of this information depends on how frequently the user syncs their wearable with its original app (Fitbit, Oura, Polar, Whoop, and Withings). If there is no syncing at the source, we will not receive updated data to process.
How does ROOKScore interact with this partial summary update?
Since ROOKScore is linked to summary generation, a partial ROOKScore will also be generated whenever a partial summary is generated. Therefore, the health score of partially linked users can also be monitored throughout the day.
What is the best way to implement partial summaries?
To implement partial summaries, no additional integration changes are required. If daily summary reception is already integrated, partial summaries will be received through the same channel. Additionally, two variables must be considered to ensure the summaries and partial exams are handled in an organized manner:
- "document_version": Partial summaries will be delivered with a document version number that allows for accurate tracking of the daily update number. The closing summary for the day will be the final version received.
- “datetime”: This variable will help us track which day this partial or full summary corresponds to.
For more information on how to use “document_version” and “datetime”, read this article.