GET
/
v2
/
introspect
/
historical_pull
curl --request GET \
  --url https://api.tryvital.io/v2/introspect/historical_pull \
  --header 'x-vital-api-key: <api-key>'
{
  "data": [
    {
      "user_id": "",
      "provider": {
        "fitbit": {
          "pulled": {
            "activity": {
              "start": "2023-07-24T00:00:00+00:00",
              "end": "2023-10-24T00:00:00+00:00",
              "status": "success",
              "days_with_data": 70,
              "release": "0.0.0-dev.cd0e262",
              "trace_id": "51cc7d2d72e98ed4eb63e2b0864b39e3"
            },
            "sleep": {
              "start": "2023-07-24T00:00:00+00:00",
              "end": "2023-10-24T00:00:00+00:00",
              "status": "success",
              "days_with_data": 70,
              "release": "0.0.0-dev.cd0e262",
              "trace_id": "51cc7d2d72e98ed4eb63e2b0864b39e3"
            }
          },
          "not_pulled": [
            "blood_oxygen"
          ]
        }
      }
    }
  ]
}

​
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

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

    • user_id: The unique identifier of the user.
    • provider: Object containing provider-specific data.
      • <provider_slug>: Provider-specific data structure.
        • pulled: JSON containing information about pulled resources
          • status: Information about the status of historical pull.
          • range_start: Timestamp of the beginning of the requested range
          • range_end: Timestamp of the end of the requested range
          • days_with_data: Number of days within this range that contained data
          • release: Release version of Vital API
          • trace_id: Unique identifier, that would allow a Vital engineer to investigate a potential failed pull
      • not_pulled: List of resources that were not pulled

  • next: A cursor for the next page of results, or null if there are no more pages.

Authorizations

x-vital-api-key
string
headerrequired

Vital Team API Key

Query Parameters

user_id
string
provider
enum<string>

An enumeration.

Available options:
oura,
fitbit,
garmin,
whoop,
strava,
renpho,
peloton,
wahoo,
zwift,
freestyle_libre,
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
user_limit
integer
default: 50
cursor
string

Response

200 - application/json
data
object[]
required
next
string
Introspect ResourcesList of Providers