Get-MicrosoftHealthSummary

NAME Get-MicrosoftHealthSummary



SYNOPSIS

Gets summarized data





SYNTAX

Get-MicrosoftHealthSummary [-Period] <String> [-StartTime <String>] [-EndTime <String>] [-maxPageSize <Int32>]

[-InformationAction <ActionPreference>] [-InformationVariable <String>] [<CommonParameters>]





DESCRIPTION

Provides a sum-up of user data on an hourly or daily basis.

This data is divided into several sub-groups:

- Steps The total number of steps taken in the time period

- Calories Burned The total calories burned in the time period

- Heart Rate The average, peak, and lowest heart rate in the time period

- Distance





PARAMETERS

-Period <String>





Required? true

Position? 0

Default value

Accept pipeline input? false

Accept wildcard characters? false



-StartTime <String>





Required? false

Position? named

Default value

Accept pipeline input? false

Accept wildcard characters? false



-EndTime <String>





Required? false

Position? named

Default value

Accept pipeline input? false

Accept wildcard characters? false



-maxPageSize <Int32>





Required? false

Position? named

Default value 0

Accept pipeline input? false

Accept wildcard characters? false



-InformationAction <ActionPreference>





Required? false

Position? named

Default value

Accept pipeline input? false

Accept wildcard characters? false



-InformationVariable <String>





Required? false

Position? named

Default value

Accept pipeline input? false

Accept wildcard characters? false



<CommonParameters>

This cmdlet supports the common parameters: Verbose, Debug,

ErrorAction, ErrorVariable, WarningAction, WarningVariable,

OutBuffer, PipelineVariable, and OutVariable. For more information, see

about_CommonParameters (https:/go.microsoft.com/fwlink/?LinkID=113216).



INPUTS









OUTPUTS

System.Management.Automation.PSCustomObject







NOTES









-------------------------- EXAMPLE 1 --------------------------



Get-MicrosoftHealthSummary -Period Daily



Gets a summary of Daily data on a Daily basis







userId : a123rr67-9c56-419e-95a4-b5a71f775abc

startTime : 2015-12-30T00:00:00.000+00:00

endTime : 2015-12-31T00:00:00.000+00:00

parentDay : 2015-12-30T00:00:00.000+00:00

isTransitDay : False

period : Daily

duration : P1D

stepsTaken : 9716

caloriesBurnedSummary : @{period=Daily; totalCalories=1860}

heartRateSummary : @{period=Daily; averageHeartRate=72; peakHeartRate=97; lowestHeartRate=53}

distanceSummary : @{period=Daily; totalDistance=763162; totalDistanceOnFoot=763162}



-------------------------- EXAMPLE 2 --------------------------



Get-MicrosoftHealthSummary -Period Hourly



Gets a summary of Daily data on a Hourly basis







userId : a123rr67-9c56-419e-95a4-b5a71f775abc

startTime : 2015-12-31T14:00:00.000+00:00

endTime : 2015-12-31T15:00:00.000+00:00

parentDay : 2015-12-31T00:00:00.000+00:00

isTransitDay : False

period : Hourly

duration : PT1H

stepsTaken : 0

caloriesBurnedSummary : @{period=Hourly}

heartRateSummary : @{period=Hourly}

distanceSummary : @{period=Hourly}



-------------------------- EXAMPLE 3 --------------------------



Get-MicrosoftHealthSummary -Period Hourly -StartTime 10-01-2015 -EndTime 10-10-2015 -maxPageSize 1



Gets a summary overview of the Hourly data from 1st of October 2015 till 10th of October 2015 with page size of 1









RELATED LINKS

Microsoft Health Cloud API V1 http://developer.microsoftband.com/clou ... maries_Get