Read Statistics

This method allows reading the statistics of bpm data.

Request:

namevalue

url

https://dev.pulsoid.net/api/v1/statistics

method

GET

scope

data:statistics:read

Query Parameters explained:

nametypepossible valuesdefaultdescription

time_range

string

24h, 7d,30d

24h

Time range

Headers Parameters explained:

namevaluedescription

Authorization

Bearer {auth token}

Response:

nametypedescription

maximum_beats_per_minute

number

Maximum beats per minute for the provided time range

minimum_beats_per_minute

number

Minimum beats per minute for the provided time range

average_beats_per_minute

number

Average beats per minute for the provided time range

streamed_duration_in_seconds

number

Duration in seconds while heart rate was streamed

calories_burned_in_kcal

number

Estimated calories burned for the provided time range

Specific Errors:

http status codereason

400

no_supported_time_range_24h_7d_30d

cURL Request Example:

curl --request GET \
  --url 'https://dev.pulsoid.net/api/v1/statistics?time_range=7d' \
  --header 'Authorization: Bearer 8c4da3ce-7ed7-4a19-a1f1-058498661e45'

Response Example

{
	"maximum_beats_per_minute": 139,
	"minimum_beats_per_minute": 60,
	"average_beats_per_minute": 79,
	"streamed_duration_in_seconds": 23019,
	"calories_burned_in_kcal": 1072
}

Last updated