GET
/
v2
/
introspect
/
resources

​
Overview

Diagnose user data unavailability through the User Resources Introspection API.

This API offers detailed insights into all provider connections and collected 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

​
data
object[]
required

An array containing user information, including data from different providers.

​
user_id
string
required

The unique identifier of the user.

​
provider
Map<string, object>
required

A map where each key-value pair describes the historical pull status of a specific provider.

​
{PROVIDER_SLUG}
object
required

the historical pull status of a specific provider, keyed by the provider slug.

​
{RESOURCE}
object
required

The historical pull status of a resource with this provider, keyed by the resource type.

​
oldest_data
string

The oldest data timestamp that Vital has observed for this resource.

​
newest_data
string

The newest data timestamp that Vital has observed for this resource.

​
sent_count
number

The number of summaries or samples Vital has sent so far.

​
last_attempt
object
​
timestamp
string

For polling-based resources, the time when the last polling attempt has happened. For push-based resources, the last time when Vital has ingested data.

​
status
string

The status of the last attempt.

Possible value: success, failure

Authorizations

​
x-vital-api-key
string
headerrequired

Vital Team API Key

Query Parameters

​
user_id
string | null
​
provider
enum<string> | null
Available options:
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
​
user_limit
integer
default: 50
​
cursor
string | null
deprecated
​
next_cursor
string | null

The cursor for fetching the next page, or null to fetch the first page.

Response

200 - application/json
​
data
object[]
required
​
next
string | null
requireddeprecated
​
next_cursor
string | null
required

The cursor for fetching the next page, or null to fetch the first page.

Introspect Historical Pulls