Device Geolocation History

Generated Cmdlet Help

This page has been generated from the NinjaOne PowerShell module source. To make changes please edit the appropriate PowerShell source file.

SYNOPSIS

Gets geolocation history for a mobile device.

SYNTAX

Get-NinjaOneDeviceGeolocationHistory [-deviceId] <Int32> [-after <Double>] [-before <Double>]
 [-pageSize <Int32>] [-cursor <String>] [-ProgressAction <ActionPreference>] [<CommonParameters>]

DESCRIPTION

Retrieves one page of mobile device geolocation history. The API defaults to the last seven days and the time window cannot exceed seven days. Use the returned cursor to retrieve subsequent pages.

EXAMPLES

EXAMPLE 1

Get-NinjaOneDeviceGeolocationHistory -deviceId 1 -pageSize 100

Gets the first page of geolocation history for device 1.

EXAMPLE 2

Get-NinjaOneDeviceGeolocationHistory -deviceId 1 -after 1791244800 -before 1791849600 -cursor 'next-page'

Gets a subsequent page within the specified epoch-second time window.

PARAMETERS

-deviceId

The mobile device id.

Type: Int32
Parameter Sets: (All)
Aliases: id

Required: True
Position: 1
Default value: 0
Accept pipeline input: True (ByPropertyName, ByValue)
Accept wildcard characters: False

-after

Include records on or after this timestamp in epoch seconds.

Type: Double
Parameter Sets: (All)
Aliases:

Required: False
Position: Named
Default value: 0
Accept pipeline input: False
Accept wildcard characters: False

-before

Include records on or before this timestamp in epoch seconds.

Type: Double
Parameter Sets: (All)
Aliases:

Required: False
Position: Named
Default value: 0
Accept pipeline input: False
Accept wildcard characters: False

-pageSize

Limit the number of records per page. The API default is 100.

Type: Int32
Parameter Sets: (All)
Aliases:

Required: False
Position: Named
Default value: 0
Accept pipeline input: False
Accept wildcard characters: False

-cursor

Cursor returned by the previous page.

Type: String
Parameter Sets: (All)
Aliases:

Required: False
Position: Named
Default value: None
Accept pipeline input: False
Accept wildcard characters: False

CommonParameters

This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters.

INPUTS

OUTPUTS

A PowerShell object containing geolocation history and pagination information.

NOTES

RELATED LINKS

https://docs.homotechsual.dev/modules/ninjaone/commandlets/Get/devicegeolocationhistory