REST API Reference
The Life API is HTTP REST interface to the Fulcra Data Platform that Context and other integrations are built on. Fulcra is still an early stage product and we strive to keep stable interfaces, though some API definitions may be subject change and deprecation. We recommend using the Fulcra Python SDK or the Fulcra CLI to interact with the Life API.
Authentication
API requests are authenticated via OAuth 2.0 bearer tokens. The Fulcra CLI provides an easy way to authenticate and update access tokens for use with curl and other clients.
--oauth2-bearer $( fulcra auth print-access-token) \
https://api.fulcradynamics.com/user/v1alpha1/info
Data Queries
GET /data/v0/metrics_catalog
Returns a list of Fulcra Metrics that can be queried.
Responses
Examples
Request Example
--request GET \
--url https://api.fulcradynamics.com/data/v0/metrics_catalog \
--header 'Accept: application/json' \
--header 'Authorization: Bearer {access-token}'
Response Example
200 Response
[
{
"description" : "string" ,
"is_time_series" : false ,
"metric_kind" : "string" ,
"name" : "string" ,
"unit" : "string" ,
"value_column" : "string"
}
]
GET /data/v0/time_series_grouped
Allows users to retrieve their data in a normalized time series.
Request
Parameters
Name
In
Type
Required
Description
start_time
query
string(date-time)
true
The starting timestamp (inclusive) in ISO 8601 format
end_time
query
string(date-time)
true
The ending timestamp (exclusive) in ISO 8601 format
metrics
query
array[string]
true
The list of metric names to include.
output
query
OutputMethod true
The output format to generate.
fulcra_userid
query
any
false
The user ID to retrieve data for.
samprate
query
number
false
The sample rate in seconds.
replace_nulls
query
any
false
Set to 1 to replace all unavailable values with the value 0.
Enumerated Values
Parameter
Value
output
ndjson
output
jstable
output
jscolumns
output
arrow
output
arrowraw
output
parquet
output
csv
output
quotecsv
Responses
Examples
Request Example
--request GET \
--url 'https://api.fulcradynamics.com/data/v0/time_series_grouped?start_time=2023-02-01%2000%3A00%3A00Z&end_time=2023-02-03%2000%3A00%3A00Z&metrics=HeartRate&output=ndjson' \
--header 'Accept: application/json' \
--header 'Authorization: Bearer {access-token}'
Response Example
200 Response
GET /data/v0/{fulcra_userid}/apple_location_updates
Retrieve the raw Apple location update samples for the specified
user during the specified period of time.
Request
Parameters
Name
In
Type
Required
Description
fulcra_userid
path
string(uuid)
true
none
start_time
query
string(date-time)
true
The starting timestamp in ISO 8601 format (inclusive)
end_time
query
string(date-time)
true
The ending timestamp in ISO 8601 format (exclusive)
Responses
Examples
Request Example
--request GET \
--url 'https://api.fulcradynamics.com/data/v0/497f6eca-6276-4993-bfeb-53cbbbba6f08/apple_location_updates?start_time=2023-02-01%2000%3A00%3A00Z&end_time=2023-02-03%2000%3A00%3A00Z' \
--header 'Accept: application/json' \
--header 'Authorization: Bearer {access-token}'
Response Example
200 Response
GET /data/v0/{fulcra_userid}/apple_location_visits
Retrieve the raw Apple location visit samples for the specified
user during the specified period of time.
Request
Parameters
Name
In
Type
Required
Description
fulcra_userid
path
string(uuid)
true
none
start_time
query
string(date-time)
true
The starting timestamp in ISO 8601 format (inclusive)
end_time
query
string(date-time)
true
The ending timestamp in ISO 8601 format (exclusive)
Responses
Examples
Request Example
--request GET \
--url 'https://api.fulcradynamics.com/data/v0/497f6eca-6276-4993-bfeb-53cbbbba6f08/apple_location_visits?start_time=2023-02-01%2000%3A00%3A00Z&end_time=2023-02-03%2000%3A00%3A00Z' \
--header 'Accept: application/json' \
--header 'Authorization: Bearer {access-token}'
Response Example
200 Response
GET /data/v0/{fulcra_userid}/apple_workouts
Retrieve the Apple workouts that occurred for the user during the specified
period of time.
Request
Parameters
Name
In
Type
Required
Description
fulcra_userid
path
string(uuid)
true
none
start_time
query
string(date-time)
true
The starting timestamp in ISO 8601 format (inclusive)
end_time
query
string(date-time)
true
The ending timestamp in ISO 8601 format (exclusive)
Responses
Examples
Request Example
--request GET \
--url 'https://api.fulcradynamics.com/data/v0/497f6eca-6276-4993-bfeb-53cbbbba6f08/apple_workouts?start_time=2023-02-01%2000%3A00%3A00Z&end_time=2023-02-03%2000%3A00%3A00Z' \
--header 'Accept: application/json' \
--header 'Authorization: Bearer {access-token}'
Response Example
200 Response
[
{
"all_statistics" : {},
"apple_workout_id" : "17d1ac31-161c-41b7-bb0c-8c7db70b55d8" ,
"device" : {},
"duration" : 0 ,
"end_date" : "2019-08-24T14:15:22Z" ,
"extras" : {},
"has_undetermined_duration" : true ,
"source_revision" : {},
"start_date" : "2019-08-24T14:15:22Z" ,
"workout_activities" : [
{}
],
"workout_activity_type" : "The type of workout." ,
"workout_events" : [
{}
]
}
]
GET /data/v0/{fulcra_userid}/calendar_events
Returns calendar events for a user.
Request
Parameters
Name
In
Type
Required
Description
fulcra_userid
path
string(uuid)
true
none
start_time
query
string(date-time)
true
The starting timestamp in ISO 8601 format (inclusive)
end_time
query
string(date-time)
true
The ending timestamp in ISO 8601 format (exclusive)
calendar_ids
query
any
false
A list of IDs of calendars to search. Only results from these calendars will be returned.
Responses
Examples
Request Example
--request GET \
--url 'https://api.fulcradynamics.com/data/v0/497f6eca-6276-4993-bfeb-53cbbbba6f08/calendar_events?start_time=2023-02-01%2000%3A00%3A00Z&end_time=2023-02-03%2000%3A00%3A00Z' \
--header 'Accept: application/json' \
--header 'Authorization: Bearer {access-token}'
Response Example
200 Response
[
{
"allow_new_time_proposals" : true ,
"availability" : "string" ,
"calendar_event_id" : "7fe777b6-1e25-45fe-a4a1-3723b5fd440f" ,
"calendar_id" : "c828ce68-4c5a-4491-b76a-af3d888d3f97" ,
"calendar_item_external_identifier" : "string" ,
"calendar_item_identifier" : "string" ,
"creation_date" : "2019-08-24T14:15:22Z" ,
"end_date" : "2019-08-24T14:15:22Z" ,
"event_identifier" : "string" ,
"extras" : {},
"geolocation" : {
"altitude" : 0 ,
"ellipsoidal_altitude" : 0 ,
"floor" : 0 ,
"horizontal_accuracy" : 0 ,
"is_produced_by_accessory" : true ,
"is_simulated_by_software" : true ,
"latitude" : 0 ,
"location_timestamp" : "2019-08-24T14:15:22Z" ,
"longitude" : 0 ,
"radius" : 0 ,
"title" : "string" ,
"vertical_accuracy" : 0
},
"has_alarms" : true ,
"has_attendees" : true ,
"has_notes" : true ,
"has_recurrence_rules" : true ,
"is_all_day" : true ,
"is_detached" : true ,
"last_modified_date" : "2019-08-24T14:15:22Z" ,
"location" : "string" ,
"notes" : "string" ,
"occurrence_date" : "2019-08-24T14:15:22Z" ,
"organizer" : "e28f9b28-e5bc-4a12-aafc-96f3301f7fe0" ,
"participants" : [
{
"contact_id" : "f245e2a3-e141-4d41-912c-b1c1f5bd5598" ,
"is_current_user" : true ,
"name" : "string" ,
"participant_role" : "string" ,
"participant_status" : "string" ,
"participant_type" : "string" ,
"url" : "string"
}
],
"recurrence_rules" : [
{
"calendar_id" : "c828ce68-4c5a-4491-b76a-af3d888d3f97" ,
"days_of_the_month" : [
null
],
"days_of_the_week" : [
null
],
"days_of_the_year" : [
null
],
"first_day_of_the_week" : 0 ,
"frequency" : "string" ,
"interval" : 0 ,
"months_of_the_year" : [
null
],
"recurrence_rule_id" : "ff66070e-89d9-4007-ac1d-92d2556a9349" ,
"set_positions" : [
null
],
"weeks_of_the_year" : [
null
]
}
],
"start_date" : "2019-08-24T14:15:22Z" ,
"status" : "string" ,
"time_zone" : "string" ,
"title" : "string" ,
"url" : "string"
}
]
GET /data/v0/{fulcra_userid}/calendars
Retrieve a collection of the user's calendars.
Request
Parameters
Name
In
Type
Required
Description
fulcra_userid
path
string(uuid)
true
none
vendor_ids
query
any
false
A list of identifiers (calendar_identifier) of calendars to search. Only results from these calendars will be returned.
Responses
Examples
Request Example
--request GET \
--url https://api.fulcradynamics.com/data/v0/497f6eca-6276-4993-bfeb-53cbbbba6f08/calendars \
--header 'Accept: application/json' \
--header 'Authorization: Bearer {access-token}'
Response Example
200 Response
[
{
"calendar_color" : "string" ,
"calendar_id" : "c828ce68-4c5a-4491-b76a-af3d888d3f97" ,
"calendar_identifier" : "string" ,
"calendar_name" : "string" ,
"calendar_source_id" : "string" ,
"calendar_source_name" : "string" ,
"calendar_type" : "string" ,
"color" : "Calendar Color" ,
"fulcra_source" : "string" ,
"inserted_at" : "2019-08-24T14:15:22Z" ,
"is_immutable" : true ,
"is_subscribed" : true ,
"source_type" : "string"
}
]
GET /data/v0/{fulcra_userid}/gmaps_location_updates
Retrieve the raw Apple location update samples for the specified
user during the specified period of time.
Request
Parameters
Name
In
Type
Required
Description
fulcra_userid
path
string(uuid)
true
none
start_time
query
string(date-time)
true
The starting timestamp in ISO 8601 format (inclusive)
end_time
query
string(date-time)
true
The ending timestamp in ISO 8601 format (exclusive)
fulcra_source_id
query
any
false
none
Responses
Examples
Request Example
--request GET \
--url 'https://api.fulcradynamics.com/data/v0/497f6eca-6276-4993-bfeb-53cbbbba6f08/gmaps_location_updates?start_time=2023-02-01%2000%3A00%3A00Z&end_time=2023-02-03%2000%3A00%3A00Z' \
--header 'Accept: application/json' \
--header 'Authorization: Bearer {access-token}'
Response Example
200 Response
GET /data/v0/{fulcra_userid}/gmaps_location_updates/bounds
Return temporal bounds of Google Maps geo-location update samples
Request
Parameters
Name
In
Type
Required
Description
fulcra_userid
path
string(uuid)
true
none
source
query
any
false
Filter against a fulcra source
Responses
Examples
Request Example
--request GET \
--url https://api.fulcradynamics.com/data/v0/497f6eca-6276-4993-bfeb-53cbbbba6f08/gmaps_location_updates/bounds \
--header 'Accept: application/json' \
--header 'Authorization: Bearer {access-token}'
Response Example
200 Response
{
"end_date" : "2019-08-24T14:15:22Z" ,
"start_date" : "2019-08-24T14:15:22Z"
}
GET /data/v0/{fulcra_userid}/location_at_time
Gets the user's location at the specified time. If no sample is available for the exact time, searches for the closest sample up to window_size seconds back. If include_after is true, then also searches window_size seconds forward.
Request
Parameters
Name
In
Type
Required
Description
fulcra_userid
path
string(uuid)
true
none
time
query
string(date-time)
true
The timestamp in ISO 8601 format to request location for
window_size
query
integer
false
The amount of time to look back (and forward, if the include_after parameter is true) for a sample.
include_after
query
boolean
false
When true, a sample that occurs after the requested time may be returned if it is the closest one.
reverse_geocode
query
boolean
false
When true, Fulcra will attempt to reverse geocode the location and include the location details in the results.
Responses
Examples
Request Example
--request GET \
--url 'https://api.fulcradynamics.com/data/v0/497f6eca-6276-4993-bfeb-53cbbbba6f08/location_at_time?time=2023-02-01T08%3A00%3A00Z' \
--header 'Accept: application/json' \
--header 'Authorization: Bearer {access-token}'
Response Example
200 Response
GET /data/v0/{fulcra_userid}/location_time_series
Retrieve a time series of locations that the user was at.
Request
Parameters
Name
In
Type
Required
Description
fulcra_userid
path
string(uuid)
true
none
start_time
query
string(date-time)
true
The starting timestamp in ISO8601 format (inclusive)
end_time
query
string(date-time)
true
The ending timestamp in ISO8601 format (exclusive)
sample_rate
query
integer
false
The sample rate in seconds.
look_back
query
integer
false
The number of seconds in the past to look back for a sample.
change_meters
query
any
false
When specified, subsequent samples that are fewer than this many meters away will not be included.
reverse_geocode
query
boolean
false
When true, Fulcra will attempt to reverse geocode the locations and include the location details in the results.
location_sources
query
array[string]
false
A set of sources to use location samples from.
Enumerated Values
Parameter
Value
location_sources
ios
location_sources
google_maps
Responses
Examples
Request Example
--request GET \
--url 'https://api.fulcradynamics.com/data/v0/497f6eca-6276-4993-bfeb-53cbbbba6f08/location_time_series?start_time=2023-02-01%2000%3A00%3A00Z&end_time=2023-02-03%2000%3A00%3A00Z' \
--header 'Accept: application/json' \
--header 'Authorization: Bearer {access-token}'
Response Example
200 Response
GET /data/v0/{fulcra_userid}/location_updates
Retrieve the location update samples for the specified user
during the specified period of time.
Request
Parameters
Name
In
Type
Required
Description
fulcra_userid
path
string(uuid)
true
none
start_time
query
string(date-time)
true
The starting timestamp in ISO 8601 format (inclusive)
end_time
query
string(date-time)
true
The ending timestamp in ISO 8601 format (exclusive)
location_sources
query
array[string]
false
A set of sources to use location samples from.
Enumerated Values
Parameter
Value
location_sources
ios
location_sources
google_maps
Responses
Examples
Request Example
--request GET \
--url 'https://api.fulcradynamics.com/data/v0/497f6eca-6276-4993-bfeb-53cbbbba6f08/location_updates?start_time=2023-02-01%2000%3A00%3A00Z&end_time=2023-02-03%2000%3A00%3A00Z' \
--header 'Accept: application/json' \
--header 'Authorization: Bearer {access-token}'
Response Example
200 Response
GET /data/v0/{fulcra_userid}/metric_samples
Retrieve the raw samples related to the given metric that occurred for the
user during the specified period of time.
In cases where samples cover ranges and not points in time, a sample will
be returned if any part of its range intersects with the requested range.
As an example, if you have start_date as 14:00 and end_date at 15:00,
and there is a sample that covers 13:30-14:30, it will be included.
Request
Parameters
Name
In
Type
Required
Description
fulcra_userid
path
string(uuid)
true
none
start_time
query
string(date-time)
true
The starting timestamp in ISO 8601 format (inclusive)
end_time
query
string(date-time)
true
The ending timestamp in ISO 8601 format (exclusive)
metric
query
string
true
The metric to retrieve samples for.
Responses
Examples
Request Example
--request GET \
--url 'https://api.fulcradynamics.com/data/v0/497f6eca-6276-4993-bfeb-53cbbbba6f08/metric_samples?start_time=2023-02-01%2000%3A00%3A00Z&end_time=2023-02-03%2000%3A00%3A00Z&metric=HeartRate' \
--header 'Accept: application/json' \
--header 'Authorization: Bearer {access-token}'
Response Example
200 Response
GET /data/v0/{fulcra_userid}/metric_time_series
Retrieve a time-series dataframe containing one metric.
Request
Parameters
Name
In
Type
Required
Description
fulcra_userid
path
string(uuid)
true
none
start_time
query
string(date-time)
true
The starting timestamp in ISO8601 format (inclusive)
end_time
query
string(date-time)
true
The ending timestamp in ISO8601 format (exclusive)
metric
query
string
true
The metric to retrieve data for.
output
query
OutputMethod true
The output format to generate.
samprate
query
any
false
The sample rate in seconds or in the polars string language (see https://docs.pola.rs/api/python/dev/reference/expressions/api/polars.Expr.dt.truncate.html ).
replace_nulls
query
any
false
Set to 1 to replace all unavailable values with 0.
calculations
query
any
false
Additional statistics to calculate for each time window.
drop_nulls
query
any
false
When set to 1, all null samples are removed.
tz
query
any
false
IANA time zone to return results in
Enumerated Values
Parameter
Value
output
ndjson
output
jstable
output
jscolumns
output
arrow
output
arrowraw
output
parquet
output
csv
output
quotecsv
Responses
Examples
Request Example
--request GET \
--url 'https://api.fulcradynamics.com/data/v0/497f6eca-6276-4993-bfeb-53cbbbba6f08/metric_time_series?start_time=2023-02-01%2000%3A00%3A00Z&end_time=2023-02-03%2000%3A00%3A00Z&metric=HeartRate&output=ndjson' \
--header 'Accept: application/json' \
--header 'Authorization: Bearer {access-token}'
Response Example
200 Response
GET /data/v0/{fulcra_userid}/sleep_agg
Process raw sleep data samples aggregated sleep stage durations per period.
Request
Parameters
Name
In
Type
Required
Description
fulcra_userid
path
string(uuid)
true
none
start_time
query
string(date-time)
true
The starting timestamp in ISO8601 format (inclusive)
end_time
query
string(date-time)
true
The ending timestamp in ISO8601 format (exclusive)
output
query
OutputMethod true
The output format to generate.
cycle_gap
query
string(duration)
false
Minimum time interval separating distinct cycles.
stages
query
any
false
Sleep stages to include. Defaults to all stages.
gap_stages
query
any
false
Sleep stages to consider as gaps in sleep cycles.
clip_to_range
query
boolean
false
Whether to clip the data to the requested date range. This is always done when requesting data for a user other than the authenticated user.
mode
query
Mode false
Whether to use the cycle start or cycle end to assign cycles to periods, or to split sleep stage intervals at period boundries.
period
query
string
false
The period start and interval represented with the polars string language (see https://docs.pola.rs/api/python/dev/reference/expressions/api/polars.Expr.dt.truncate.html ).
agg_functions
query
array[string]
false
Aggregations to return.
tz
query
string
false
IANA time zone to return results in
Enumerated Values
Parameter
Value
output
ndjson
output
jstable
output
jscolumns
output
arrow
output
arrowraw
output
parquet
output
csv
output
quotecsv
mode
start
mode
end
mode
split
agg_functions
sum
agg_functions
avg
agg_functions
min
agg_functions
max
Responses
Examples
Request Example
--request GET \
--url 'https://api.fulcradynamics.com/data/v0/497f6eca-6276-4993-bfeb-53cbbbba6f08/sleep_agg?start_time=2024-11-15%2000%3A00%3A00Z&end_time=2024-11-16%2000%3A00%3A00Z&output=ndjson' \
--header 'Accept: application/json' \
--header 'Authorization: Bearer {access-token}'
Response Example
200 Response
GET /data/v0/{fulcra_userid}/sleep_cycles
Process raw sleep data samples into sleep cycles and assign
by finding gaps in the sleep sample data within a specified time interval.
Request
Parameters
Name
In
Type
Required
Description
fulcra_userid
path
string(uuid)
true
none
start_time
query
string(date-time)
true
The starting timestamp in ISO8601 format (inclusive)
end_time
query
string(date-time)
true
The ending timestamp in ISO8601 format (exclusive)
output
query
OutputMethod true
The output format to generate.
cycle_gap
query
string(duration)
false
Minimum time interval separating distinct cycles.
stages
query
any
false
Sleep stages to include. Defaults to all stages.
gap_stages
query
any
false
Sleep stages to consider as gaps in sleep cycles.
clip_to_range
query
boolean
false
Whether to clip the data to the requested date range. This is always done when requesting data for a user other than the authenticated user.
Enumerated Values
Parameter
Value
output
ndjson
output
jstable
output
jscolumns
output
arrow
output
arrowraw
output
parquet
output
csv
output
quotecsv
Responses
Examples
Request Example
--request GET \
--url 'https://api.fulcradynamics.com/data/v0/497f6eca-6276-4993-bfeb-53cbbbba6f08/sleep_cycles?start_time=2024-11-15%2000%3A00%3A00Z&end_time=2024-11-16%2000%3A00%3A00Z&output=ndjson' \
--header 'Accept: application/json' \
--header 'Authorization: Bearer {access-token}'
Response Example
200 Response
GET /data/v0/{fulcra_userid}/sleep_cycles_extended
Extended version of sleep_cycles endpoint for experimentation.
Adds metric time series data (heart rate, respiratory rate, etc.) to each sleep cycle.
Request
Parameters
Name
In
Type
Required
Description
fulcra_userid
path
string(uuid)
true
none
start_time
query
string(date-time)
true
The starting timestamp in ISO8601 format (inclusive)
end_time
query
string(date-time)
true
The ending timestamp in ISO8601 format (exclusive)
output
query
OutputMethod true
The output format to generate.
cycle_gap
query
string(duration)
false
Minimum time interval separating distinct cycles.
stages
query
any
false
Sleep stages to include. Defaults to all stages.
gap_stages
query
any
false
Sleep stages to consider as gaps in sleep cycles.
clip_to_range
query
boolean
false
Whether to clip the data to the requested date range. This is always done when requesting data for a user other than the authenticated user.
metrics
query
any
false
Optional list of metrics to include as time series data (e.g., HeartRate, RespiratoryRate).
metric_calculations
query
any
false
Statistics to calculate for each time window in metric time series.
metric_seconds_before
query
number
false
Number of seconds before each sleep cycle to include in metric time series data.
metric_seconds_after
query
number
false
Number of seconds after each sleep cycle to include in metric time series data.
Enumerated Values
Parameter
Value
output
ndjson
output
jstable
output
jscolumns
output
arrow
output
arrowraw
output
parquet
output
csv
output
quotecsv
Responses
Examples
Request Example
--request GET \
--url 'https://api.fulcradynamics.com/data/v0/497f6eca-6276-4993-bfeb-53cbbbba6f08/sleep_cycles_extended?start_time=2024-11-15%2000%3A00%3A00Z&end_time=2024-11-16%2000%3A00%3A00Z&output=ndjson' \
--header 'Accept: application/json' \
--header 'Authorization: Bearer {access-token}'
Response Example
200 Response
Retrieve metadata for interpreting sleep stage data, such as stage names and depths. In future, this may include user-specific stage or device priorities as well.
Name
In
Type
Required
Description
fulcra_userid
path
string(uuid)
true
none
Examples
Request Example
--request GET \
--url https://api.fulcradynamics.com/data/v0/497f6eca-6276-4993-bfeb-53cbbbba6f08/sleep_stage_metadata \
--header 'Accept: application/json' \
--header 'Authorization: Bearer {access-token}'
Response Example
200 Response
GET /data/v0/{fulcra_userid}/sleep_stages
Process raw sleep data samples into non-conflicting sleep stages and assign
a cycle index by finding gaps in the sleep sample data within a specified time interval.
If more than one sleep data source is present, sleep stage is determined based
on the priority of the stage (in bed and unknown are deprioritized) and the
start time of the sample (latest takes precedence)
Request
Parameters
Name
In
Type
Required
Description
fulcra_userid
path
string(uuid)
true
none
start_time
query
string(date-time)
true
The starting timestamp in ISO8601 format (inclusive)
end_time
query
string(date-time)
true
The ending timestamp in ISO8601 format (exclusive)
output
query
OutputMethod true
The output format to generate.
cycle_gap
query
string(duration)
false
Minimum time interval separating distinct cycles.
stages
query
any
false
Sleep stages to include. Defaults to all stages.
gap_stages
query
any
false
Sleep stages to consider as gaps in sleep cycles.
merge_overlapping
query
boolean
false
Whether to merge overlapping stages based on priority and start time: stage 0 (in bed) has lower priority than other stages; stage 2 (unknown sleep stage) has lower priority than other stages except 0; then stages with later start times take precedece.
merge_contiguous
query
boolean
false
Whether to merge contiguous samples with the same sleep stage into one continues stage.
clip_to_range
query
boolean
false
Whether to clip the data to the requested date range. This is always done when requesting data for a user other than the authenticated user.
Enumerated Values
Parameter
Value
output
ndjson
output
jstable
output
jscolumns
output
arrow
output
arrowraw
output
parquet
output
csv
output
quotecsv
Responses
Examples
Request Example
--request GET \
--url 'https://api.fulcradynamics.com/data/v0/497f6eca-6276-4993-bfeb-53cbbbba6f08/sleep_stages?start_time=2024-11-15%2000%3A00%3A00Z&end_time=2024-11-16%2000%3A00%3A00Z&output=ndjson' \
--header 'Accept: application/json' \
--header 'Authorization: Bearer {access-token}'
Response Example
200 Response
GET /data/v1/catalog
Catalog of Fulcra Data Types
Request
Parameters
Name
In
Type
Required
Description
data_type
query
any
false
none
category
query
any
false
none
Responses
Examples
Request Example
--request GET \
--url https://api.fulcradynamics.com/data/v1/catalog \
--header 'Accept: application/json' \
--header 'Authorization: Bearer {access-token}'
Response Example
200 Response
[
{
"api_version" : "v0" ,
"categories" : [
"annotations"
],
"class" : "metric" ,
"column_name" : "string" ,
"deprecated" : false ,
"description" : "string" ,
"icon" : "string" ,
"id" : "string" ,
"metric_kind" : "cumulative" ,
"name" : "string" ,
"queryable" : true ,
"record_spec" : {
"schema" : {},
"type" : "event"
},
"recordable" : true ,
"unit" : "string"
}
]
GET /data/v1/catalog/{data_type}/{api_version}
Return metadata for a data type
Request
Parameters
Name
In
Type
Required
Description
data_type
path
string
true
none
api_version
path
FulcraAPIVersion true
none
Enumerated Values
Parameter
Value
api_version
v0
api_version
v1alpha1
api_version
v1
Responses
Examples
Request Example
--request GET \
--url https://api.fulcradynamics.com/data/v1/catalog/string/v0 \
--header 'Accept: application/json' \
--header 'Authorization: Bearer {access-token}'
Response Example
200 Response
GET /data/v1/catalog/{data_type}/{api_version}/schema
Return record JSON Schema for a data type
Request
Parameters
Name
In
Type
Required
Description
data_type
path
string
true
none
api_version
path
FulcraAPIVersion true
none
Enumerated Values
Parameter
Value
api_version
v0
api_version
v1alpha1
api_version
v1
Responses
Examples
Request Example
--request GET \
--url https://api.fulcradynamics.com/data/v1/catalog/string/v0/schema \
--header 'Accept: application/json' \
--header 'Authorization: Bearer {access-token}'
Response Example
200 Response
GET /data/v1/updates
Available Data Updated For Time Range
Request
Parameters
Name
In
Type
Required
Description
start_time
query
string(date-time)
true
The starting timestamp in ISO8601 format (inclusive)
end_time
query
string(date-time)
true
The ending timestamp ISO8601 format (exclusive)
Responses
Examples
Request Example
--request GET \
--url 'https://api.fulcradynamics.com/data/v1/updates?start_time=2023-02-01%2000%3A00%3A00Z&end_time=2023-02-03%2000%3A00%3A00Z' \
--header 'Accept: application/json' \
--header 'Authorization: Bearer {access-token}'
Response Example
200 Response
GET /data/v1alpha1/data_available
List all available data for fulcra_userid (if not present, then use the
authenticated user's userid).
This does not include pool data.
The result will be a list of objects, keyed by data type.
This is a convenience method, not a replacement for access_check().
Request
Parameters
Name
In
Type
Required
Description
start_time
query
string(date-time)
true
The starting timestamp in ISO8601 format (inclusive)
end_time
query
string(date-time)
true
The ending timestamp ISO8601 format (exclusive)
fulcra_userid
query
any
false
User ID of Fulcra User to return data for
Responses
Examples
Request Example
--request GET \
--url 'https://api.fulcradynamics.com/data/v1alpha1/data_available?start_time=2023-02-01%2000%3A00%3A00Z&end_time=2023-02-03%2000%3A00%3A00Z' \
--header 'Accept: application/json' \
--header 'Authorization: Bearer {access-token}'
Response Example
200 Response
GET /data/v1alpha1/data_sources
Return a list of a user's processed data sources
Responses
Examples
Request Example
--request GET \
--url https://api.fulcradynamics.com/data/v1alpha1/data_sources \
--header 'Accept: application/json' \
--header 'Authorization: Bearer {access-token}'
Response Example
200 Response
[
{
"id" : "497f6eca-6276-4993-bfeb-53cbbbba6f08" ,
"metadata" : {},
"name" : "string" ,
"parent_id" : "1c6ca187-e61f-4301-8dcb-0e9749e89eef" ,
"vendor_id" : "string"
}
]
GET /data/v1alpha1/data_types
Return a list of available Fulcra Data Types to query
Responses
Examples
Request Example
--request GET \
--url https://api.fulcradynamics.com/data/v1alpha1/data_types \
--header 'Accept: application/json' \
--header 'Authorization: Bearer {access-token}'
Response Example
200 Response
[
{
"category" : [
"string"
],
"class" : "string" ,
"description" : "string" ,
"name" : "string"
}
]
GET /data/v1alpha1/event/{data_type}
Return records from a Fulcra Data Type
Request
Parameters
Name
In
Type
Required
Description
data_type
path
string
true
none
start_time
query
string(date-time)
true
The starting timestamp in ISO8601 format (inclusive)
end_time
query
string(date-time)
true
The ending timestamp ISO8601 format (exclusive)
format
query
ResponseFormat false
Response format (json or csv)
sort
query
SortOrder false
Sort Order
fulcra_userid
query
any
false
User ID of Fulcra User to return data for
pool_id
query
any
false
Pool ID to return data for
participant_id
query
any
false
Pool participant ID to return data for
filter
query
array[string]
false
Additional fields to filter by
Enumerated Values
Parameter
Value
format
json
format
csv
sort
asc
sort
desc
Responses
Examples
Request Example
--request GET \
--url 'https://api.fulcradynamics.com/data/v1alpha1/event/string?start_time=2023-02-01%2000%3A00%3A00Z&end_time=2023-02-03%2000%3A00%3A00Z' \
--header 'Accept: application/json' \
--header 'Authorization: Bearer {access-token}'
Response Example
200 Response
GET /data/v1alpha1/event/{data_type}/agg/{resolution}
Return aggregated data for a Fulcra Metric
Request
Parameters
Name
In
Type
Required
Description
resolution
path
AggregateResolution true
Time granularity to aggregate by
data_type
path
string
true
none
start_time
query
string(date-time)
true
The starting timestamp in ISO8601 format (inclusive)
end_time
query
string(date-time)
true
The ending timestamp ISO8601 format (exclusive)
time_zone
query
TimeZone false
IANA time zone to aggregate by
format
query
ResponseFormat false
Response format (json or csv)
sort
query
SortOrder false
Sort Order
fulcra_userid
query
any
false
User ID of Fulcra User to return data for
pool_id
query
any
false
Pool ID to return data for
participant_id
query
any
false
Pool participant ID to return data for
filter
query
array[string]
false
Additional fields to filter by
group
query
array[string]
false
Additional fields to group by
Enumerated Values
Parameter
Value
resolution
15m
resolution
60m
resolution
day
format
json
format
csv
sort
asc
sort
desc
time_zone : accepts one of 599 values (e.g. Atlantic/Stanley). See the full list in the OpenAPI specification .
Responses
Examples
Request Example
--request GET \
--url 'https://api.fulcradynamics.com/data/v1alpha1/event/string/agg/15m?start_time=2023-02-01%2000%3A00%3A00Z&end_time=2023-02-03%2000%3A00%3A00Z' \
--header 'Accept: application/json' \
--header 'Authorization: Bearer {access-token}'
Response Example
200 Response
GET /data/v1alpha1/insight
Return insights data
Request
Parameters
Name
In
Type
Required
Description
timestamp
query
any
false
The timestamp in ISO8601 format (inclusive)
version
query
InsightReportVersion false
Insights report version
Enumerated Values
Parameter
Value
version
v0
Responses
Examples
Request Example
--request GET \
--url https://api.fulcradynamics.com/data/v1alpha1/insight \
--header 'Accept: application/json' \
--header 'Authorization: Bearer {access-token}'
Response Example
200 Response
GET /data/v1alpha1/metric/{data_type}
Return raw samples of a Fulcra Metric
Request
Parameters
Name
In
Type
Required
Description
data_type
path
string
true
none
start_time
query
string(date-time)
true
The starting timestamp in ISO8601 format (inclusive)
end_time
query
string(date-time)
true
The ending timestamp ISO8601 format (exclusive)
format
query
ResponseFormat false
Response format (json or csv)
sort
query
SortOrder false
Sort Order
fulcra_userid
query
any
false
User ID of Fulcra User to return data for
pool_id
query
any
false
Pool ID to return data for
participant_id
query
any
false
Pool participant ID to return data for
filter
query
array[string]
false
Additional fields to filter by
Enumerated Values
Parameter
Value
format
json
format
csv
sort
asc
sort
desc
Responses
Examples
Request Example
--request GET \
--url 'https://api.fulcradynamics.com/data/v1alpha1/metric/string?start_time=2023-02-01%2000%3A00%3A00Z&end_time=2023-02-03%2000%3A00%3A00Z' \
--header 'Accept: application/json' \
--header 'Authorization: Bearer {access-token}'
Response Example
200 Response
GET /data/v1alpha1/metric/{data_type}/agg/{resolution}
Return aggregated data for a Fulcra Metric
Request
Parameters
Name
In
Type
Required
Description
resolution
path
AggregateResolution true
Time granularity to aggregate by
data_type
path
string
true
none
function
query
array[string]
true
Aggregate function
start_time
query
string(date-time)
true
The starting timestamp in ISO8601 format (inclusive)
end_time
query
string(date-time)
true
The ending timestamp ISO8601 format (exclusive)
time_zone
query
TimeZone false
IANA time zone to aggregate by
format
query
ResponseFormat false
Response format (json or csv)
sort
query
SortOrder false
Sort Order
fulcra_userid
query
any
false
User ID of Fulcra User to return data for
pool_id
query
any
false
Pool ID to return data for
participant_id
query
any
false
Pool participant ID to return data for
filter
query
array[string]
false
Additional fields to filter by
group
query
array[string]
false
Additional fields to group by
Enumerated Values
Parameter
Value
resolution
15m
resolution
60m
resolution
day
function
sum
function
avg
function
min
function
max
format
json
format
csv
sort
asc
sort
desc
time_zone : accepts one of 599 values (e.g. Atlantic/Stanley). See the full list in the OpenAPI specification .
Responses
Examples
Request Example
--request GET \
--url 'https://api.fulcradynamics.com/data/v1alpha1/metric/string/agg/15m?function=sum&start_time=2023-02-01%2000%3A00%3A00Z&end_time=2023-02-03%2000%3A00%3A00Z' \
--header 'Accept: application/json' \
--header 'Authorization: Bearer {access-token}'
Response Example
200 Response
Ingestion
POST /ingest/v1/record
Deprecated
This operation is deprecated and may be removed in a future version of the API.
ingest a fulcra data type record
Request
Request Body
{
"data" : "string" ,
"metadata" : {
"content_type" : "string" ,
"data_type" : "string" ,
"id" : "497f6eca-6276-4993-bfeb-53cbbbba6f08" ,
"recorded_at" : "2019-08-24T14:15:22Z" ,
"source" : [],
"tags" : []
},
"specversion" : 1
}
Parameters
Name
In
Type
Required
Description
body
body
DataRecordV1 true
none
Responses
Examples
Request Example
--request POST \
--url https://api.fulcradynamics.com/ingest/v1/record \
--header 'Accept: application/json' \
--header 'Authorization: Bearer {access-token}' \
--header 'Content-Type: application/json' \
--data '{"data":"string","metadata":{"content_type":"string","data_type":"string","id":"497f6eca-6276-4993-bfeb-53cbbbba6f08","recorded_at":"2019-08-24T14:15:22Z","source":[],"tags":[]},"specversion":1}'
Response Example
422 Response
{
"detail" : [
{
"loc" : [
"string"
],
"msg" : "string" ,
"type" : "string"
}
]
}
POST /ingest/v1/record/{data_type}
Ingest records for a Fulcra data type. Data types can be retrieved from the /data/v1/catalog endpoint. Record schema for a data type can be retrieved from the /data/v1/catalog/{data_type}/{api_version}/schema endpoint.
Request
Request Body
Parameters
Name
In
Type
Required
Description
data_type
path
string
true
none
api_version
query
any
false
none
content-length
header
integer
true
none
body
body
object
true
none
Responses
Examples
Request Example
--request POST \
--url https://api.fulcradynamics.com/ingest/v1/record/string \
--header 'Accept: application/json' \
--header 'Authorization: Bearer {access-token}' \
--header 'Content-Type: application/json' \
--header 'content-length: 0' \
--data '{}'
Response Example
201 Response
{
"upload_id" : "f2ef591b-135b-46fa-a604-3d4fda5bfbfb"
}
Files
Return a list of file upload inputs
Name
In
Type
Required
Description
path
query
string
false
none
name
query
string
false
none
state
query
array,null
false
none
include_archived
query
boolean
false
none
include_deleted
query
boolean
false
none
start_time
query
string(date-time)
false
none
end_time
query
string(date-time)
false
none
Parameter
Value
state
created
state
uploaded
state
archived
state
deleted
Examples
Request Example
--request GET \
--url https://api.fulcradynamics.com/input/v1/file \
--header 'Accept: application/json' \
--header 'Authorization: Bearer {access-token}'
Response Example
200 Response
{
"files" : [
{
"archived_at" : "2019-08-24T14:15:22Z" ,
"created_at" : "2019-08-24T14:15:22Z" ,
"deleted_at" : "2019-08-24T14:15:22Z" ,
"fulcra_userid" : "string" ,
"id" : "string" ,
"last_scanned" : "2019-08-24T14:15:22Z" ,
"name" : "string" ,
"path" : "string" ,
"restored_from_id" : "string" ,
"scan_state" : "string" ,
"size" : 0 ,
"source_data_types" : [
{
"data_type" : "string" ,
"state" : "string"
}
],
"source_id" : "string" ,
"source_name" : "string" ,
"state" : "string" ,
"uploaded_at" : "2019-08-24T14:15:22Z"
}
],
"folders" : [
"string"
]
}
POST /input/v1/file
Create a file upload input
Request Body
{
"content_length" : 0 ,
"content_type" : "string" ,
"name" : "string" ,
"path" : "string"
}
Examples
Request Example
--request POST \
--url https://api.fulcradynamics.com/input/v1/file \
--header 'Accept: application/json' \
--header 'Authorization: Bearer {access-token}' \
--header 'Content-Type: application/json' \
--header 'origin: string' \
--data '{"content_length":0,"content_type":"string","name":"string","path":"string"}'
Response Example
200 Response
{
"file" : {
"archived_at" : "2019-08-24T14:15:22Z" ,
"created_at" : "2019-08-24T14:15:22Z" ,
"deleted_at" : "2019-08-24T14:15:22Z" ,
"fulcra_userid" : "string" ,
"id" : "string" ,
"last_scanned" : "2019-08-24T14:15:22Z" ,
"name" : "string" ,
"path" : "string" ,
"restored_from_id" : "string" ,
"scan_state" : "string" ,
"size" : 0 ,
"source_data_types" : [
{
"data_type" : "string" ,
"state" : "string"
}
],
"source_id" : "string" ,
"source_name" : "string" ,
"state" : "string" ,
"uploaded_at" : "2019-08-24T14:15:22Z"
},
"url" : "string"
}
Return a list of recent file changes
Name
In
Type
Required
Description
start_time
query
string(date-time)
true
none
end_time
query
string(date-time)
true
none
Examples
Request Example
--request GET \
--url 'https://api.fulcradynamics.com/input/v1/file/recent_changes?start_time=2019-08-24T14%3A15%3A22Z&end_time=2019-08-24T14%3A15%3A22Z' \
--header 'Accept: application/json' \
--header 'Authorization: Bearer {access-token}'
Response Example
200 Response
{
"files" : [
{
"archived_at" : "2019-08-24T14:15:22Z" ,
"deleted_at" : "2019-08-24T14:15:22Z" ,
"full_name" : "string" ,
"id" : "string" ,
"last_scanned" : "2019-08-24T14:15:22Z" ,
"scan_state" : "string" ,
"size" : 0 ,
"state" : "string" ,
"uploaded_at" : "2019-08-24T14:15:22Z"
}
]
}
Delete a file upload input
Examples
Request Example
--request DELETE \
--url https://api.fulcradynamics.com/input/v1/file/ \
--header 'Accept: application/problem+json' \
--header 'Authorization: Bearer {access-token}'
Response Example
default Response
{
"detail" : "Property foo is required but is missing." ,
"errors" : [
{
"location" : "string" ,
"message" : "string" ,
"value" : null
}
],
"instance" : "https://example.com/error-log/abc123" ,
"status" : 400 ,
"title" : "Bad Request" ,
"type" : "https://example.com/errors/example"
}
Return a file upload input
Examples
Request Example
--request GET \
--url https://api.fulcradynamics.com/input/v1/file/ \
--header 'Accept: application/json' \
--header 'Authorization: Bearer {access-token}'
Response Example
200 Response
{
"archived_at" : "2019-08-24T14:15:22Z" ,
"created_at" : "2019-08-24T14:15:22Z" ,
"deleted_at" : "2019-08-24T14:15:22Z" ,
"fulcra_userid" : "string" ,
"id" : "string" ,
"last_scanned" : "2019-08-24T14:15:22Z" ,
"name" : "string" ,
"path" : "string" ,
"restored_from_id" : "string" ,
"scan_state" : "string" ,
"size" : 0 ,
"source_data_types" : [
{
"data_type" : "string" ,
"state" : "string"
}
],
"source_id" : "string" ,
"source_name" : "string" ,
"state" : "string" ,
"uploaded_at" : "2019-08-24T14:15:22Z"
}
Download a file upload input
Status
Meaning
Description
Schema
200
OK OK
None
default
Default
Error
ErrorModel
Examples
Request Example
--request GET \
--url https://api.fulcradynamics.com/input/v1/file//download \
--header 'Accept: application/problem+json' \
--header 'Authorization: Bearer {access-token}'
Response Example
default Response
{
"detail" : "Property foo is required but is missing." ,
"errors" : [
{
"location" : "string" ,
"message" : "string" ,
"value" : null
}
],
"instance" : "https://example.com/error-log/abc123" ,
"status" : 400 ,
"title" : "Bad Request" ,
"type" : "https://example.com/errors/example"
}
POST /input/v1/file/{input_id}/restore
Restore an archived file upload input
Examples
Request Example
--request POST \
--url https://api.fulcradynamics.com/input/v1/file//restore \
--header 'Accept: application/json' \
--header 'Authorization: Bearer {access-token}'
Response Example
200 Response
{
"archived_at" : "2019-08-24T14:15:22Z" ,
"created_at" : "2019-08-24T14:15:22Z" ,
"deleted_at" : "2019-08-24T14:15:22Z" ,
"fulcra_userid" : "string" ,
"id" : "string" ,
"last_scanned" : "2019-08-24T14:15:22Z" ,
"name" : "string" ,
"path" : "string" ,
"restored_from_id" : "string" ,
"scan_state" : "string" ,
"size" : 0 ,
"source_data_types" : [
{
"data_type" : "string" ,
"state" : "string"
}
],
"source_id" : "string" ,
"source_name" : "string" ,
"state" : "string" ,
"uploaded_at" : "2019-08-24T14:15:22Z"
}
Deprecated
This operation is deprecated and may be removed in a future version of the API.
Return a list of file upload inputs
Name
In
Type
Required
Description
path
query
string
false
none
name
query
string
false
none
state
query
array,null
false
none
include_archived
query
boolean
false
none
include_deleted
query
boolean
false
none
start_time
query
string(date-time)
false
none
end_time
query
string(date-time)
false
none
Parameter
Value
state
created
state
uploaded
state
archived
state
deleted
Examples
Request Example
--request GET \
--url https://api.fulcradynamics.com/input/v1/file_upload \
--header 'Accept: application/json' \
--header 'Authorization: Bearer {access-token}'
Response Example
200 Response
{
"files" : [
{
"archived_at" : "2019-08-24T14:15:22Z" ,
"created_at" : "2019-08-24T14:15:22Z" ,
"deleted_at" : "2019-08-24T14:15:22Z" ,
"fulcra_userid" : "string" ,
"id" : "string" ,
"last_scanned" : "2019-08-24T14:15:22Z" ,
"name" : "string" ,
"path" : "string" ,
"restored_from_id" : "string" ,
"scan_state" : "string" ,
"size" : 0 ,
"source_data_types" : [
{
"data_type" : "string" ,
"state" : "string"
}
],
"source_id" : "string" ,
"source_name" : "string" ,
"state" : "string" ,
"uploaded_at" : "2019-08-24T14:15:22Z"
}
],
"folders" : [
"string"
]
}
POST /input/v1/file_upload
Deprecated
This operation is deprecated and may be removed in a future version of the API.
Create a file upload input
Request Body
{
"content_length" : 0 ,
"content_type" : "string" ,
"name" : "string" ,
"path" : "string"
}
Examples
Request Example
--request POST \
--url https://api.fulcradynamics.com/input/v1/file_upload \
--header 'Accept: application/json' \
--header 'Authorization: Bearer {access-token}' \
--header 'Content-Type: application/json' \
--header 'origin: string' \
--data '{"content_length":0,"content_type":"string","name":"string","path":"string"}'
Response Example
200 Response
{
"file" : {
"archived_at" : "2019-08-24T14:15:22Z" ,
"created_at" : "2019-08-24T14:15:22Z" ,
"deleted_at" : "2019-08-24T14:15:22Z" ,
"fulcra_userid" : "string" ,
"id" : "string" ,
"last_scanned" : "2019-08-24T14:15:22Z" ,
"name" : "string" ,
"path" : "string" ,
"restored_from_id" : "string" ,
"scan_state" : "string" ,
"size" : 0 ,
"source_data_types" : [
{
"data_type" : "string" ,
"state" : "string"
}
],
"source_id" : "string" ,
"source_name" : "string" ,
"state" : "string" ,
"uploaded_at" : "2019-08-24T14:15:22Z"
},
"url" : "string"
}
Deprecated
This operation is deprecated and may be removed in a future version of the API.
Return a list of recent file changes
Name
In
Type
Required
Description
start_time
query
string(date-time)
true
none
end_time
query
string(date-time)
true
none
Examples
Request Example
--request GET \
--url 'https://api.fulcradynamics.com/input/v1/file_upload/recent_changes?start_time=2019-08-24T14%3A15%3A22Z&end_time=2019-08-24T14%3A15%3A22Z' \
--header 'Accept: application/json' \
--header 'Authorization: Bearer {access-token}'
Response Example
200 Response
{
"files" : [
{
"archived_at" : "2019-08-24T14:15:22Z" ,
"deleted_at" : "2019-08-24T14:15:22Z" ,
"full_name" : "string" ,
"id" : "string" ,
"last_scanned" : "2019-08-24T14:15:22Z" ,
"scan_state" : "string" ,
"size" : 0 ,
"state" : "string" ,
"uploaded_at" : "2019-08-24T14:15:22Z"
}
]
}
Deprecated
This operation is deprecated and may be removed in a future version of the API.
Delete a file upload input
Examples
Request Example
--request DELETE \
--url https://api.fulcradynamics.com/input/v1/file_upload/ \
--header 'Accept: application/problem+json' \
--header 'Authorization: Bearer {access-token}'
Response Example
default Response
{
"detail" : "Property foo is required but is missing." ,
"errors" : [
{
"location" : "string" ,
"message" : "string" ,
"value" : null
}
],
"instance" : "https://example.com/error-log/abc123" ,
"status" : 400 ,
"title" : "Bad Request" ,
"type" : "https://example.com/errors/example"
}
Deprecated
This operation is deprecated and may be removed in a future version of the API.
Return a file upload input
Examples
Request Example
--request GET \
--url https://api.fulcradynamics.com/input/v1/file_upload/ \
--header 'Accept: application/json' \
--header 'Authorization: Bearer {access-token}'
Response Example
200 Response
{
"archived_at" : "2019-08-24T14:15:22Z" ,
"created_at" : "2019-08-24T14:15:22Z" ,
"deleted_at" : "2019-08-24T14:15:22Z" ,
"fulcra_userid" : "string" ,
"id" : "string" ,
"last_scanned" : "2019-08-24T14:15:22Z" ,
"name" : "string" ,
"path" : "string" ,
"restored_from_id" : "string" ,
"scan_state" : "string" ,
"size" : 0 ,
"source_data_types" : [
{
"data_type" : "string" ,
"state" : "string"
}
],
"source_id" : "string" ,
"source_name" : "string" ,
"state" : "string" ,
"uploaded_at" : "2019-08-24T14:15:22Z"
}
Deprecated
This operation is deprecated and may be removed in a future version of the API.
Download a file upload input
Status
Meaning
Description
Schema
200
OK OK
None
default
Default
Error
ErrorModel
Examples
Request Example
--request GET \
--url https://api.fulcradynamics.com/input/v1/file_upload//download \
--header 'Accept: application/problem+json' \
--header 'Authorization: Bearer {access-token}'
Response Example
default Response
{
"detail" : "Property foo is required but is missing." ,
"errors" : [
{
"location" : "string" ,
"message" : "string" ,
"value" : null
}
],
"instance" : "https://example.com/error-log/abc123" ,
"status" : 400 ,
"title" : "Bad Request" ,
"type" : "https://example.com/errors/example"
}
POST /input/v1/file_upload/{input_id}/restore
Deprecated
This operation is deprecated and may be removed in a future version of the API.
Restore an archived file upload input
Examples
Request Example
--request POST \
--url https://api.fulcradynamics.com/input/v1/file_upload//restore \
--header 'Accept: application/json' \
--header 'Authorization: Bearer {access-token}'
Response Example
200 Response
{
"archived_at" : "2019-08-24T14:15:22Z" ,
"created_at" : "2019-08-24T14:15:22Z" ,
"deleted_at" : "2019-08-24T14:15:22Z" ,
"fulcra_userid" : "string" ,
"id" : "string" ,
"last_scanned" : "2019-08-24T14:15:22Z" ,
"name" : "string" ,
"path" : "string" ,
"restored_from_id" : "string" ,
"scan_state" : "string" ,
"size" : 0 ,
"source_data_types" : [
{
"data_type" : "string" ,
"state" : "string"
}
],
"source_id" : "string" ,
"source_name" : "string" ,
"state" : "string" ,
"uploaded_at" : "2019-08-24T14:15:22Z"
}
Annotations
GET /user/v1alpha1/annotation
Return a list of the user's annotations
Request
Parameters
Name
In
Type
Required
Description
fulcra_userid
query
any
false
none
annotation_type
query
any
false
none
Responses
Examples
Request Example
--request GET \
--url https://api.fulcradynamics.com/user/v1alpha1/annotation \
--header 'Accept: application/json' \
--header 'Authorization: Bearer {access-token}'
Response Example
200 Response
[
{
"annotation_type" : "duration" ,
"created_at" : "2019-08-24T14:15:22Z" ,
"deleted_at" : "2019-08-24T14:15:22Z" ,
"description" : "string" ,
"fulcra_source_id" : "string" ,
"fulcra_userid" : "6e1fcc12-f3a1-4884-be2b-1cd76a63afb7" ,
"id" : "497f6eca-6276-4993-bfeb-53cbbbba6f08" ,
"measurement_spec" : {
"boolean" : {
"value" : true
},
"measurement_type" : "boolean" ,
"metric_kind" : "cumulative" ,
"unit" : null ,
"value_type" : "boolean"
},
"name" : "string" ,
"spec" : {
"default_note" : "string" ,
"scale" : {
"label_mapping" : {
"mapping_type" : "string" ,
"string" : {
"mapping" : {
"property1" : "string" ,
"property2" : "string"
}
}
},
"scale_mapping" : {
"color" : {
"mapping" : {
"property1" : "string" ,
"property2" : "string"
}
},
"mapping_type" : "color"
}
}
},
"tags" : [
"497f6eca-6276-4993-bfeb-53cbbbba6f08"
],
"updated_at" : "2019-08-24T14:15:22Z"
}
]
POST /user/v1alpha1/annotation
Create a new annotation
Request
Request Body
{
"annotation_type" : "boolean" ,
"description" : "string" ,
"measurement_spec" : {
"boolean" : {
"value" : true
},
"measurement_type" : "boolean" ,
"metric_kind" : "cumulative" ,
"unit" : null ,
"value_type" : "boolean"
},
"name" : "string" ,
"spec" : {
"default_note" : "string"
},
"tags" : [
"497f6eca-6276-4993-bfeb-53cbbbba6f08"
]
}
Parameters
Name
In
Type
Required
Description
response_class
query
any
false
none
body
body
AnnotationRoot true
none
Responses
Examples
Request Example
--request POST \
--url https://api.fulcradynamics.com/user/v1alpha1/annotation \
--header 'Accept: application/json' \
--header 'Authorization: Bearer {access-token}' \
--header 'Content-Type: application/json' \
--data '{"annotation_type":"boolean","description":"string","measurement_spec":{"boolean":{"value":true},"measurement_type":"boolean","metric_kind":"cumulative","unit":null,"value_type":"boolean"},"name":"string","spec":{"default_note":"string"},"tags":["497f6eca-6276-4993-bfeb-53cbbbba6f08"]}'
Response Example
200 Response
DELETE /user/v1alpha1/annotation/{annotation_id}
Sets the annotation status to deleted
Request
Parameters
Name
In
Type
Required
Description
annotation_id
path
string(uuid)
true
none
fulcra_userid
query
any
false
none
Responses
Examples
Request Example
--request DELETE \
--url https://api.fulcradynamics.com/user/v1alpha1/annotation/497f6eca-6276-4993-bfeb-53cbbbba6f08 \
--header 'Accept: application/json' \
--header 'Authorization: Bearer {access-token}'
Response Example
422 Response
{
"detail" : [
{
"loc" : [
"string"
],
"msg" : "string" ,
"type" : "string"
}
]
}
GET /user/v1alpha1/annotation/{annotation_id}
Return a specific annotation
Request
Parameters
Name
In
Type
Required
Description
annotation_id
path
string(uuid)
true
none
fulcra_userid
query
any
false
none
Responses
Examples
Request Example
--request GET \
--url https://api.fulcradynamics.com/user/v1alpha1/annotation/497f6eca-6276-4993-bfeb-53cbbbba6f08 \
--header 'Accept: application/json' \
--header 'Authorization: Bearer {access-token}'
Response Example
200 Response
{
"annotation_type" : "duration" ,
"created_at" : "2019-08-24T14:15:22Z" ,
"deleted_at" : "2019-08-24T14:15:22Z" ,
"description" : "string" ,
"fulcra_source_id" : "string" ,
"fulcra_userid" : "6e1fcc12-f3a1-4884-be2b-1cd76a63afb7" ,
"id" : "497f6eca-6276-4993-bfeb-53cbbbba6f08" ,
"measurement_spec" : {
"boolean" : {
"value" : true
},
"measurement_type" : "boolean" ,
"metric_kind" : "cumulative" ,
"unit" : null ,
"value_type" : "boolean"
},
"name" : "string" ,
"spec" : {
"default_note" : "string" ,
"scale" : {
"label_mapping" : {
"mapping_type" : "string" ,
"string" : {
"mapping" : {
"property1" : "string" ,
"property2" : "string"
}
}
},
"scale_mapping" : {
"color" : {
"mapping" : {
"property1" : "string" ,
"property2" : "string"
}
},
"mapping_type" : "color"
}
}
},
"tags" : [
"497f6eca-6276-4993-bfeb-53cbbbba6f08"
],
"updated_at" : "2019-08-24T14:15:22Z"
}
PUT /user/v1alpha1/annotation/{annotation_id}
Update an existing annotation
Request
Request Body
{
"annotation_type" : "boolean" ,
"description" : "string" ,
"measurement_spec" : {
"boolean" : {
"value" : true
},
"measurement_type" : "boolean" ,
"metric_kind" : "cumulative" ,
"unit" : null ,
"value_type" : "boolean"
},
"name" : "string" ,
"spec" : {
"default_note" : "string"
},
"tags" : [
"497f6eca-6276-4993-bfeb-53cbbbba6f08"
]
}
Parameters
Name
In
Type
Required
Description
annotation_id
path
string(uuid)
true
none
fulcra_userid
query
any
false
none
body
body
AnnotationRoot true
none
Responses
Examples
Request Example
--request PUT \
--url https://api.fulcradynamics.com/user/v1alpha1/annotation/497f6eca-6276-4993-bfeb-53cbbbba6f08 \
--header 'Accept: application/json' \
--header 'Authorization: Bearer {access-token}' \
--header 'Content-Type: application/json' \
--data '{"annotation_type":"boolean","description":"string","measurement_spec":{"boolean":{"value":true},"measurement_type":"boolean","metric_kind":"cumulative","unit":null,"value_type":"boolean"},"name":"string","spec":{"default_note":"string"},"tags":["497f6eca-6276-4993-bfeb-53cbbbba6f08"]}'
Response Example
422 Response
{
"detail" : [
{
"loc" : [
"string"
],
"msg" : "string" ,
"type" : "string"
}
]
}
POST /user/v1alpha1/annotation/{annotation_id}/cancel_deletion
Sets the annotation status to active
Request
Parameters
Name
In
Type
Required
Description
annotation_id
path
string(uuid)
true
none
fulcra_userid
query
any
false
none
Responses
Examples
Request Example
--request POST \
--url https://api.fulcradynamics.com/user/v1alpha1/annotation/497f6eca-6276-4993-bfeb-53cbbbba6f08/cancel_deletion \
--header 'Accept: application/json' \
--header 'Authorization: Bearer {access-token}'
Response Example
422 Response
{
"detail" : [
{
"loc" : [
"string"
],
"msg" : "string" ,
"type" : "string"
}
]
}
GET /user/v1alpha1/schema/annotation
Return the annoation model schema in JSON schema format
Responses
Examples
Request Example
--request GET \
--url https://api.fulcradynamics.com/user/v1alpha1/schema/annotation \
--header 'Accept: application/json' \
--header 'Authorization: Bearer {access-token}'
Response Example
200 Response
GET /user/v1alpha1/schema/measurement
Return the measurement model schema in JSON schema format
Responses
Examples
Request Example
--request GET \
--url https://api.fulcradynamics.com/user/v1alpha1/schema/measurement \
--header 'Accept: application/json' \
--header 'Authorization: Bearer {access-token}'
Response Example
200 Response
Users
GET /user/v1alpha1/info
Returns information for the authenticated Fulcra user including current preferences (time zone, calendars, etc).
Request
Parameters
Name
In
Type
Required
Description
platform
query
any
false
none
Responses
Examples
Request Example
--request GET \
--url https://api.fulcradynamics.com/user/v1alpha1/info \
--header 'Accept: application/json' \
--header 'Authorization: Bearer {access-token}'
Response Example
200 Response
{
"created" : "2019-08-24T14:15:22Z" ,
"intercom_token" : "string" ,
"preferences" : {
"calendar_events_data_track_filter_map" : {
"property1" : [
"string"
],
"property2" : [
"string"
]
},
"calendars" : [
"string"
],
"location_resolution" : {
"property1" : 0 ,
"property2" : 0
},
"periods_of_day" : {
"afternoon" : "12:00:00" ,
"end_of_day" : "21:00:00" ,
"evening" : "18:00:00" ,
"morning" : "08:00:00"
},
"pinned_metrics_count_map" : {
"property1" : 0 ,
"property2" : 0
},
"selected_calendar_vendor_ids" : [
"string"
],
"selected_metrics" : [
"string"
],
"selected_metrics_map" : {
"property1" : [
"string"
],
"property2" : [
"string"
]
},
"timezone" : "string"
},
"service_status" : {
"active_until" : "2019-08-24T14:15:22Z" ,
"grace_period_ends" : "2019-08-24T14:15:22Z" ,
"is_active" : true ,
"manage_url" : "string" ,
"service_type" : "subscribed_apple"
},
"status" : "string" ,
"tier" : "string" ,
"userid" : "4c3716c4-7217-4d1b-b0ed-f18a56ef1093"
}
GET /user/v1alpha1/preferences
Return the current preferences and settings for the authenticated Fulcra user
Responses
Examples
Request Example
--request GET \
--url https://api.fulcradynamics.com/user/v1alpha1/preferences \
--header 'Accept: application/json' \
--header 'Authorization: Bearer {access-token}'
Response Example
200 Response
{
"calendar_events_data_track_filter_map" : {
"property1" : [
"string"
],
"property2" : [
"string"
]
},
"calendars" : [
"string"
],
"location_resolution" : {
"property1" : 0 ,
"property2" : 0
},
"periods_of_day" : {
"afternoon" : "12:00:00" ,
"end_of_day" : "21:00:00" ,
"evening" : "18:00:00" ,
"morning" : "08:00:00"
},
"pinned_metrics_count_map" : {
"property1" : 0 ,
"property2" : 0
},
"selected_calendar_vendor_ids" : [
"string"
],
"selected_metrics" : [
"string"
],
"selected_metrics_map" : {
"property1" : [
"string"
],
"property2" : [
"string"
]
},
"timezone" : "string"
}
POST /user/v1alpha1/preferences
Set current preferences for the authenticated Fulcra user
Request
Request Body
{
"calendar_events_data_track_filter_map" : {
"property1" : [
"string"
],
"property2" : [
"string"
]
},
"calendars" : [
"string"
],
"location_resolution" : {
"property1" : 0 ,
"property2" : 0
},
"periods_of_day" : {
"afternoon" : "12:00:00" ,
"end_of_day" : "21:00:00" ,
"evening" : "18:00:00" ,
"morning" : "08:00:00"
},
"pinned_metrics_count_map" : {
"property1" : 0 ,
"property2" : 0
},
"selected_calendar_vendor_ids" : [
"string"
],
"selected_metrics" : [
"string"
],
"selected_metrics_map" : {
"property1" : [
"string"
],
"property2" : [
"string"
]
},
"timezone" : "string"
}
Parameters
Responses
Examples
Request Example
--request POST \
--url https://api.fulcradynamics.com/user/v1alpha1/preferences \
--header 'Accept: application/json' \
--header 'Authorization: Bearer {access-token}' \
--header 'Content-Type: application/json' \
--data '{"calendar_events_data_track_filter_map":{"property1":["string"],"property2":["string"]},"calendars":["string"],"location_resolution":{"property1":0,"property2":0},"periods_of_day":{"afternoon":"12:00:00","end_of_day":"21:00:00","evening":"18:00:00","morning":"08:00:00"},"pinned_metrics_count_map":{"property1":0,"property2":0},"selected_calendar_vendor_ids":["string"],"selected_metrics":["string"],"selected_metrics_map":{"property1":["string"],"property2":["string"]},"timezone":"string"}'
Response Example
200 Response
{
"calendar_events_data_track_filter_map" : {
"property1" : [
"string"
],
"property2" : [
"string"
]
},
"calendars" : [
"string"
],
"location_resolution" : {
"property1" : 0 ,
"property2" : 0
},
"periods_of_day" : {
"afternoon" : "12:00:00" ,
"end_of_day" : "21:00:00" ,
"evening" : "18:00:00" ,
"morning" : "08:00:00"
},
"pinned_metrics_count_map" : {
"property1" : 0 ,
"property2" : 0
},
"selected_calendar_vendor_ids" : [
"string"
],
"selected_metrics" : [
"string"
],
"selected_metrics_map" : {
"property1" : [
"string"
],
"property2" : [
"string"
]
},
"timezone" : "string"
}
GET /user/v1alpha1/tag
Return a collection of a Fulcra User's configured tags
Examples
Request Example
--request GET \
--url https://api.fulcradynamics.com/user/v1alpha1/tag \
--header 'Accept: application/json' \
--header 'Authorization: Bearer {access-token}'
Response Example
200 Response
[
{
"id" : "497f6eca-6276-4993-bfeb-53cbbbba6f08" ,
"name" : "string"
}
]
POST /user/v1alpha1/tag
Create a new tag for a Fulcra User
Request
Request Body
Parameters
Responses
Examples
Request Example
--request POST \
--url https://api.fulcradynamics.com/user/v1alpha1/tag \
--header 'Accept: application/json' \
--header 'Authorization: Bearer {access-token}' \
--header 'Content-Type: application/json' \
--data '{"name":"string"}'
Response Example
422 Response
{
"detail" : [
{
"loc" : [
"string"
],
"msg" : "string" ,
"type" : "string"
}
]
}
DELETE /user/v1alpha1/tag/id/{tag_id}
Deletes a tag
Request
Parameters
Name
In
Type
Required
Description
tag_id
path
string(uuid)
true
none
Responses
Examples
Request Example
--request DELETE \
--url https://api.fulcradynamics.com/user/v1alpha1/tag/id/497f6eca-6276-4993-bfeb-53cbbbba6f08 \
--header 'Accept: application/json' \
--header 'Authorization: Bearer {access-token}'
Response Example
422 Response
{
"detail" : [
{
"loc" : [
"string"
],
"msg" : "string" ,
"type" : "string"
}
]
}
GET /user/v1alpha1/tag/id/{tag_id}
Returns information on a Fulcra User's configured tag by tag ID
Request
Parameters
Name
In
Type
Required
Description
tag_id
path
string(uuid)
true
none
Responses
Examples
Request Example
--request GET \
--url https://api.fulcradynamics.com/user/v1alpha1/tag/id/497f6eca-6276-4993-bfeb-53cbbbba6f08 \
--header 'Accept: application/json' \
--header 'Authorization: Bearer {access-token}'
Response Example
200 Response
{
"id" : "497f6eca-6276-4993-bfeb-53cbbbba6f08" ,
"name" : "string"
}
Returns information on a Fulcra User's configured tag by tag name
Request
Parameters
Name
In
Type
Required
Description
tag_name
path
string
true
none
Responses
Examples
Request Example
--request GET \
--url https://api.fulcradynamics.com/user/v1alpha1/tag/name/string \
--header 'Accept: application/json' \
--header 'Authorization: Bearer {access-token}'
Response Example
200 Response
{
"id" : "497f6eca-6276-4993-bfeb-53cbbbba6f08" ,
"name" : "string"
}
Schemas
AggregateFunction
AggregateFunction
Properties
Name
Type
Required
Restrictions
Description
AggregateFunction
string
false
none
none
Enumerated Values
Property
Value
AggregateFunction
sum
AggregateFunction
avg
AggregateFunction
min
AggregateFunction
max
AggregateResolution
AggregateResolution
Properties
Name
Type
Required
Restrictions
Description
AggregateResolution
string
false
none
none
Enumerated Values
Property
Value
AggregateResolution
15m
AggregateResolution
60m
AggregateResolution
day
AnnotationRoot
{
"annotation_type" : "boolean" ,
"description" : "string" ,
"measurement_spec" : {
"boolean" : {
"value" : true
},
"measurement_type" : "boolean" ,
"metric_kind" : "cumulative" ,
"unit" : null ,
"value_type" : "boolean"
},
"name" : "string" ,
"spec" : {
"default_note" : "string"
},
"tags" : [
"497f6eca-6276-4993-bfeb-53cbbbba6f08"
]
}
AnnotationRoot
Properties
Name
Type
Required
Restrictions
Description
AnnotationRoot
any
false
none
none
oneOf
Name
Type
Required
Restrictions
Description
anonymous BooleanAnnotation false
none
Represents an annotation with a yes or no measurement
xor
Name
Type
Required
Restrictions
Description
anonymous DurationAnnotation false
none
Represents an annotation with a time interval measurement
xor
Name
Type
Required
Restrictions
Description
anonymous MomentAnnotation false
none
Represents an annotation with no measurement
xor
Name
Type
Required
Restrictions
Description
anonymous NumericAnnotation false
none
Represents an annotation with a quantitative property measurement
xor
Name
Type
Required
Restrictions
Description
anonymous PeopleAnnotation false
none
Represents an annotation recording contact with other people
xor
Name
Type
Required
Restrictions
Description
anonymous ScaleAnnotation false
none
Represents an annotation with a fixed scale measurement and customizable display
AnnotationRow
{
"annotation_type" : "duration" ,
"created_at" : "2019-08-24T14:15:22Z" ,
"deleted_at" : "2019-08-24T14:15:22Z" ,
"description" : "string" ,
"fulcra_source_id" : "string" ,
"fulcra_userid" : "6e1fcc12-f3a1-4884-be2b-1cd76a63afb7" ,
"id" : "497f6eca-6276-4993-bfeb-53cbbbba6f08" ,
"measurement_spec" : {
"boolean" : {
"value" : true
},
"measurement_type" : "boolean" ,
"metric_kind" : "cumulative" ,
"unit" : null ,
"value_type" : "boolean"
},
"name" : "string" ,
"spec" : {
"default_note" : "string" ,
"scale" : {
"label_mapping" : {
"mapping_type" : "string" ,
"string" : {
"mapping" : {
"property1" : "string" ,
"property2" : "string"
}
}
},
"scale_mapping" : {
"color" : {
"mapping" : {
"property1" : "string" ,
"property2" : "string"
}
},
"mapping_type" : "color"
}
}
},
"tags" : [
"497f6eca-6276-4993-bfeb-53cbbbba6f08"
],
"updated_at" : "2019-08-24T14:15:22Z"
}
AnnotationRow
Properties
Name
Type
Required
Restrictions
Description
annotation_type
AnnotationType true
none
Annotation type
created_at
string(date-time)
true
none
none
deleted_at
any
false
none
none
anyOf
Name
Type
Required
Restrictions
Description
» anonymous
string(date-time)
false
none
none
or
Name
Type
Required
Restrictions
Description
» anonymous
null
false
none
none
continued
Name
Type
Required
Restrictions
Description
description
string
true
none
Description
fulcra_source_id
string
true
read-only
none
fulcra_userid
string(uuid)
true
none
none
id
string(uuid)
true
none
none
measurement_spec
any
false
none
Measurement spec
anyOf - discriminator: measurement_type
Name
Type
Required
Restrictions
Description
» anonymous
any
false
none
none
oneOf
Name
Type
Required
Restrictions
Description
»» anonymous
BooleanMeasurement false
none
Represents a yes or no measurement configuration
xor
Name
Type
Required
Restrictions
Description
»» anonymous
CountMeasurement false
none
Represents a count measurement configuration
xor
Name
Type
Required
Restrictions
Description
»» anonymous
CustomMeasurement false
none
Represents a custom non-convertable measurement configuration
xor
Name
Type
Required
Restrictions
Description
»» anonymous
DistanceMeasurement false
none
Represents a distance or length measurement configuration
xor
Name
Type
Required
Restrictions
Description
»» anonymous
DurationMeasurement false
none
Represents a time duration measurement configuration
xor
Name
Type
Required
Restrictions
Description
»» anonymous
MassMeasurement false
none
Represents a mass measurement configuration and may be inferred from weight
xor
Name
Type
Required
Restrictions
Description
»» anonymous
PercentMeasurement false
none
Represents a percentage measurement configuration
xor
Name
Type
Required
Restrictions
Description
»» anonymous
PeriodMeasurement false
none
Represents a time period measurement configuration
xor
Name
Type
Required
Restrictions
Description
»» anonymous
ScaleMeasurement false
none
Represents a discrete scale measurement configuration with minimum and maximum values
xor
Name
Type
Required
Restrictions
Description
»» anonymous
TemperatureMeasurement false
none
Represents a temperature measurement configuration
xor
Name
Type
Required
Restrictions
Description
»» anonymous
VolumeMeasurement false
none
Represents a physical volume measurement configuration
or
Name
Type
Required
Restrictions
Description
» anonymous
null
false
none
none
continued
Name
Type
Required
Restrictions
Description
name
string
true
none
Name
spec
any
false
none
Type-specific spec
anyOf
or
or
Name
Type
Required
Restrictions
Description
» anonymous
null
false
none
none
continued
Name
Type
Required
Restrictions
Description
tags
[string]
true
none
Default tags
updated_at
string(date-time)
true
none
none
AnnotationSpecContainer
{
"default_note" : "string"
}
AnnotationSpecContainer
Properties
Name
Type
Required
Restrictions
Description
default_note
any
false
none
Default note text, if any
anyOf
Name
Type
Required
Restrictions
Description
» anonymous
string
false
none
none
or
Name
Type
Required
Restrictions
Description
» anonymous
null
false
none
none
AnnotationType
AnnotationType
Properties
Name
Type
Required
Restrictions
Description
AnnotationType
string
false
none
Represents the base type of an annotation
Enumerated Values
Property
Value
AnnotationType
duration
AnnotationType
moment
AnnotationType
numeric
AnnotationType
people
AnnotationType
scale
AnnotationType
boolean
BooleanAnnotation
{
"annotation_type" : "boolean" ,
"description" : "string" ,
"measurement_spec" : {
"boolean" : {
"value" : true
},
"measurement_type" : "boolean" ,
"metric_kind" : "cumulative" ,
"unit" : null ,
"value_type" : "boolean"
},
"name" : "string" ,
"spec" : {
"default_note" : "string"
},
"tags" : [
"497f6eca-6276-4993-bfeb-53cbbbba6f08"
]
}
BooleanAnnotation
Properties
Name
Type
Required
Restrictions
Description
annotation_type
string
false
none
none
description
string
true
none
Description
measurement_spec
BooleanMeasurement true
none
Represents a yes or no measurement configuration
name
string
true
none
Name
spec
any
false
none
none
anyOf
or
Name
Type
Required
Restrictions
Description
» anonymous
null
false
none
none
continued
Name
Type
Required
Restrictions
Description
tags
[string]
true
none
Default tags
BooleanMeasurement
{
"boolean" : {
"value" : true
},
"measurement_type" : "boolean" ,
"metric_kind" : "cumulative" ,
"unit" : null ,
"value_type" : "boolean"
}
BooleanMeasurement
Properties
Name
Type
Required
Restrictions
Description
boolean
BooleanMeasurementSpec true
none
none
measurement_type
string
false
none
none
metric_kind
MetricKind false
none
How the measurement should be aggregated
unit
null
false
none
none
value_type
string
false
none
none
BooleanMeasurementSpec
BooleanMeasurementSpec
Properties
Name
Type
Required
Restrictions
Description
value
any
false
none
Default value
anyOf
Name
Type
Required
Restrictions
Description
» anonymous
boolean
false
none
none
or
Name
Type
Required
Restrictions
Description
» anonymous
null
false
none
none
BoundsResponse
{
"end_date" : "2019-08-24T14:15:22Z" ,
"start_date" : "2019-08-24T14:15:22Z"
}
BoundsResponse
Properties
Name
Type
Required
Restrictions
Description
end_date
any
true
none
the ending date/time of this data set
anyOf
Name
Type
Required
Restrictions
Description
» anonymous
string(date-time)
false
none
none
or
Name
Type
Required
Restrictions
Description
» anonymous
null
false
none
none
continued
Name
Type
Required
Restrictions
Description
start_date
any
true
none
the starting date/time of this data set
anyOf
Name
Type
Required
Restrictions
Description
» anonymous
string(date-time)
false
none
none
or
Name
Type
Required
Restrictions
Description
» anonymous
null
false
none
none
{
"color" : {
"mapping" : {
"property1" : "string" ,
"property2" : "string"
}
},
"mapping_type" : "color"
}
ColorScaleMapping
Properties
ColorScaleMapping-Output
{
"color" : {
"mapping" : {
"property1" : "string" ,
"property2" : "string"
}
},
"mapping_type" : "color"
}
ColorScaleMapping
Properties
{
"mapping" : {
"property1" : "string" ,
"property2" : "string"
}
}
ColorScaleMappingSpec
Properties
Name
Type
Required
Restrictions
Description
mapping
object
true
none
Mapping of scale values to colors, normalized to hex format
» additionalProperties
string(color)
false
none
none
ColorScaleMappingSpec-Output
{
"mapping" : {
"property1" : "string" ,
"property2" : "string"
}
}
ColorScaleMappingSpec
Properties
Name
Type
Required
Restrictions
Description
mapping
object
true
none
Mapping of scale values to colors, normalized to hex format
» additionalProperties
string
false
none
none
CountMeasurement
{
"count" : {
"value" : 0
},
"measurement_type" : "count" ,
"metric_kind" : "cumulative" ,
"unit" : null ,
"value_type" : "real"
}
CountMeasurement
Properties
Name
Type
Required
Restrictions
Description
count
CountMeasurementSpec true
none
none
measurement_type
string
false
none
none
metric_kind
MetricKind false
none
How the measurement should be aggregated
unit
null
false
none
none
value_type
string
false
none
none
CountMeasurementSpec
CountMeasurementSpec
Properties
Name
Type
Required
Restrictions
Description
value
any
false
none
Default value
anyOf
Name
Type
Required
Restrictions
Description
» anonymous
number
false
none
none
or
Name
Type
Required
Restrictions
Description
» anonymous
null
false
none
none
CreateFileUploadRequestBody
{
"content_length" : 0 ,
"content_type" : "string" ,
"name" : "string" ,
"path" : "string"
}
Properties
Name
Type
Required
Restrictions
Description
content_length
integer(int64)
true
none
none
content_type
string
true
none
none
name
string
true
none
none
path
string
true
none
none
CreateFileUploadResponseBody
{
"file" : {
"archived_at" : "2019-08-24T14:15:22Z" ,
"created_at" : "2019-08-24T14:15:22Z" ,
"deleted_at" : "2019-08-24T14:15:22Z" ,
"fulcra_userid" : "string" ,
"id" : "string" ,
"last_scanned" : "2019-08-24T14:15:22Z" ,
"name" : "string" ,
"path" : "string" ,
"restored_from_id" : "string" ,
"scan_state" : "string" ,
"size" : 0 ,
"source_data_types" : [
{
"data_type" : "string" ,
"state" : "string"
}
],
"source_id" : "string" ,
"source_name" : "string" ,
"state" : "string" ,
"uploaded_at" : "2019-08-24T14:15:22Z"
},
"url" : "string"
}
Properties
Name
Type
Required
Restrictions
Description
file
FulcraFileUploadInput true
none
none
url
string
true
none
none
{
"default_event_tags" : [
"string"
],
"description" : "string" ,
"fulcra_data_type" : "string" ,
"fulcra_source" : [
"string"
],
"name" : "string"
}
Properties
Name
Type
Required
Restrictions
Description
default_event_tags
array,null
false
none
none
description
string,null
false
none
none
fulcra_data_type
string,null
false
none
none
fulcra_source
array,null
false
none
none
name
string
true
none
none
CreateFulcraReflectionRequest
{
"annotations" : [],
"data_types" : [],
"description" : "string" ,
"name" : "string" ,
"parent_template_id" : "string" ,
"schedule" : {
"cron" : "string" ,
"end_at" : "string" ,
"paused" : true ,
"start_at" : "string" ,
"time_zone" : "string"
}
}
Properties
Name
Type
Required
Restrictions
Description
annotations
array,null
false
none
none
data_types
array,null
false
none
none
description
string
false
none
none
name
string
true
none
none
parent_template_id
string
false
none
none
schedule
FulcraReflectionSchedule true
none
none
CreateFulcraTagRequest
CreateFulcraTagRequest
Properties
Name
Type
Required
Restrictions
Description
name
string
true
none
none
CustomMeasurement
{
"custom" : {
"value" : 0
},
"measurement_type" : "custom" ,
"metric_kind" : "cumulative" ,
"unit" : "string" ,
"value_type" : "real"
}
CustomMeasurement
Properties
Name
Type
Required
Restrictions
Description
custom
CustomMeasurementSpec true
none
none
measurement_type
string
false
none
none
metric_kind
MetricKind false
none
How the measurement should be aggregated
unit
any
false
none
none
anyOf
Name
Type
Required
Restrictions
Description
» anonymous
string
false
none
none
or
Name
Type
Required
Restrictions
Description
» anonymous
null
false
none
none
continued
Name
Type
Required
Restrictions
Description
value_type
string
false
none
none
CustomMeasurementSpec
CustomMeasurementSpec
Properties
Name
Type
Required
Restrictions
Description
value
any
false
none
Default value
anyOf
Name
Type
Required
Restrictions
Description
» anonymous
number
false
none
none
or
Name
Type
Required
Restrictions
Description
» anonymous
null
false
none
none
DataMetric
{
"description" : "string" ,
"is_time_series" : false ,
"metric_kind" : "string" ,
"name" : "string" ,
"unit" : "string" ,
"value_column" : "string"
}
DataMetric
Properties
Name
Type
Required
Restrictions
Description
description
string
true
none
A human-readable description of the metric.
is_time_series
boolean
false
none
This is true when the metric is a time-series metric.
metric_kind
any
false
none
The kind of metric.
anyOf
Name
Type
Required
Restrictions
Description
» anonymous
string
false
none
none
or
Name
Type
Required
Restrictions
Description
» anonymous
null
false
none
none
continued
Name
Type
Required
Restrictions
Description
name
string
true
none
The name of the metric.
unit
string
true
none
The measurement unit of the value column.
value_column
string
true
none
The name of the value column in the resulting dataframe.
{
"content_type" : "string" ,
"data_type" : "string" ,
"id" : "497f6eca-6276-4993-bfeb-53cbbbba6f08" ,
"recorded_at" : "2019-08-24T14:15:22Z" ,
"source" : [],
"tags" : []
}
DataRecordMetadataV1
Properties
Name
Type
Required
Restrictions
Description
content_type
any
false
none
none
anyOf
Name
Type
Required
Restrictions
Description
» anonymous
string
false
none
none
or
Name
Type
Required
Restrictions
Description
» anonymous
null
false
none
none
continued
Name
Type
Required
Restrictions
Description
data_type
string
true
none
none
id
any
false
none
none
anyOf
Name
Type
Required
Restrictions
Description
» anonymous
string(uuid)
false
none
none
or
Name
Type
Required
Restrictions
Description
» anonymous
null
false
none
none
continued
Name
Type
Required
Restrictions
Description
recorded_at
any
false
none
none
anyOf
Name
Type
Required
Restrictions
Description
» anonymous
string(date-time)
false
none
none
or
Name
Type
Required
Restrictions
Description
» anonymous
DateTimeRange false
none
none
continued
Name
Type
Required
Restrictions
Description
source
[string]
false
none
none
tags
[string]
false
none
none
DataRecordV1
{
"data" : "string" ,
"metadata" : {
"content_type" : "string" ,
"data_type" : "string" ,
"id" : "497f6eca-6276-4993-bfeb-53cbbbba6f08" ,
"recorded_at" : "2019-08-24T14:15:22Z" ,
"source" : [],
"tags" : []
},
"specversion" : 1
}
DataRecordV1
Properties
Name
Type
Required
Restrictions
Description
data
string
true
none
none
metadata
DataRecordMetadataV1 true
none
none
specversion
integer
false
none
none
DateTimeRange
{
"end_time" : "2019-08-24T14:15:22Z" ,
"start_time" : "2019-08-24T14:15:22Z"
}
DateTimeRange
Properties
Name
Type
Required
Restrictions
Description
end_time
string(date-time)
true
none
none
start_time
string(date-time)
true
none
none
DistanceMeasurement
{
"distance" : {
"value" : 0
},
"measurement_type" : "distance" ,
"metric_kind" : "cumulative" ,
"unit" : "inch" ,
"value_type" : "real"
}
DistanceMeasurement
Properties
Name
Type
Required
Restrictions
Description
distance
DistanceMeasurementSpec true
none
none
measurement_type
string
false
none
none
metric_kind
MetricKind false
none
How the measurement should be aggregated
unit
any
false
none
none
anyOf
Name
Type
Required
Restrictions
Description
» anonymous
DistanceUnit false
none
none
or
Name
Type
Required
Restrictions
Description
» anonymous
null
false
none
none
continued
Name
Type
Required
Restrictions
Description
value_type
string
false
none
none
DistanceMeasurementSpec
DistanceMeasurementSpec
Properties
Name
Type
Required
Restrictions
Description
value
any
false
none
Default value
anyOf
Name
Type
Required
Restrictions
Description
» anonymous
number
false
none
none
or
Name
Type
Required
Restrictions
Description
» anonymous
null
false
none
none
DistanceUnit
DistanceUnit
Properties
Name
Type
Required
Restrictions
Description
DistanceUnit
string
false
none
none
Enumerated Values
Property
Value
DistanceUnit
inch
DistanceUnit
foot
DistanceUnit
yard
DistanceUnit
mile
DistanceUnit
millimeter
DistanceUnit
centimeter
DistanceUnit
meter
DistanceUnit
kilometer
DurationAnnotation
{
"annotation_type" : "duration" ,
"description" : "string" ,
"measurement_spec" : {
"measurement_type" : "duration" ,
"metric_kind" : "cumulative" ,
"unit" : null ,
"value_type" : "duration"
},
"name" : "string" ,
"spec" : {
"default_note" : "string"
},
"tags" : [
"497f6eca-6276-4993-bfeb-53cbbbba6f08"
]
}
DurationAnnotation
Properties
Name
Type
Required
Restrictions
Description
annotation_type
string
false
none
none
description
string
true
none
Description
measurement_spec
DurationMeasurement true
none
Represents a time duration measurement configuration
name
string
true
none
Name
spec
any
false
none
none
anyOf
or
Name
Type
Required
Restrictions
Description
» anonymous
null
false
none
none
continued
Name
Type
Required
Restrictions
Description
tags
[string]
true
none
Default tags
DurationMeasurement
{
"measurement_type" : "duration" ,
"metric_kind" : "cumulative" ,
"unit" : null ,
"value_type" : "duration"
}
DurationMeasurement
Properties
Name
Type
Required
Restrictions
Description
measurement_type
string
false
none
none
metric_kind
MetricKind false
none
How the measurement should be aggregated
unit
null
false
none
none
value_type
string
false
none
none
{
"color" : {
"mapping" : {
"property1" : "string" ,
"property2" : "string"
}
},
"mapping_type" : "emoji" ,
"string" : {
"mapping" : {
"property1" : "string" ,
"property2" : "string"
}
}
}
EmojiScaleMapping
Properties
EmojiScaleMapping-Output
{
"color" : {
"mapping" : {
"property1" : "string" ,
"property2" : "string"
}
},
"mapping_type" : "emoji" ,
"string" : {
"mapping" : {
"property1" : "string" ,
"property2" : "string"
}
}
}
EmojiScaleMapping
Properties
ErrorDetail
{
"location" : "string" ,
"message" : "string" ,
"value" : null
}
Properties
Name
Type
Required
Restrictions
Description
location
string
false
none
Where the error occurred, e.g. 'body.items[3].tags' or 'path.thing-id'
message
string
false
none
Error message text
value
any
false
none
The value at the given location
ErrorModel
{
"detail" : "Property foo is required but is missing." ,
"errors" : [
{
"location" : "string" ,
"message" : "string" ,
"value" : null
}
],
"instance" : "https://example.com/error-log/abc123" ,
"status" : 400 ,
"title" : "Bad Request" ,
"type" : "https://example.com/errors/example"
}
Properties
Name
Type
Required
Restrictions
Description
detail
string
false
none
A human-readable explanation specific to this occurrence of the problem.
errors
array,null
false
none
Optional list of individual error details
instance
string(uri)
false
none
A URI reference that identifies the specific occurrence of the problem.
status
integer(int64)
false
none
HTTP status code
title
string
false
none
A short, human-readable summary of the problem type. This value should not change between occurrences of the error.
type
string(uri)
false
none
A URI reference to human-readable documentation for the error.
FulcraAPISessionRow
{
"created_at" : "2019-08-24T14:15:22Z" ,
"deleted_at" : "2019-08-24T14:15:22Z" ,
"fulcra_userid" : "6e1fcc12-f3a1-4884-be2b-1cd76a63afb7" ,
"id" : "497f6eca-6276-4993-bfeb-53cbbbba6f08" ,
"name" : "string" ,
"policy_id" : "ee9b03e0-6495-427a-85a5-34444d24ae04"
}
FulcraAPISessionRow
Properties
Name
Type
Required
Restrictions
Description
created_at
string(date-time)
true
none
none
deleted_at
any
true
none
none
anyOf
Name
Type
Required
Restrictions
Description
» anonymous
string(date-time)
false
none
none
or
Name
Type
Required
Restrictions
Description
» anonymous
null
false
none
none
continued
Name
Type
Required
Restrictions
Description
fulcra_userid
string(uuid)
true
none
none
id
string(uuid)
true
none
none
name
string
true
none
none
policy_id
any
false
none
none
anyOf
Name
Type
Required
Restrictions
Description
» anonymous
string(uuid)
false
none
none
or
Name
Type
Required
Restrictions
Description
» anonymous
null
false
none
none
FulcraAPIVersion
FulcraAPIVersion
Properties
Name
Type
Required
Restrictions
Description
FulcraAPIVersion
string
false
none
fulcra API versions
Enumerated Values
Property
Value
FulcraAPIVersion
v0
FulcraAPIVersion
v1alpha1
FulcraAPIVersion
v1
FulcraAppleWorkout
{
"all_statistics" : {},
"apple_workout_id" : "17d1ac31-161c-41b7-bb0c-8c7db70b55d8" ,
"device" : {},
"duration" : 0 ,
"end_date" : "2019-08-24T14:15:22Z" ,
"extras" : {},
"has_undetermined_duration" : true ,
"source_revision" : {},
"start_date" : "2019-08-24T14:15:22Z" ,
"workout_activities" : [
{}
],
"workout_activity_type" : "The type of workout." ,
"workout_events" : [
{}
]
}
FulcraAppleWorkout
Properties
Name
Type
Required
Restrictions
Description
all_statistics
object
true
none
A collection of descriptive statistics for the workout.
apple_workout_id
string(uuid)
true
none
Workout ID
device
any
true
none
Details of the device that recorded the workout,
anyOf
Name
Type
Required
Restrictions
Description
» anonymous
object
false
none
none
or
Name
Type
Required
Restrictions
Description
» anonymous
null
false
none
none
continued
Name
Type
Required
Restrictions
Description
duration
number
true
none
Length of the workout (seconds)
end_date
string(date-time)
true
none
the date/time when this workout ends
extras
any
true
none
Extra values that are not (yet) accounted for in the schema.
anyOf
Name
Type
Required
Restrictions
Description
» anonymous
object
false
none
none
or
Name
Type
Required
Restrictions
Description
» anonymous
null
false
none
none
continued
Name
Type
Required
Restrictions
Description
has_undetermined_duration
boolean
true
none
indicates whether or not this workout has an unknown duration
source_revision
object
true
none
Details of the source application or device that recorded the workout.
start_date
string(date-time)
true
none
the date/time when this workout starts
workout_activities
[object]
true
none
An ordered list of time segments that describe the workout.
workout_activity_type
string
false
none
none
workout_events
[object]
true
none
An ordered list of events that occurred during the workout.
FulcraCalendar
{
"calendar_color" : "string" ,
"calendar_id" : "c828ce68-4c5a-4491-b76a-af3d888d3f97" ,
"calendar_identifier" : "string" ,
"calendar_name" : "string" ,
"calendar_source_id" : "string" ,
"calendar_source_name" : "string" ,
"calendar_type" : "string" ,
"color" : "Calendar Color" ,
"fulcra_source" : "string" ,
"inserted_at" : "2019-08-24T14:15:22Z" ,
"is_immutable" : true ,
"is_subscribed" : true ,
"source_type" : "string"
}
FulcraCalendar
Properties
Name
Type
Required
Restrictions
Description
calendar_color
string
true
none
Calendar Color
calendar_id
string(uuid)
true
none
Calendar ID
calendar_identifier
string
true
none
Calendar Device Identifier
calendar_name
string
true
none
Calendar Name
calendar_source_id
string
true
none
Calendar Source ID
calendar_source_name
string
true
none
Calendar Source Name
calendar_type
string
true
none
Calendar Type
color
string
false
none
none
fulcra_source
string
true
none
Fulcra Datasource Name
inserted_at
string(date-time)
true
none
Date of First Upload
is_immutable
boolean
true
none
Calendar Is-Immutable Flag
is_subscribed
boolean
true
none
Is Calendar Subscribed To
source_type
string
true
none
Calendar Source Type
FulcraCalendarEvent
{
"allow_new_time_proposals" : true ,
"availability" : "string" ,
"calendar_event_id" : "7fe777b6-1e25-45fe-a4a1-3723b5fd440f" ,
"calendar_id" : "c828ce68-4c5a-4491-b76a-af3d888d3f97" ,
"calendar_item_external_identifier" : "string" ,
"calendar_item_identifier" : "string" ,
"creation_date" : "2019-08-24T14:15:22Z" ,
"end_date" : "2019-08-24T14:15:22Z" ,
"event_identifier" : "string" ,
"extras" : {},
"geolocation" : {
"altitude" : 0 ,
"ellipsoidal_altitude" : 0 ,
"floor" : 0 ,
"horizontal_accuracy" : 0 ,
"is_produced_by_accessory" : true ,
"is_simulated_by_software" : true ,
"latitude" : 0 ,
"location_timestamp" : "2019-08-24T14:15:22Z" ,
"longitude" : 0 ,
"radius" : 0 ,
"title" : "string" ,
"vertical_accuracy" : 0
},
"has_alarms" : true ,
"has_attendees" : true ,
"has_notes" : true ,
"has_recurrence_rules" : true ,
"is_all_day" : true ,
"is_detached" : true ,
"last_modified_date" : "2019-08-24T14:15:22Z" ,
"location" : "string" ,
"notes" : "string" ,
"occurrence_date" : "2019-08-24T14:15:22Z" ,
"organizer" : "e28f9b28-e5bc-4a12-aafc-96f3301f7fe0" ,
"participants" : [
{
"contact_id" : "f245e2a3-e141-4d41-912c-b1c1f5bd5598" ,
"is_current_user" : true ,
"name" : "string" ,
"participant_role" : "string" ,
"participant_status" : "string" ,
"participant_type" : "string" ,
"url" : "string"
}
],
"recurrence_rules" : [
{
"calendar_id" : "c828ce68-4c5a-4491-b76a-af3d888d3f97" ,
"days_of_the_month" : [
null
],
"days_of_the_week" : [
null
],
"days_of_the_year" : [
null
],
"first_day_of_the_week" : 0 ,
"frequency" : "string" ,
"interval" : 0 ,
"months_of_the_year" : [
null
],
"recurrence_rule_id" : "ff66070e-89d9-4007-ac1d-92d2556a9349" ,
"set_positions" : [
null
],
"weeks_of_the_year" : [
null
]
}
],
"start_date" : "2019-08-24T14:15:22Z" ,
"status" : "string" ,
"time_zone" : "string" ,
"title" : "string" ,
"url" : "string"
}
FulcraCalendarEvent
Properties
Name
Type
Required
Restrictions
Description
allow_new_time_proposals
any
true
none
True if attendees may propose a new time when responding
anyOf
Name
Type
Required
Restrictions
Description
» anonymous
boolean
false
none
none
or
Name
Type
Required
Restrictions
Description
» anonymous
null
false
none
none
continued
Name
Type
Required
Restrictions
Description
availability
any
true
none
A string that indicates the event's availability status the calendar.
anyOf
Name
Type
Required
Restrictions
Description
» anonymous
string
false
none
none
or
Name
Type
Required
Restrictions
Description
» anonymous
null
false
none
none
continued
Name
Type
Required
Restrictions
Description
calendar_event_id
string(uuid)
true
none
Calendar Event ID
calendar_id
string(uuid)
true
none
Calendar ID
calendar_item_external_identifier
any
true
none
The external identifier for this calendar event, as provided by an external calendar server.
anyOf
Name
Type
Required
Restrictions
Description
» anonymous
string
false
none
none
or
Name
Type
Required
Restrictions
Description
» anonymous
null
false
none
none
continued
Name
Type
Required
Restrictions
Description
calendar_item_identifier
any
true
none
The identifier for this calendar item, as sent by the device. May be different from event_identifier.
anyOf
Name
Type
Required
Restrictions
Description
» anonymous
string
false
none
none
or
Name
Type
Required
Restrictions
Description
» anonymous
null
false
none
none
continued
Name
Type
Required
Restrictions
Description
creation_date
any
true
none
The date when this event was created.
anyOf
Name
Type
Required
Restrictions
Description
» anonymous
string(date-time)
false
none
none
or
Name
Type
Required
Restrictions
Description
» anonymous
null
false
none
none
continued
Name
Type
Required
Restrictions
Description
end_date
string(date-time)
true
none
the date/time when this event ends.
event_identifier
any
true
none
The identifier for this event, as sent by the device. May be different from calendar_item_identifier.
anyOf
Name
Type
Required
Restrictions
Description
» anonymous
string
false
none
none
or
Name
Type
Required
Restrictions
Description
» anonymous
null
false
none
none
continued
Name
Type
Required
Restrictions
Description
extras
any
true
none
Extra values that are not (yet) accounted for in the schema.
anyOf
Name
Type
Required
Restrictions
Description
» anonymous
object
false
none
none
or
Name
Type
Required
Restrictions
Description
» anonymous
null
false
none
none
continued
Name
Type
Required
Restrictions
Description
geolocation
any
true
none
The structured location (coordinates) of the event.
anyOf
Name
Type
Required
Restrictions
Description
» anonymous
GeofenceLocation false
none
Represents a geofence: in other words, a specific location in the real world
or
Name
Type
Required
Restrictions
Description
» anonymous
null
false
none
none
continued
Name
Type
Required
Restrictions
Description
has_alarms
any
true
none
True if the device indicates that the event has alarms.
anyOf
Name
Type
Required
Restrictions
Description
» anonymous
boolean
false
none
none
or
Name
Type
Required
Restrictions
Description
» anonymous
null
false
none
none
continued
Name
Type
Required
Restrictions
Description
has_attendees
any
true
none
True if the device indicates that the event has attendees.
anyOf
Name
Type
Required
Restrictions
Description
» anonymous
boolean
false
none
none
or
Name
Type
Required
Restrictions
Description
» anonymous
null
false
none
none
continued
Name
Type
Required
Restrictions
Description
has_notes
any
true
none
True if the device indicates that the event has notes.
anyOf
Name
Type
Required
Restrictions
Description
» anonymous
boolean
false
none
none
or
Name
Type
Required
Restrictions
Description
» anonymous
null
false
none
none
continued
Name
Type
Required
Restrictions
Description
has_recurrence_rules
any
true
none
True if the device indicates that the event recurs.
anyOf
Name
Type
Required
Restrictions
Description
» anonymous
boolean
false
none
none
or
Name
Type
Required
Restrictions
Description
» anonymous
null
false
none
none
continued
Name
Type
Required
Restrictions
Description
is_all_day
any
true
none
True if the event is all day.
anyOf
Name
Type
Required
Restrictions
Description
» anonymous
boolean
false
none
none
or
Name
Type
Required
Restrictions
Description
» anonymous
null
false
none
none
continued
Name
Type
Required
Restrictions
Description
is_detached
any
true
none
True if the event is 'detached' from a recurring event.
anyOf
Name
Type
Required
Restrictions
Description
» anonymous
boolean
false
none
none
or
Name
Type
Required
Restrictions
Description
» anonymous
null
false
none
none
continued
Name
Type
Required
Restrictions
Description
last_modified_date
any
true
none
The date/time when this event was last modified.
anyOf
Name
Type
Required
Restrictions
Description
» anonymous
string(date-time)
false
none
none
or
Name
Type
Required
Restrictions
Description
» anonymous
null
false
none
none
continued
Name
Type
Required
Restrictions
Description
location
any
true
none
The string description of the location of the event.
anyOf
Name
Type
Required
Restrictions
Description
» anonymous
string
false
none
none
or
Name
Type
Required
Restrictions
Description
» anonymous
null
false
none
none
continued
Name
Type
Required
Restrictions
Description
notes
any
true
none
The notes associated with the event.
anyOf
Name
Type
Required
Restrictions
Description
» anonymous
string
false
none
none
or
Name
Type
Required
Restrictions
Description
» anonymous
null
false
none
none
continued
Name
Type
Required
Restrictions
Description
occurrence_date
any
true
none
The date of this specific instance of a recurring event.
anyOf
Name
Type
Required
Restrictions
Description
» anonymous
string(date-time)
false
none
none
or
Name
Type
Required
Restrictions
Description
» anonymous
null
false
none
none
continued
Name
Type
Required
Restrictions
Description
organizer
any
true
none
The organizer of the event.
anyOf
Name
Type
Required
Restrictions
Description
» anonymous
string(uuid)
false
none
none
or
Name
Type
Required
Restrictions
Description
» anonymous
FulcraCalendarEventParticipant false
none
Represents an entity -- person, room, building, group, chatbot, etc. --
or
Name
Type
Required
Restrictions
Description
» anonymous
null
false
none
none
continued
Name
Type
Required
Restrictions
Description
participants
any
true
none
The participants of the event.
anyOf
Name
Type
Required
Restrictions
Description
» anonymous
[FulcraCalendarEventParticipant ]
false
none
[Represents an entity -- person, room, building, group, chatbot, etc. --
or
Name
Type
Required
Restrictions
Description
» anonymous
[string]
false
none
none
or
Name
Type
Required
Restrictions
Description
» anonymous
null
false
none
none
continued
Name
Type
Required
Restrictions
Description
recurrence_rules
any
true
none
The rules that describe the cadence of a recurring event.
anyOf
Name
Type
Required
Restrictions
Description
» anonymous
[FulcraCalendarRecurrenceRule ]
false
none
[A rule that describes the rule(s) underlying the frequency of a
or
Name
Type
Required
Restrictions
Description
» anonymous
null
false
none
none
continued
Name
Type
Required
Restrictions
Description
start_date
string(date-time)
true
none
the date/time when this event starts.
status
any
true
none
The device-platform-specific text that describes the status (e.g. 'cancelled', 'confirmed') of an event
anyOf
Name
Type
Required
Restrictions
Description
» anonymous
string
false
none
none
or
Name
Type
Required
Restrictions
Description
» anonymous
null
false
none
none
continued
Name
Type
Required
Restrictions
Description
time_zone
any
true
none
The text describing the time zone of the event.
anyOf
Name
Type
Required
Restrictions
Description
» anonymous
string
false
none
none
or
Name
Type
Required
Restrictions
Description
» anonymous
null
false
none
none
continued
Name
Type
Required
Restrictions
Description
title
any
true
none
The title of the event.
anyOf
Name
Type
Required
Restrictions
Description
» anonymous
string
false
none
none
or
Name
Type
Required
Restrictions
Description
» anonymous
null
false
none
none
continued
Name
Type
Required
Restrictions
Description
url
any
true
none
The URL of the calendar item associated with this event.
anyOf
Name
Type
Required
Restrictions
Description
» anonymous
string
false
none
none
or
Name
Type
Required
Restrictions
Description
» anonymous
null
false
none
none
FulcraCalendarEventParticipant
{
"contact_id" : "f245e2a3-e141-4d41-912c-b1c1f5bd5598" ,
"is_current_user" : true ,
"name" : "string" ,
"participant_role" : "string" ,
"participant_status" : "string" ,
"participant_type" : "string" ,
"url" : "string"
}
FulcraCalendarEventParticipant
Properties
Name
Type
Required
Restrictions
Description
contact_id
any
true
none
If this participant is known as a contact for this Fulcra user, this is the ID.
anyOf
Name
Type
Required
Restrictions
Description
» anonymous
string(uuid)
false
none
none
or
Name
Type
Required
Restrictions
Description
» anonymous
null
false
none
none
continued
Name
Type
Required
Restrictions
Description
is_current_user
any
true
none
True if the participant is the user of the device that sent the information about the event.
anyOf
Name
Type
Required
Restrictions
Description
» anonymous
boolean
false
none
none
or
Name
Type
Required
Restrictions
Description
» anonymous
null
false
none
none
continued
Name
Type
Required
Restrictions
Description
name
any
true
none
The name of the participant.
anyOf
Name
Type
Required
Restrictions
Description
» anonymous
string
false
none
none
or
Name
Type
Required
Restrictions
Description
» anonymous
null
false
none
none
continued
Name
Type
Required
Restrictions
Description
participant_role
any
true
none
Describes the participant's role in the event.
anyOf
Name
Type
Required
Restrictions
Description
» anonymous
string
false
none
none
or
Name
Type
Required
Restrictions
Description
» anonymous
null
false
none
none
continued
Name
Type
Required
Restrictions
Description
participant_status
any
true
none
Describes the participation status (e.g. 'attending') of the participant.
anyOf
Name
Type
Required
Restrictions
Description
» anonymous
string
false
none
none
or
Name
Type
Required
Restrictions
Description
» anonymous
null
false
none
none
continued
Name
Type
Required
Restrictions
Description
participant_type
any
true
none
Describes the type of participant (e.g. 'person', 'room').
anyOf
Name
Type
Required
Restrictions
Description
» anonymous
string
false
none
none
or
Name
Type
Required
Restrictions
Description
» anonymous
null
false
none
none
continued
Name
Type
Required
Restrictions
Description
url
any
true
none
A URL identifying this participant.
anyOf
Name
Type
Required
Restrictions
Description
» anonymous
string
false
none
none
or
Name
Type
Required
Restrictions
Description
» anonymous
null
false
none
none
FulcraCalendarRecurrenceRule
{
"calendar_id" : "c828ce68-4c5a-4491-b76a-af3d888d3f97" ,
"days_of_the_month" : [
null
],
"days_of_the_week" : [
null
],
"days_of_the_year" : [
null
],
"first_day_of_the_week" : 0 ,
"frequency" : "string" ,
"interval" : 0 ,
"months_of_the_year" : [
null
],
"recurrence_rule_id" : "ff66070e-89d9-4007-ac1d-92d2556a9349" ,
"set_positions" : [
null
],
"weeks_of_the_year" : [
null
]
}
FulcraCalendarRecurrenceRule
Properties
Name
Type
Required
Restrictions
Description
calendar_id
any
true
none
Calendar ID
anyOf
Name
Type
Required
Restrictions
Description
» anonymous
string(uuid)
false
none
none
or
Name
Type
Required
Restrictions
Description
» anonymous
null
false
none
none
continued
Name
Type
Required
Restrictions
Description
days_of_the_month
any
true
none
A list of the days of the month on which this event occurs.
anyOf
Name
Type
Required
Restrictions
Description
» anonymous
[any]
false
none
none
or
Name
Type
Required
Restrictions
Description
» anonymous
null
false
none
none
continued
Name
Type
Required
Restrictions
Description
days_of_the_week
any
true
none
A list of the days of the week on which this event occurs.
anyOf
Name
Type
Required
Restrictions
Description
» anonymous
[any]
false
none
none
or
Name
Type
Required
Restrictions
Description
» anonymous
null
false
none
none
continued
Name
Type
Required
Restrictions
Description
days_of_the_year
any
true
none
A list of the days of the year on which this event occurs.
anyOf
Name
Type
Required
Restrictions
Description
» anonymous
[any]
false
none
none
or
Name
Type
Required
Restrictions
Description
» anonymous
null
false
none
none
continued
Name
Type
Required
Restrictions
Description
first_day_of_the_week
any
true
none
A value indicating which day of the week is considered to be the beginning of the week. 1 is Sunday, 7 is Saturday.
anyOf
Name
Type
Required
Restrictions
Description
» anonymous
integer
false
none
none
or
Name
Type
Required
Restrictions
Description
» anonymous
null
false
none
none
continued
Name
Type
Required
Restrictions
Description
frequency
any
true
none
The description of the frequency for a recurring event (e.g. 'weekly')
anyOf
Name
Type
Required
Restrictions
Description
» anonymous
string
false
none
none
or
Name
Type
Required
Restrictions
Description
» anonymous
null
false
none
none
continued
Name
Type
Required
Restrictions
Description
interval
any
true
none
Using the value of frequency as the unit, the number of units that occur between events.
anyOf
Name
Type
Required
Restrictions
Description
» anonymous
integer
false
none
none
or
Name
Type
Required
Restrictions
Description
» anonymous
null
false
none
none
continued
Name
Type
Required
Restrictions
Description
months_of_the_year
any
true
none
A list of the months of the year on which this event occurs.
anyOf
Name
Type
Required
Restrictions
Description
» anonymous
[any]
false
none
none
or
Name
Type
Required
Restrictions
Description
» anonymous
null
false
none
none
continued
Name
Type
Required
Restrictions
Description
recurrence_rule_id
string(uuid)
true
none
Recurrence rule ID
set_positions
any
true
none
A list of numbers that indicate which recurrences are included in this rule's frequency.
anyOf
Name
Type
Required
Restrictions
Description
» anonymous
[any]
false
none
none
or
Name
Type
Required
Restrictions
Description
» anonymous
null
false
none
none
continued
Name
Type
Required
Restrictions
Description
weeks_of_the_year
any
true
none
A list of the weeks of the year on which this event occurs.
anyOf
Name
Type
Required
Restrictions
Description
» anonymous
[any]
false
none
none
or
Name
Type
Required
Restrictions
Description
» anonymous
null
false
none
none
FulcraCategory
FulcraCategory
Properties
Name
Type
Required
Restrictions
Description
FulcraCategory
string
false
none
fulcra data categories
Enumerated Values
Property
Value
FulcraCategory
annotations
FulcraCategory
sleep
FulcraCategory
healthkit
FulcraCategory
health
FulcraCategory
mindfulness
FulcraCategory
focus
FulcraCategory
fulcra
FulcraCategory
location
FulcraCategory
user_configured
FulcraCategory
base_type
{
"created_at" : "2019-08-24T14:15:22Z" ,
"default_event_tags" : [
"string"
],
"deleted" : true ,
"description" : "string" ,
"fulcra_data_type" : "string" ,
"fulcra_source" : [
"string"
],
"fulcra_userid" : "string" ,
"id" : "string" ,
"name" : "string" ,
"url" : "string"
}
Properties
Name
Type
Required
Restrictions
Description
created_at
string(date-time)
true
none
none
default_event_tags
array,null
false
none
none
deleted
boolean
true
none
none
description
string
false
none
none
fulcra_data_type
string
false
none
none
fulcra_source
array,null
false
none
none
fulcra_userid
string
true
none
none
id
string
true
none
none
name
string
true
none
none
url
string
true
none
none
FulcraDataSource
{
"id" : "497f6eca-6276-4993-bfeb-53cbbbba6f08" ,
"metadata" : {},
"name" : "string" ,
"parent_id" : "1c6ca187-e61f-4301-8dcb-0e9749e89eef" ,
"vendor_id" : "string"
}
FulcraDataSource
Properties
Name
Type
Required
Restrictions
Description
id
string(uuid)
true
none
Fulcra Data Source ID
metadata
any
false
none
Vendor-specific source metadata
anyOf
Name
Type
Required
Restrictions
Description
» anonymous
object
false
none
none
or
Name
Type
Required
Restrictions
Description
» anonymous
null
false
none
none
continued
Name
Type
Required
Restrictions
Description
name
any
false
none
Fulcra Data Source Name
anyOf
Name
Type
Required
Restrictions
Description
» anonymous
string
false
none
none
or
Name
Type
Required
Restrictions
Description
» anonymous
null
false
none
none
continued
Name
Type
Required
Restrictions
Description
parent_id
any
false
none
Parent Fulcra Data Source ID
anyOf
Name
Type
Required
Restrictions
Description
» anonymous
string(uuid)
false
none
none
or
Name
Type
Required
Restrictions
Description
» anonymous
null
false
none
none
continued
Name
Type
Required
Restrictions
Description
vendor_id
string
true
none
Vendor-specific source ID
FulcraEventRecord
{
"schema" : {},
"type" : "event"
}
FulcraEventRecord
Properties
Name
Type
Required
Restrictions
Description
schema
any
false
none
none
anyOf
Name
Type
Required
Restrictions
Description
» anonymous
object
false
none
none
or
Name
Type
Required
Restrictions
Description
» anonymous
null
false
none
none
continued
Name
Type
Required
Restrictions
Description
type
string
false
none
Record Type
FulcraFileUploadDataType
{
"data_type" : "string" ,
"state" : "string"
}
Properties
Name
Type
Required
Restrictions
Description
data_type
string
true
none
none
state
string
true
none
none
{
"archived_at" : "2019-08-24T14:15:22Z" ,
"created_at" : "2019-08-24T14:15:22Z" ,
"deleted_at" : "2019-08-24T14:15:22Z" ,
"fulcra_userid" : "string" ,
"id" : "string" ,
"last_scanned" : "2019-08-24T14:15:22Z" ,
"name" : "string" ,
"path" : "string" ,
"restored_from_id" : "string" ,
"scan_state" : "string" ,
"size" : 0 ,
"source_data_types" : [
{
"data_type" : "string" ,
"state" : "string"
}
],
"source_id" : "string" ,
"source_name" : "string" ,
"state" : "string" ,
"uploaded_at" : "2019-08-24T14:15:22Z"
}
Properties
Name
Type
Required
Restrictions
Description
archived_at
string,null(date-time)
true
none
none
created_at
string(date-time)
true
none
none
deleted_at
string,null(date-time)
true
none
none
fulcra_userid
string
true
none
none
id
string
true
none
none
last_scanned
string,null(date-time)
true
none
none
name
string
true
none
none
path
string
true
none
none
restored_from_id
string
true
none
none
scan_state
string
true
none
none
size
integer(int64)
true
none
none
source_data_types
array,null
true
none
none
source_id
string,null
true
none
none
source_name
string,null
true
none
none
state
string
true
none
none
uploaded_at
string,null(date-time)
true
none
none
FulcraLocationRecord
{
"schema" : {},
"type" : "location"
}
FulcraLocationRecord
Properties
Name
Type
Required
Restrictions
Description
schema
any
false
none
none
anyOf
Name
Type
Required
Restrictions
Description
» anonymous
object
false
none
none
or
Name
Type
Required
Restrictions
Description
» anonymous
null
false
none
none
continued
Name
Type
Required
Restrictions
Description
type
string
false
none
Record Type
FulcraMetricAggregation
FulcraMetricAggregation
Properties
Name
Type
Required
Restrictions
Description
FulcraMetricAggregation
string
false
none
fulcra metric aggregation
Enumerated Values
Property
Value
FulcraMetricAggregation
cumulative
FulcraMetricAggregation
discrete
FulcraMetricRecord
{
"aggregation" : "cumulative" ,
"scale" : {
"max" : 0 ,
"min" : 0 ,
"step" : 1
},
"schema" : {},
"type" : "metric" ,
"unit" : "mg" ,
"value_map" : {
"property1" : "string" ,
"property2" : "string"
}
}
FulcraMetricRecord
Properties
Name
Type
Required
Restrictions
Description
aggregation
FulcraMetricAggregation true
none
Metric aggregation
scale
any
false
none
Scale metric value should be measured on
anyOf
or
Name
Type
Required
Restrictions
Description
» anonymous
null
false
none
none
continued
Name
Type
Required
Restrictions
Description
schema
any
false
none
none
anyOf
Name
Type
Required
Restrictions
Description
» anonymous
object
false
none
none
or
Name
Type
Required
Restrictions
Description
» anonymous
null
false
none
none
continued
Name
Type
Required
Restrictions
Description
type
string
false
none
Record Type
unit
any
false
none
Unit of measurement
anyOf
Name
Type
Required
Restrictions
Description
» anonymous
string
false
none
none
or
Name
Type
Required
Restrictions
Description
» anonymous
null
false
none
none
continued
Name
Type
Required
Restrictions
Description
value_map
any
false
none
Map of metric values to human readable descriptors
anyOf
Name
Type
Required
Restrictions
Description
» anonymous
object
false
none
none
»» additionalProperties
string
false
none
none
or
Name
Type
Required
Restrictions
Description
» anonymous
null
false
none
none
FulcraMetricRecordScale
{
"max" : 0 ,
"min" : 0 ,
"step" : 1
}
FulcraMetricRecordScale
Properties
Name
Type
Required
Restrictions
Description
max
integer
true
none
Maximum value of the scale
min
integer
true
none
Minimum value of the scale
step
integer
false
none
Stepping
FulcraRecordType
FulcraRecordType
Properties
Name
Type
Required
Restrictions
Description
FulcraRecordType
string
false
none
Fulcra record types
Enumerated Values
Property
Value
FulcraRecordType
metric
FulcraRecordType
event
FulcraRecordType
location
FulcraRecordType
entry
FulcraRecordType
tombstone
FulcraReflection
{
"annotations" : [
"string"
],
"created_at" : "2019-08-24T14:15:22Z" ,
"data_types" : [
{
"name" : "string" ,
"resource_id" : "string"
}
],
"deleted_at" : "2019-08-24T14:15:22Z" ,
"description" : "string" ,
"fulcra_userid" : "string" ,
"id" : "string" ,
"name" : "string" ,
"parent_template_id" : "string" ,
"schedule" : {
"cron" : "string" ,
"end_at" : "string" ,
"paused" : true ,
"start_at" : "string" ,
"time_zone" : "string"
},
"updated_at" : "2019-08-24T14:15:22Z"
}
Properties
Name
Type
Required
Restrictions
Description
annotations
array,null
true
none
none
created_at
string(date-time)
true
none
none
data_types
array,null
true
none
none
deleted_at
string,null(date-time)
true
none
none
description
string
true
none
none
fulcra_userid
string
true
none
none
id
string
true
none
none
name
string
true
none
none
parent_template_id
string,null
true
none
none
schedule
FulcraReflectionSchedule true
none
none
updated_at
string(date-time)
true
none
none
FulcraReflectionDataType
{
"name" : "string" ,
"resource_id" : "string"
}
Properties
Name
Type
Required
Restrictions
Description
name
string
true
none
none
resource_id
string,null
false
none
none
FulcraReflectionSchedule
{
"cron" : "string" ,
"end_at" : "string" ,
"paused" : true ,
"start_at" : "string" ,
"time_zone" : "string"
}
Properties
Name
Type
Required
Restrictions
Description
cron
string
true
none
none
end_at
string,null
true
none
none
paused
boolean
true
none
none
start_at
string,null
true
none
none
time_zone
string
true
none
none
FulcraServiceStatus
{
"active_until" : "2019-08-24T14:15:22Z" ,
"grace_period_ends" : "2019-08-24T14:15:22Z" ,
"is_active" : true ,
"manage_url" : "string" ,
"service_type" : "subscribed_apple"
}
FulcraServiceStatus
Properties
Name
Type
Required
Restrictions
Description
active_until
string(date-time)
true
none
none
grace_period_ends
string(date-time)
true
none
none
is_active
boolean
true
none
none
manage_url
any
true
none
none
anyOf
Name
Type
Required
Restrictions
Description
» anonymous
string
false
none
none
or
Name
Type
Required
Restrictions
Description
» anonymous
null
false
none
none
continued
Name
Type
Required
Restrictions
Description
service_type
FulcraServiceType true
none
none
FulcraServiceType
FulcraServiceType
Properties
Name
Type
Required
Restrictions
Description
FulcraServiceType
string
false
none
none
Enumerated Values
Property
Value
FulcraServiceType
subscribed_apple
FulcraServiceType
subscribed_stripe
FulcraServiceType
free_service
FulcraServiceType
staff
FulcraServiceType
none
FulcraTag
{
"id" : "497f6eca-6276-4993-bfeb-53cbbbba6f08" ,
"name" : "string"
}
FulcraTag
Properties
Name
Type
Required
Restrictions
Description
id
string(uuid)
true
none
none
name
string
true
none
none
FulcraTombstoneRecord
{
"schema" : {},
"type" : "tombstone"
}
FulcraTombstoneRecord
Properties
Name
Type
Required
Restrictions
Description
schema
any
false
none
none
anyOf
Name
Type
Required
Restrictions
Description
» anonymous
object
false
none
none
or
Name
Type
Required
Restrictions
Description
» anonymous
null
false
none
none
continued
Name
Type
Required
Restrictions
Description
type
string
false
none
Record Type
FulcraUserDataAverages
{
"records_per_day" : 0 ,
"records_per_hour" : 0 ,
"records_per_month" : 0 ,
"records_per_week" : 0
}
FulcraUserDataAverages
Properties
Name
Type
Required
Restrictions
Description
records_per_day
integer
true
none
Records processed per day
records_per_hour
integer
true
none
Records processed per hour
records_per_month
integer
true
none
Records processed per month
records_per_week
integer
true
none
Records processed per week
FulcraUserDataTotals
{
"averages" : {
"records_per_day" : 0 ,
"records_per_hour" : 0 ,
"records_per_month" : 0 ,
"records_per_week" : 0
},
"total_days" : 0 ,
"total_devices" : 0 ,
"total_records" : 0 ,
"total_sources" : 0
}
FulcraUserDataTotals
Properties
Name
Type
Required
Restrictions
Description
averages
FulcraUserDataAverages true
none
Represents a user's processed data averages
total_days
integer
true
none
Total days of processed records
total_devices
integer
true
none
Total devices user has sent data from
total_records
integer
true
none
Total processed records
total_sources
integer
true
none
Total sources user has sent data from
FulcraUserPreferences
{
"calendar_events_data_track_filter_map" : {
"property1" : [
"string"
],
"property2" : [
"string"
]
},
"calendars" : [
"string"
],
"location_resolution" : {
"property1" : 0 ,
"property2" : 0
},
"periods_of_day" : {
"afternoon" : "12:00:00" ,
"end_of_day" : "21:00:00" ,
"evening" : "18:00:00" ,
"morning" : "08:00:00"
},
"pinned_metrics_count_map" : {
"property1" : 0 ,
"property2" : 0
},
"selected_calendar_vendor_ids" : [
"string"
],
"selected_metrics" : [
"string"
],
"selected_metrics_map" : {
"property1" : [
"string"
],
"property2" : [
"string"
]
},
"timezone" : "string"
}
FulcraUserPreferences
Properties
Name
Type
Required
Restrictions
Description
calendar_events_data_track_filter_map
any
false
none
none
anyOf
Name
Type
Required
Restrictions
Description
» anonymous
object
false
none
none
»» additionalProperties
[string]
false
none
none
or
Name
Type
Required
Restrictions
Description
» anonymous
null
false
none
none
continued
Name
Type
Required
Restrictions
Description
calendars
any
false
none
none
anyOf
Name
Type
Required
Restrictions
Description
» anonymous
[string]
false
none
none
or
Name
Type
Required
Restrictions
Description
» anonymous
null
false
none
none
continued
Name
Type
Required
Restrictions
Description
location_resolution
any
false
none
none
anyOf
Name
Type
Required
Restrictions
Description
» anonymous
object
false
none
none
»» additionalProperties
integer
false
none
none
or
Name
Type
Required
Restrictions
Description
» anonymous
null
false
none
none
continued
Name
Type
Required
Restrictions
Description
periods_of_day
any
false
none
User defined periods of the day
anyOf
Name
Type
Required
Restrictions
Description
» anonymous
PeriodsOfDay false
none
none
or
Name
Type
Required
Restrictions
Description
» anonymous
null
false
none
none
continued
Name
Type
Required
Restrictions
Description
pinned_metrics_count_map
any
false
none
none
anyOf
Name
Type
Required
Restrictions
Description
» anonymous
object
false
none
none
»» additionalProperties
integer
false
none
none
or
Name
Type
Required
Restrictions
Description
» anonymous
null
false
none
none
continued
Name
Type
Required
Restrictions
Description
selected_calendar_vendor_ids
any
false
none
none
anyOf
Name
Type
Required
Restrictions
Description
» anonymous
[string]
false
none
none
or
Name
Type
Required
Restrictions
Description
» anonymous
null
false
none
none
continued
Name
Type
Required
Restrictions
Description
selected_metrics
any
false
none
none
anyOf
Name
Type
Required
Restrictions
Description
» anonymous
[string]
false
none
none
or
Name
Type
Required
Restrictions
Description
» anonymous
null
false
none
none
continued
Name
Type
Required
Restrictions
Description
selected_metrics_map
any
false
none
none
anyOf
Name
Type
Required
Restrictions
Description
» anonymous
object
false
none
none
»» additionalProperties
[string]
false
none
none
or
Name
Type
Required
Restrictions
Description
» anonymous
null
false
none
none
continued
Name
Type
Required
Restrictions
Description
timezone
any
false
none
none
anyOf
Name
Type
Required
Restrictions
Description
» anonymous
string
false
none
none
or
Name
Type
Required
Restrictions
Description
» anonymous
null
false
none
none
GCSPubSubNotification
{
"message" : {
"attributes" : {
"bucketId" : "string" ,
"eventTime" : "2019-08-24T14:15:22Z" ,
"eventType" : "string" ,
"notificationConfig" : "string" ,
"objectGeneration" : "string" ,
"objectId" : "string" ,
"overwrittenByGeneration" : "string" ,
"overwroteGeneration" : "string" ,
"payloadFormat" : "string"
},
"data" : "string" ,
"messageId" : "string" ,
"publishTime" : "string"
},
"subscription" : "string"
}
Properties
GCSPubSubNotificationAttributes
{
"bucketId" : "string" ,
"eventTime" : "2019-08-24T14:15:22Z" ,
"eventType" : "string" ,
"notificationConfig" : "string" ,
"objectGeneration" : "string" ,
"objectId" : "string" ,
"overwrittenByGeneration" : "string" ,
"overwroteGeneration" : "string" ,
"payloadFormat" : "string"
}
Properties
Name
Type
Required
Restrictions
Description
bucketId
string
true
none
none
eventTime
string(date-time)
true
none
none
eventType
string
true
none
none
notificationConfig
string
true
none
none
objectGeneration
string
true
none
none
objectId
string
true
none
none
overwrittenByGeneration
string,null
false
none
none
overwroteGeneration
string,null
false
none
none
payloadFormat
string
true
none
none
GCSPubSubNotificationMessage
{
"attributes" : {
"bucketId" : "string" ,
"eventTime" : "2019-08-24T14:15:22Z" ,
"eventType" : "string" ,
"notificationConfig" : "string" ,
"objectGeneration" : "string" ,
"objectId" : "string" ,
"overwrittenByGeneration" : "string" ,
"overwroteGeneration" : "string" ,
"payloadFormat" : "string"
},
"data" : "string" ,
"messageId" : "string" ,
"publishTime" : "string"
}
Properties
Name
Type
Required
Restrictions
Description
attributes
GCSPubSubNotificationAttributes true
none
none
data
string
true
none
none
messageId
string
true
none
none
publishTime
string
true
none
none
GeofenceLocation
{
"altitude" : 0 ,
"ellipsoidal_altitude" : 0 ,
"floor" : 0 ,
"horizontal_accuracy" : 0 ,
"is_produced_by_accessory" : true ,
"is_simulated_by_software" : true ,
"latitude" : 0 ,
"location_timestamp" : "2019-08-24T14:15:22Z" ,
"longitude" : 0 ,
"radius" : 0 ,
"title" : "string" ,
"vertical_accuracy" : 0
}
GeofenceLocation
Properties
Name
Type
Required
Restrictions
Description
altitude
any
true
none
The altitude above sea level associated with the area (m)
anyOf
Name
Type
Required
Restrictions
Description
» anonymous
number
false
none
none
or
Name
Type
Required
Restrictions
Description
» anonymous
null
false
none
none
continued
Name
Type
Required
Restrictions
Description
ellipsoidal_altitude
any
true
none
The altitude as height above the WGS 84 ellipsoid (m)
anyOf
Name
Type
Required
Restrictions
Description
» anonymous
number
false
none
none
or
Name
Type
Required
Restrictions
Description
» anonymous
null
false
none
none
continued
Name
Type
Required
Restrictions
Description
floor
any
true
none
The floor of the building.Note: Reference points (e.g. 'first floor' may differ by locale.
anyOf
Name
Type
Required
Restrictions
Description
» anonymous
integer
false
none
none
or
Name
Type
Required
Restrictions
Description
» anonymous
null
false
none
none
continued
Name
Type
Required
Restrictions
Description
horizontal_accuracy
any
true
none
The horizontal accuracy for the location (m)
anyOf
Name
Type
Required
Restrictions
Description
» anonymous
number
false
none
none
or
Name
Type
Required
Restrictions
Description
» anonymous
null
false
none
none
continued
Name
Type
Required
Restrictions
Description
is_produced_by_accessory
any
true
none
True if the device that gathered this location received the value from an external accessory.
anyOf
Name
Type
Required
Restrictions
Description
» anonymous
boolean
false
none
none
or
Name
Type
Required
Restrictions
Description
» anonymous
null
false
none
none
continued
Name
Type
Required
Restrictions
Description
is_simulated_by_software
any
true
none
True if the device indicates that the location was simulated by software.
anyOf
Name
Type
Required
Restrictions
Description
» anonymous
boolean
false
none
none
or
Name
Type
Required
Restrictions
Description
» anonymous
null
false
none
none
continued
Name
Type
Required
Restrictions
Description
latitude
number
true
none
The latitude of the center of the area (deg)
location_timestamp
any
true
none
The time at which this location was calculated.
anyOf
Name
Type
Required
Restrictions
Description
» anonymous
string(date-time)
false
none
none
or
Name
Type
Required
Restrictions
Description
» anonymous
null
false
none
none
continued
Name
Type
Required
Restrictions
Description
longitude
number
true
none
The longitude of the center of the area (deg)
radius
any
true
none
The radius of the location area (m)
anyOf
Name
Type
Required
Restrictions
Description
» anonymous
number
false
none
none
or
Name
Type
Required
Restrictions
Description
» anonymous
null
false
none
none
continued
Name
Type
Required
Restrictions
Description
title
any
true
none
The geofence location's title.
anyOf
Name
Type
Required
Restrictions
Description
» anonymous
string
false
none
none
or
Name
Type
Required
Restrictions
Description
» anonymous
null
false
none
none
continued
Name
Type
Required
Restrictions
Description
vertical_accuracy
any
true
none
The vertical accuracy for the location (m)
anyOf
Name
Type
Required
Restrictions
Description
» anonymous
number
false
none
none
or
Name
Type
Required
Restrictions
Description
» anonymous
null
false
none
none
GrantServiceRequest
GrantServiceRequest
Properties
Name
Type
Required
Restrictions
Description
months
integer
true
none
none
HTTPValidationError
{
"detail" : [
{
"loc" : [
"string"
],
"msg" : "string" ,
"type" : "string"
}
]
}
HTTPValidationError
Properties
Name
Type
Required
Restrictions
Description
detail
[ValidationError ]
false
none
none
IdentifyFileUploadRequestPayload
{
"source_data_types" : [
{
"data_type" : "string" ,
"state" : "string"
}
],
"source_id" : "string" ,
"source_name" : "string"
}
Properties
Name
Type
Required
Restrictions
Description
source_data_types
array,null
true
none
none
source_id
string,null
true
none
none
source_name
string,null
true
none
none
InsightReportVersion
InsightReportVersion
Properties
Name
Type
Required
Restrictions
Description
InsightReportVersion
string
false
none
none
Enumerated Values
Property
Value
InsightReportVersion
v0
ListFileUploadResponseBody
{
"files" : [
{
"archived_at" : "2019-08-24T14:15:22Z" ,
"created_at" : "2019-08-24T14:15:22Z" ,
"deleted_at" : "2019-08-24T14:15:22Z" ,
"fulcra_userid" : "string" ,
"id" : "string" ,
"last_scanned" : "2019-08-24T14:15:22Z" ,
"name" : "string" ,
"path" : "string" ,
"restored_from_id" : "string" ,
"scan_state" : "string" ,
"size" : 0 ,
"source_data_types" : [
{
"data_type" : "string" ,
"state" : "string"
}
],
"source_id" : "string" ,
"source_name" : "string" ,
"state" : "string" ,
"uploaded_at" : "2019-08-24T14:15:22Z"
}
],
"folders" : [
"string"
]
}
Properties
Name
Type
Required
Restrictions
Description
files
array,null
true
none
none
folders
array,null
true
none
none
LocationSampleSource
LocationSampleSource
Properties
Name
Type
Required
Restrictions
Description
LocationSampleSource
string
false
none
Represents a source to retrieve location data from.
Enumerated Values
Property
Value
LocationSampleSource
ios
LocationSampleSource
google_maps
MassMeasurement
{
"mass" : {
"value" : 0
},
"measurement_type" : "mass" ,
"metric_kind" : "cumulative" ,
"unit" : "ounce" ,
"value_type" : "real"
}
MassMeasurement
Properties
Name
Type
Required
Restrictions
Description
mass
MassMeasurementSpec true
none
none
measurement_type
string
false
none
none
metric_kind
MetricKind false
none
How the measurement should be aggregated
unit
any
false
none
none
anyOf
Name
Type
Required
Restrictions
Description
» anonymous
MassUnit false
none
none
or
Name
Type
Required
Restrictions
Description
» anonymous
null
false
none
none
continued
Name
Type
Required
Restrictions
Description
value_type
string
false
none
none
MassMeasurementSpec
MassMeasurementSpec
Properties
Name
Type
Required
Restrictions
Description
value
any
false
none
Default value
anyOf
Name
Type
Required
Restrictions
Description
» anonymous
number
false
none
none
or
Name
Type
Required
Restrictions
Description
» anonymous
null
false
none
none
MassUnit
MassUnit
Properties
Name
Type
Required
Restrictions
Description
MassUnit
string
false
none
none
Enumerated Values
Property
Value
MassUnit
ounce
MassUnit
pound
MassUnit
microgram
MassUnit
milligram
MassUnit
gram
MassUnit
kilogram
MassUnit
stone
MetricKind
MetricKind
Properties
Name
Type
Required
Restrictions
Description
MetricKind
string
false
none
none
Enumerated Values
Property
Value
MetricKind
cumulative
MetricKind
discrete
Mode
Mode
Properties
Name
Type
Required
Restrictions
Description
Mode
string
false
none
none
Enumerated Values
Property
Value
Mode
start
Mode
end
Mode
split
MomentAnnotation
{
"annotation_type" : "moment" ,
"description" : "string" ,
"measurement_spec" : null ,
"name" : "string" ,
"spec" : {
"default_note" : "string"
},
"tags" : [
"497f6eca-6276-4993-bfeb-53cbbbba6f08"
]
}
MomentAnnotation
Properties
Name
Type
Required
Restrictions
Description
annotation_type
string
false
none
none
description
string
true
none
Description
measurement_spec
null
false
none
none
name
string
true
none
Name
spec
any
false
none
none
anyOf
or
Name
Type
Required
Restrictions
Description
» anonymous
null
false
none
none
continued
Name
Type
Required
Restrictions
Description
tags
[string]
true
none
Default tags
NumericAnnotation
{
"annotation_type" : "numeric" ,
"description" : "string" ,
"measurement_spec" : {
"count" : {
"value" : 0
},
"measurement_type" : "count" ,
"metric_kind" : "cumulative" ,
"unit" : null ,
"value_type" : "real"
},
"name" : "string" ,
"spec" : {
"default_note" : "string"
},
"tags" : [
"497f6eca-6276-4993-bfeb-53cbbbba6f08"
]
}
NumericAnnotation
Properties
Name
Type
Required
Restrictions
Description
annotation_type
string
false
none
none
description
string
true
none
Description
measurement_spec
any
true
none
none
oneOf
Name
Type
Required
Restrictions
Description
» anonymous
CountMeasurement false
none
Represents a count measurement configuration
xor
Name
Type
Required
Restrictions
Description
» anonymous
CustomMeasurement false
none
Represents a custom non-convertable measurement configuration
xor
Name
Type
Required
Restrictions
Description
» anonymous
DistanceMeasurement false
none
Represents a distance or length measurement configuration
xor
Name
Type
Required
Restrictions
Description
» anonymous
MassMeasurement false
none
Represents a mass measurement configuration and may be inferred from weight
xor
Name
Type
Required
Restrictions
Description
» anonymous
PercentMeasurement false
none
Represents a percentage measurement configuration
xor
Name
Type
Required
Restrictions
Description
» anonymous
PeriodMeasurement false
none
Represents a time period measurement configuration
xor
Name
Type
Required
Restrictions
Description
» anonymous
TemperatureMeasurement false
none
Represents a temperature measurement configuration
xor
Name
Type
Required
Restrictions
Description
» anonymous
VolumeMeasurement false
none
Represents a physical volume measurement configuration
continued
Name
Type
Required
Restrictions
Description
name
string
true
none
Name
spec
any
false
none
none
anyOf
or
Name
Type
Required
Restrictions
Description
» anonymous
null
false
none
none
continued
Name
Type
Required
Restrictions
Description
tags
[string]
true
none
Default tags
OutputMethod
OutputMethod
Properties
Name
Type
Required
Restrictions
Description
OutputMethod
string
false
none
none
Enumerated Values
Property
Value
OutputMethod
ndjson
OutputMethod
jstable
OutputMethod
jscolumns
OutputMethod
arrow
OutputMethod
arrowraw
OutputMethod
parquet
OutputMethod
csv
OutputMethod
quotecsv
PeopleAnnotation
{
"annotation_type" : "people" ,
"description" : "string" ,
"measurement_spec" : null ,
"name" : "string" ,
"spec" : null ,
"tags" : [
"497f6eca-6276-4993-bfeb-53cbbbba6f08"
]
}
PeopleAnnotation
Properties
Name
Type
Required
Restrictions
Description
annotation_type
string
false
none
none
description
string
true
none
Description
measurement_spec
null
false
none
none
name
string
true
none
Name
spec
null
false
none
none
tags
[string]
true
none
Default tags
PercentMeasurement
{
"measurement_type" : "percent" ,
"metric_kind" : "cumulative" ,
"percent" : {
"value" : 0
},
"unit" : "percent" ,
"value_type" : "real"
}
PercentMeasurement
Properties
Name
Type
Required
Restrictions
Description
measurement_type
string
false
none
none
metric_kind
MetricKind false
none
How the measurement should be aggregated
percent
PercentMeasurementSpec true
none
none
unit
string
false
none
none
value_type
string
false
none
none
PercentMeasurementSpec
PercentMeasurementSpec
Properties
Name
Type
Required
Restrictions
Description
value
any
false
none
Default value
anyOf
Name
Type
Required
Restrictions
Description
» anonymous
number
false
none
none
or
Name
Type
Required
Restrictions
Description
» anonymous
null
false
none
none
PeriodMeasurement
{
"measurement_type" : "period" ,
"metric_kind" : "cumulative" ,
"period" : {
"value" : 0
},
"unit" : "second" ,
"value_type" : "real"
}
PeriodMeasurement
Properties
Name
Type
Required
Restrictions
Description
measurement_type
string
false
none
none
metric_kind
MetricKind false
none
How the measurement should be aggregated
period
PeriodMeasurementSpec true
none
none
unit
any
false
none
none
anyOf
Name
Type
Required
Restrictions
Description
» anonymous
PeriodUnit false
none
none
or
Name
Type
Required
Restrictions
Description
» anonymous
null
false
none
none
continued
Name
Type
Required
Restrictions
Description
value_type
string
false
none
none
PeriodMeasurementSpec
PeriodMeasurementSpec
Properties
Name
Type
Required
Restrictions
Description
value
any
false
none
Default value
anyOf
Name
Type
Required
Restrictions
Description
» anonymous
number
false
none
none
or
Name
Type
Required
Restrictions
Description
» anonymous
null
false
none
none
PeriodUnit
PeriodUnit
Properties
Name
Type
Required
Restrictions
Description
PeriodUnit
string
false
none
none
Enumerated Values
Property
Value
PeriodUnit
second
PeriodsOfDay
{
"afternoon" : "string" ,
"end_of_day" : "string" ,
"evening" : "string" ,
"morning" : "string"
}
Properties
Name
Type
Required
Restrictions
Description
afternoon
string
true
none
none
end_of_day
string
true
none
none
evening
string
true
none
none
morning
string
true
none
none
RecentChangesResponseBody
{
"files" : [
{
"archived_at" : "2019-08-24T14:15:22Z" ,
"deleted_at" : "2019-08-24T14:15:22Z" ,
"full_name" : "string" ,
"id" : "string" ,
"last_scanned" : "2019-08-24T14:15:22Z" ,
"scan_state" : "string" ,
"size" : 0 ,
"state" : "string" ,
"uploaded_at" : "2019-08-24T14:15:22Z"
}
]
}
Properties
Name
Type
Required
Restrictions
Description
files
array,null
true
none
none
RecentFileChange
{
"archived_at" : "2019-08-24T14:15:22Z" ,
"deleted_at" : "2019-08-24T14:15:22Z" ,
"full_name" : "string" ,
"id" : "string" ,
"last_scanned" : "2019-08-24T14:15:22Z" ,
"scan_state" : "string" ,
"size" : 0 ,
"state" : "string" ,
"uploaded_at" : "2019-08-24T14:15:22Z"
}
Properties
Name
Type
Required
Restrictions
Description
archived_at
string,null(date-time)
true
none
none
deleted_at
string,null(date-time)
true
none
none
full_name
string
true
none
none
id
string
true
none
none
last_scanned
string,null(date-time)
true
none
none
scan_state
string
true
none
none
size
integer(int64)
true
none
none
state
string
true
none
none
uploaded_at
string,null(date-time)
true
none
none
RescheduleFulcraReflectionsRequest
{
"periods_of_day" : {
"afternoon" : "string" ,
"end_of_day" : "string" ,
"evening" : "string" ,
"morning" : "string"
},
"time_zone" : "string"
}
Properties
Name
Type
Required
Restrictions
Description
periods_of_day
PeriodsOfDay false
none
none
time_zone
string
false
none
none
ResponseFormat
Properties
Name
Type
Required
Restrictions
Description
ResponseFormat
string
false
none
none
Enumerated Values
Property
Value
ResponseFormat
json
ResponseFormat
csv
ScaleAnnotation
{
"annotation_type" : "scale" ,
"description" : "string" ,
"measurement_spec" : {
"measurement_type" : "scale" ,
"metric_kind" : "cumulative" ,
"scale" : {
"max_allowed" : 0 ,
"min_allowed" : 0 ,
"value" : 0
},
"unit" : null ,
"value_type" : "integer"
},
"name" : "string" ,
"spec" : {
"default_note" : "string" ,
"scale" : {
"label_mapping" : {
"mapping_type" : "string" ,
"string" : {
"mapping" : {
"property1" : "string" ,
"property2" : "string"
}
}
},
"scale_mapping" : {
"color" : {
"mapping" : {
"property1" : "string" ,
"property2" : "string"
}
},
"mapping_type" : "color"
}
}
},
"tags" : [
"497f6eca-6276-4993-bfeb-53cbbbba6f08"
]
}
ScaleAnnotation
Properties
Name
Type
Required
Restrictions
Description
annotation_type
string
false
none
none
description
string
true
none
Description
measurement_spec
ScaleMeasurement true
none
Represents a discrete scale measurement configuration with minimum and maximum values
name
string
true
none
Name
spec
ScaleAnnotationSpecContainer-Input true
none
none
tags
[string]
true
none
Default tags
{
"label_mapping" : {
"mapping_type" : "string" ,
"string" : {
"mapping" : {
"property1" : "string" ,
"property2" : "string"
}
}
},
"scale_mapping" : {
"color" : {
"mapping" : {
"property1" : "string" ,
"property2" : "string"
}
},
"mapping_type" : "color"
}
}
ScaleAnnotationSpec
Properties
Name
Type
Required
Restrictions
Description
label_mapping
StringScaleMapping true
none
Optional label for each scale value
scale_mapping
any
false
none
Display value mappoing for each scale value
anyOf - discriminator: mapping_type
Name
Type
Required
Restrictions
Description
» anonymous
any
false
none
none
oneOf
Name
Type
Required
Restrictions
Description
»» anonymous
ColorScaleMapping-Input false
none
Represents a scale mapping to colorrs
xor
Name
Type
Required
Restrictions
Description
»» anonymous
EmojiScaleMapping-Input false
none
Represents a scale mapping to colorrs
or
Name
Type
Required
Restrictions
Description
» anonymous
null
false
none
none
ScaleAnnotationSpec-Output
{
"label_mapping" : {
"mapping_type" : "string" ,
"string" : {
"mapping" : {
"property1" : "string" ,
"property2" : "string"
}
}
},
"scale_mapping" : {
"color" : {
"mapping" : {
"property1" : "string" ,
"property2" : "string"
}
},
"mapping_type" : "color"
}
}
ScaleAnnotationSpec
Properties
Name
Type
Required
Restrictions
Description
label_mapping
StringScaleMapping true
none
Optional label for each scale value
scale_mapping
any
false
none
Display value mappoing for each scale value
anyOf - discriminator: mapping_type
Name
Type
Required
Restrictions
Description
» anonymous
any
false
none
none
oneOf
Name
Type
Required
Restrictions
Description
»» anonymous
ColorScaleMapping-Output false
none
Represents a scale mapping to colorrs
xor
Name
Type
Required
Restrictions
Description
»» anonymous
EmojiScaleMapping-Output false
none
Represents a scale mapping to colorrs
or
Name
Type
Required
Restrictions
Description
» anonymous
null
false
none
none
{
"default_note" : "string" ,
"scale" : {
"label_mapping" : {
"mapping_type" : "string" ,
"string" : {
"mapping" : {
"property1" : "string" ,
"property2" : "string"
}
}
},
"scale_mapping" : {
"color" : {
"mapping" : {
"property1" : "string" ,
"property2" : "string"
}
},
"mapping_type" : "color"
}
}
}
ScaleAnnotationSpecContainer
Properties
Name
Type
Required
Restrictions
Description
default_note
any
false
none
Default note text, if any
anyOf
Name
Type
Required
Restrictions
Description
» anonymous
string
false
none
none
or
Name
Type
Required
Restrictions
Description
» anonymous
null
false
none
none
continued
ScaleAnnotationSpecContainer-Output
{
"default_note" : "string" ,
"scale" : {
"label_mapping" : {
"mapping_type" : "string" ,
"string" : {
"mapping" : {
"property1" : "string" ,
"property2" : "string"
}
}
},
"scale_mapping" : {
"color" : {
"mapping" : {
"property1" : "string" ,
"property2" : "string"
}
},
"mapping_type" : "color"
}
}
}
ScaleAnnotationSpecContainer
Properties
Name
Type
Required
Restrictions
Description
default_note
any
false
none
Default note text, if any
anyOf
Name
Type
Required
Restrictions
Description
» anonymous
string
false
none
none
or
Name
Type
Required
Restrictions
Description
» anonymous
null
false
none
none
continued
ScaleMeasurement
{
"measurement_type" : "scale" ,
"metric_kind" : "cumulative" ,
"scale" : {
"max_allowed" : 0 ,
"min_allowed" : 0 ,
"value" : 0
},
"unit" : null ,
"value_type" : "integer"
}
ScaleMeasurement
Properties
Name
Type
Required
Restrictions
Description
measurement_type
string
false
none
none
metric_kind
MetricKind false
none
How the measurement should be aggregated
scale
ScaleMeasurementSpec true
none
none
unit
null
false
none
none
value_type
string
false
none
none
ScaleMeasurementSpec
{
"max_allowed" : 0 ,
"min_allowed" : 0 ,
"value" : 0
}
ScaleMeasurementSpec
Properties
Name
Type
Required
Restrictions
Description
max_allowed
integer
true
none
Maxiumum value on scale
min_allowed
integer
true
none
Minimum value on scale
value
any
false
none
Default value
anyOf
Name
Type
Required
Restrictions
Description
» anonymous
integer
false
none
none
or
Name
Type
Required
Restrictions
Description
» anonymous
null
false
none
none
SortOrder
SortOrder
Properties
Name
Type
Required
Restrictions
Description
SortOrder
string
false
none
none
Enumerated Values
Property
Value
SortOrder
asc
SortOrder
desc
StringScaleMapping
{
"mapping_type" : "string" ,
"string" : {
"mapping" : {
"property1" : "string" ,
"property2" : "string"
}
}
}
StringScaleMapping
Properties
Name
Type
Required
Restrictions
Description
mapping_type
string
false
none
none
string
StringScaleMappingSpec true
none
none
StringScaleMappingSpec
{
"mapping" : {
"property1" : "string" ,
"property2" : "string"
}
}
StringScaleMappingSpec
Properties
Name
Type
Required
Restrictions
Description
mapping
object
true
none
Mapping of scale values to strings
» additionalProperties
string
false
none
none
TemperatureMeasurement
{
"measurement_type" : "temperature" ,
"metric_kind" : "cumulative" ,
"temperature" : {
"value" : 0
},
"unit" : "degree_celsius" ,
"value_type" : "real"
}
TemperatureMeasurement
Properties
Name
Type
Required
Restrictions
Description
measurement_type
string
false
none
none
metric_kind
MetricKind false
none
How the measurement should be aggregated
temperature
TemperatureMeasurementSpec true
none
none
unit
any
false
none
none
anyOf
Name
Type
Required
Restrictions
Description
» anonymous
TemperatureUnit false
none
none
or
Name
Type
Required
Restrictions
Description
» anonymous
null
false
none
none
continued
Name
Type
Required
Restrictions
Description
value_type
string
false
none
none
TemperatureMeasurementSpec
TemperatureMeasurementSpec
Properties
Name
Type
Required
Restrictions
Description
value
any
false
none
Default value
anyOf
Name
Type
Required
Restrictions
Description
» anonymous
number
false
none
none
or
Name
Type
Required
Restrictions
Description
» anonymous
null
false
none
none
TemperatureUnit
TemperatureUnit
Properties
Name
Type
Required
Restrictions
Description
TemperatureUnit
string
false
none
none
Enumerated Values
Property
Value
TemperatureUnit
degree_celsius
TemperatureUnit
degree_fahrenheit
TimeSeriesCalculation
TimeSeriesCalculation
Properties
Name
Type
Required
Restrictions
Description
TimeSeriesCalculation
string
false
none
The descriptive statistics calculations that are available on certain
Enumerated Values
Property
Value
TimeSeriesCalculation
max
TimeSeriesCalculation
min
TimeSeriesCalculation
delta
TimeSeriesCalculation
mean
TimeSeriesCalculation
uniques
TimeSeriesCalculation
allpoints
TimeSeriesCalculation
rollingmean
TimeSeriesCalculation
mode
TimeZone
TimeZone
Properties
Name
Type
Required
Restrictions
Description
TimeZone
string
false
none
none
TimeZone accepts one of 599 values (e.g. Atlantic/Stanley). See the full list in the OpenAPI specification .
UpdateFileUploadDataTypePayload
Properties
Name
Type
Required
Restrictions
Description
state
string
true
none
none
{
"default_event_tags" : [
"string"
],
"description" : "string" ,
"fulcra_data_type" : "string" ,
"fulcra_source" : [
"string"
],
"name" : "string"
}
Properties
Name
Type
Required
Restrictions
Description
default_event_tags
array,null
false
none
none
description
string,null
false
none
none
fulcra_data_type
string,null
false
none
none
fulcra_source
array,null
false
none
none
name
string
false
none
none
UpdateFulcraReflectionRequest
{
"annotations" : [
"string"
],
"data_types" : [
{
"name" : "string" ,
"resource_id" : "string"
}
],
"description" : "string" ,
"name" : "string" ,
"parent_template_id" : "string" ,
"schedule" : {
"cron" : "string" ,
"end_at" : "string" ,
"paused" : true ,
"start_at" : "string" ,
"time_zone" : "string"
}
}
Properties
Name
Type
Required
Restrictions
Description
annotations
array,null
false
none
none
data_types
array,null
false
none
none
description
string
false
none
none
name
string
false
none
none
parent_template_id
string
false
none
none
schedule
FulcraReflectionSchedule false
none
none
UploadResponse
{
"upload_id" : "f2ef591b-135b-46fa-a604-3d4fda5bfbfb"
}
UploadResponse
Properties
Name
Type
Required
Restrictions
Description
upload_id
string(uuid)
true
none
none
V0UploadDataRequest
{
"data" : "string" ,
"metadata" : {}
}
V0UploadDataRequest
Properties
Name
Type
Required
Restrictions
Description
data
string
true
none
none
metadata
any
false
none
none
anyOf
Name
Type
Required
Restrictions
Description
» anonymous
object
false
none
none
or
Name
Type
Required
Restrictions
Description
» anonymous
null
false
none
none
V1Alpha1FulcraAPISessionTokenReq
{
"policy_id" : "string" ,
"session_name" : "string" ,
"state" : "string"
}
V1Alpha1FulcraAPISessionTokenReq
Properties
Name
Type
Required
Restrictions
Description
policy_id
any
false
none
none
anyOf
Name
Type
Required
Restrictions
Description
» anonymous
string
false
none
none
or
Name
Type
Required
Restrictions
Description
» anonymous
null
false
none
none
continued
Name
Type
Required
Restrictions
Description
session_name
string
true
none
none
state
string
true
none
none
V1Alpha1FulcraAPISessionTokenResponse
V1Alpha1FulcraAPISessionTokenResponse
Properties
Name
Type
Required
Restrictions
Description
token
string
true
none
none
V1Alpha1UserResponse
{
"created" : "2019-08-24T14:15:22Z" ,
"intercom_token" : "string" ,
"preferences" : {
"calendar_events_data_track_filter_map" : {
"property1" : [
"string"
],
"property2" : [
"string"
]
},
"calendars" : [
"string"
],
"location_resolution" : {
"property1" : 0 ,
"property2" : 0
},
"periods_of_day" : {
"afternoon" : "12:00:00" ,
"end_of_day" : "21:00:00" ,
"evening" : "18:00:00" ,
"morning" : "08:00:00"
},
"pinned_metrics_count_map" : {
"property1" : 0 ,
"property2" : 0
},
"selected_calendar_vendor_ids" : [
"string"
],
"selected_metrics" : [
"string"
],
"selected_metrics_map" : {
"property1" : [
"string"
],
"property2" : [
"string"
]
},
"timezone" : "string"
},
"service_status" : {
"active_until" : "2019-08-24T14:15:22Z" ,
"grace_period_ends" : "2019-08-24T14:15:22Z" ,
"is_active" : true ,
"manage_url" : "string" ,
"service_type" : "subscribed_apple"
},
"status" : "string" ,
"tier" : "string" ,
"userid" : "4c3716c4-7217-4d1b-b0ed-f18a56ef1093"
}
V1Alpha1UserResponse
Properties
Name
Type
Required
Restrictions
Description
created
string(date-time)
true
none
none
intercom_token
any
false
none
none
anyOf
Name
Type
Required
Restrictions
Description
» anonymous
string
false
none
none
or
Name
Type
Required
Restrictions
Description
» anonymous
null
false
none
none
continued
Name
Type
Required
Restrictions
Description
preferences
FulcraUserPreferences true
none
A Fulcra user's preferences
service_status
FulcraServiceStatus true
none
The service status (i.e. subscription status) for a user.
status
string
true
none
none
tier
string
true
none
none
userid
string(uuid)
true
none
none
ValidationError
{
"loc" : [
"string"
],
"msg" : "string" ,
"type" : "string"
}
ValidationError
Properties
Name
Type
Required
Restrictions
Description
loc
[anyOf]
true
none
none
anyOf
Name
Type
Required
Restrictions
Description
» anonymous
string
false
none
none
or
Name
Type
Required
Restrictions
Description
» anonymous
integer
false
none
none
continued
Name
Type
Required
Restrictions
Description
msg
string
true
none
none
type
string
true
none
none
VolumeMeasurement
{
"measurement_type" : "volume" ,
"metric_kind" : "cumulative" ,
"unit" : "teaspoon" ,
"value_type" : "real" ,
"volume" : {
"value" : 0
}
}
VolumeMeasurement
Properties
Name
Type
Required
Restrictions
Description
measurement_type
string
false
none
none
metric_kind
MetricKind false
none
How the measurement should be aggregated
unit
any
false
none
none
anyOf
Name
Type
Required
Restrictions
Description
» anonymous
VolumeUnit false
none
none
or
Name
Type
Required
Restrictions
Description
» anonymous
null
false
none
none
continued
Name
Type
Required
Restrictions
Description
value_type
string
false
none
none
volume
VolumeMeasurementSpec true
none
none
VolumeMeasurementSpec
VolumeMeasurementSpec
Properties
Name
Type
Required
Restrictions
Description
value
any
false
none
Default value
anyOf
Name
Type
Required
Restrictions
Description
» anonymous
number
false
none
none
or
Name
Type
Required
Restrictions
Description
» anonymous
null
false
none
none
VolumeUnit
VolumeUnit
Properties
Name
Type
Required
Restrictions
Description
VolumeUnit
string
false
none
none
Enumerated Values
Property
Value
VolumeUnit
teaspoon
VolumeUnit
tablespoon
VolumeUnit
fluid_ounce
VolumeUnit
pint
VolumeUnit
quart
VolumeUnit
gallon
VolumeUnit
millileter
VolumeUnit
liter
dataservice__v1alpha1__datatypes__FulcraDataType
{
"category" : [
"string"
],
"class" : "string" ,
"description" : "string" ,
"name" : "string"
}
FulcraDataType
Properties
Name
Type
Required
Restrictions
Description
category
[string]
true
none
Category of data (health, location, calendar, etc)
class
any
true
read-only
Class of data (metric, event, etc)
anyOf
Name
Type
Required
Restrictions
Description
» anonymous
string
false
none
none
or
Name
Type
Required
Restrictions
Description
» anonymous
null
false
none
none
continued
Name
Type
Required
Restrictions
Description
description
string
true
none
Description of the Fulcra Data Type
name
string
true
none
Name of the Fulcra Data Type
fulcradatatypes__models__FulcraDataType
{
"api_version" : "v0" ,
"categories" : [
"annotations"
],
"class" : "metric" ,
"column_name" : "string" ,
"deprecated" : false ,
"description" : "string" ,
"icon" : "string" ,
"id" : "string" ,
"metric_kind" : "cumulative" ,
"name" : "string" ,
"queryable" : true ,
"record_spec" : {
"schema" : {},
"type" : "event"
},
"recordable" : true ,
"unit" : "string"
}
FulcraDataType
Properties
Name
Type
Required
Restrictions
Description
api_version
FulcraAPIVersion true
none
Fulcra API version
categories
[FulcraCategory ]
true
none
Categories this data type belongs to
class
FulcraRecordType true
none
Fulcra record types
column_name
string
true
none
Name of data column as returned by Fulcra APIs
deprecated
boolean
false
none
Whether this type is deprecated
description
string
true
none
Human-readable description
icon
any
false
none
Icon identifier
anyOf
Name
Type
Required
Restrictions
Description
» anonymous
string
false
none
none
or
Name
Type
Required
Restrictions
Description
» anonymous
null
false
none
none
continued
Name
Type
Required
Restrictions
Description
id
string
true
none
Programmatic Identifier
metric_kind
any
true
read-only
none
anyOf
Name
Type
Required
Restrictions
Description
» anonymous
FulcraMetricAggregation false
none
fulcra metric aggregation
or
Name
Type
Required
Restrictions
Description
» anonymous
null
false
none
none
continued
Name
Type
Required
Restrictions
Description
name
string
true
none
Human-readable name
queryable
boolean
false
none
Denotes if this type can be queried
record_spec
any
true
none
Metadata about the data that is recorded and queried
oneOf
Name
Type
Required
Restrictions
Description
» anonymous
FulcraEventRecord false
none
spec metadata for a fulcra event record
xor
Name
Type
Required
Restrictions
Description
» anonymous
FulcraMetricRecord false
none
represents the type or 'shape' of a record for a fulcra data type
xor
Name
Type
Required
Restrictions
Description
» anonymous
FulcraLocationRecord false
none
spec metadata for a fulcra location record
xor
Name
Type
Required
Restrictions
Description
» anonymous
FulcraTombstoneRecord false
none
spec metadata for a fulcra tombstone (aka deleted record)
continued
Name
Type
Required
Restrictions
Description
recordable
boolean
false
none
Denotes if this type can be recorded
unit
any
true
read-only
none
anyOf
Name
Type
Required
Restrictions
Description
» anonymous
string
false
none
none
or
Name
Type
Required
Restrictions
Description
» anonymous
null
false
none
none