At ROOK we are working on a new endpoint that allows its clients to efficiently query the status of their users linked to various data sources.
With this development, clients will be able to access detailed information about the total number of users, their authorized data sources, and their activity status, eliminating the need to manually review each user.
Process Optimization And Greater Autonomy For Clients
Currently, clients who want to know the status of their users depend on manual processes carried out by the ROOK team, which consumes time and resources. With this new endpoint, they will be able to obtain this data in real time through an API query, specifying a date to receive the relevant information up to that point.
Main Features Of The New Endpoint
- Centralized query: Allows you to obtain the total number of linked users and their status in a single request.
- Detailed data: Provides information about each user, including unique ID, link date, data source, and activity status.
- Security and authentication: Only authenticated clients will be able to access the information, guaranteeing data privacy and security.
- High performance: Optimized to handle large volumes of users, with lower response times.
Availability and Integration
The User State Endpoint is now available for ROOK customers with API access. For integration details, see the API Reference.
Frequently Asked Questions
What is the User Status Endpoint?
The User Status Endpoint is an API feature that enables ROOK clients to query and retrieve data about their linked users, including total users, data sources, and their activity status.
Who can use this endpoint?
Only authenticated ROOK clients with API access can use this endpoint.
How does the endpoint work?
Clients send a
GET
request to /api/v1/client/users/status
with the up_to_date
parameter. The response provides a summary of total users, active users, and their associated data sources.What data does the endpoint return?
- Total number of users linked to a client
- Total number of users created for the client
- Active users and their linked data sources (Garmin, Fitbit, etc.)
- User active status
- Pagination details
Can I export the data to Excel or CSV?
Clients can request data in CSV format using the format=csv parameter in the API request.
How does authentication work?
Clients must provide BASIC AUTH (
client_uuid
, secret_key
) in the request header to access the endpoint. Unauthorized requests will receive a 401 Unauthorized error.Where can I find documentation for integration?
Detailed API reference.