Skip to main content
GET
/
v2
/
introspect
/
historical_pull
Introspect Historical Pulls
curl --request GET \
  --url https://api.tryvital.io/v2/introspect/historical_pull \
  --header 'x-vital-api-key: <api-key>'
{
  "data": [
    {
      "provider": {
        "fitbit": {
          "not_pulled": [
            "blood_oxygen"
          ],
          "pulled": {
            "activity": {
              "days_with_data": 70,
              "range_end": "2023-10-24T00:00:00+00:00",
              "range_start": "2023-07-24T00:00:00+00:00",
              "release": "0.0.0-dev.cd0e262",
              "status": "success",
              "timeline": {
                "ended_at": "2023-10-24T13:53:59+00:00",
                "scheduled_at": "2023-10-24T13:52:51+00:00",
                "started_at": "2023-10-24T13:52:54+00:00"
              },
              "trace_id": "51cc7d2d72e98ed4eb63e2b0864b39e3"
            },
            "sleep": {
              "days_with_data": 70,
              "error_details": "provider_rate_limit_exceeded",
              "range_end": "2023-10-24T00:00:00+00:00",
              "range_start": "2023-07-24T00:00:00+00:00",
              "release": "0.0.0-dev.cd0e262",
              "status": "retrying",
              "timeline": {
                "ended_at": "2023-10-24T13:53:04+00:00",
                "scheduled_at": "2023-10-24T13:52:51+00:00",
                "started_at": "2023-10-24T13:53:01+00:00"
              },
              "trace_id": "51cc7d2d72e98ed4eb63e2b0864b39e3"
            }
          }
        }
      },
      "user_id": ""
    }
  ],
  "next_cursor": "None"
}

​
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.

Authorizations

​
x-vital-api-key
string
header
required

Vital Team API Key

Query Parameters

​
user_id
string<uuid> | null

Filter by user ID.

​
provider

ℹ️ This enum is non-exhaustive.

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,
runkeeper
​
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

Successful Response

​
data
SingleUserHistoricalPullResponse · object[]
required
​
next
string | null
required
deprecated
​
next_cursor
string | null
required

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