Introspect Historical Pulls
Overview
Diagnose user historical data unavailability through the User Resources Introspection API.
This API offers detailed insights into all provider connections and collected historical resources of all users in your team, empowering you to perform an initial diagnosis of any user connection issue with ease.
Please note that user_limit is an upper bound and the endpoint can return data for fewer users.
This would be the case if any of the top selected users had no available resource information.
Response Structure
An array containing user information, including data from different providers.
The unique identifier of the user.
A map where each key-value pair describes the historical pull status of a specific provider.
the historical pull status of a specific provider, keyed by the provider slug.
Resources which have been pulled.
The historical pull status of a resource with this provider, keyed by the resource type.
The status of historical pull.
Possible value: scheduled, in_progress, success, error, failure
The start timestamp from which historical data would be pulled.
The end timestamp to which data would be pulled.
The number of days having data within the pull range ([range_start, range_end]).
The time when the historical pull was scheduled to start.
The time when the historical pull had started.
The time when the historical pull had completed in full, with all
relevants historical.data.*.created events having been sent.
The Vital API release version which this historical pull was executed on.
A Vital trace ID for internal troubleshooting.
Resources which had not been pulled. This could be a result of the lack of user permission, or that the resource was introduced after the connection had established.
Authorizations
Vital Team API Key
Query Parameters
oura, fitbit, garmin, whoop, strava, renpho, peloton, wahoo, zwift, freestyle_libre, abbott_libreview, freestyle_libre_ble, eight_sleep, withings, apple_health_kit, manual, ihealth, google_fit, beurer_api, beurer_ble, omron, omron_ble, onetouch_ble, accuchek_ble, contour_ble, dexcom, dexcom_v3, hammerhead, my_fitness_pal, health_connect, polar, cronometer, kardia, whoop_v2, ultrahuman, my_fitness_pal_v2, map_my_fitness The cursor for fetching the next page, or null to fetch the first page.
Response
The cursor for fetching the next page, or null to fetch the first page.