Get-ITGlueUserMetric

SYNOPSIS

Lists all user metrics

SYNTAX

Get-ITGlueUserMetric [-FilterUserID <Int64>] [-FilterOrganizationID <Int64>] [-FilterResourceType <String>]
 [-FilterDate <String>] [-Sort <String>] [-PageNumber <Int64>] [-PageSize <Int32>] [-AllResults]
 [<CommonParameters>]

DESCRIPTION

The Get-ITGlueUserMetric cmdlet lists all user metrics

EXAMPLES

EXAMPLE 1

Get-ITGlueUserMetric

Returns the first 50 user metric results from your ITGlue account

EXAMPLE 2

Get-ITGlueUserMetric -FilterUserID 12345

Returns the user metric for the user with the defined id

EXAMPLE 3

Get-ITGlueUserMetric -PageNumber 2 -PageSize 10

Returns the first 10 results from the second page for user metrics in your ITGlue account

PARAMETERS

-FilterUserID

Filter by user id

Type: Int64
Parameter Sets: (All)
Aliases: filter_user_id

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

-FilterOrganizationID

Filter for users metrics by organization id

Type: Int64
Parameter Sets: (All)
Aliases: filter_organization_id

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

-FilterResourceType

Filter for user metrics by resource type

Example: ‘Configurations’,’Passwords’,’Active Directory’

Type: String
Parameter Sets: (All)
Aliases: filter_resource_type

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

-FilterDate

Filter for users metrics by a date range

The dates are UTC

The specified string must be a date range and comma-separated start_date, end_date

Use * for unspecified start_date or end_date

Date ranges longer than a week may be disallowed for performance reasons

Type: String
Parameter Sets: (All)
Aliases: filter_date

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

-Sort

Sort results by a defined value

Allowed values: ‘id’, ‘created’, ‘viewed’, ‘edited’, ‘deleted’, ‘date’, ‘-id’, ‘-created’, ‘-viewed’, ‘-edited’, ‘-deleted’, ‘-date’

Type: String
Parameter Sets: (All)
Aliases:

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

-PageNumber

Return results starting from the defined number

Type: Int64
Parameter Sets: (All)
Aliases: page_number

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

-PageSize

Number of results to return per page

The maximum number of page results that can be requested is 1000

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

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

-AllResults

Returns all items from an endpoint

This can be used in unison with -PageSize to limit the number of sequential requests to the API

Type: SwitchParameter
Parameter Sets: (All)
Aliases:

Required: False
Position: Named
Default value: False
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

NOTES

N/A

RELATED LINKS

https://celerium.github.io/ITGlue-PowerShellWrapper/site/UserMetrics/Get-ITGlueUserMetric.html

https://api.itglue.com/developer/#accounts-user-metrics-daily-index