Get-StarrProwlarrIndexerStatistic
SYNOPSIS
Retrieves Prowlarr indexer statistics results.
SYNTAX
Named (Default)
Get-StarrProwlarrIndexerStatistic [-InstanceName <string>] [-StartDate <datetime>]
[-EndDate <datetime>] [-IndexerIdFilter <int[]>] [-Protocol <string[]>] [-Tag <string[]>]
Explicit
Get-StarrProwlarrIndexerStatistic -Url <string> -ApiKey <string> [-StartDate <datetime>]
[-EndDate <datetime>] [-IndexerIdFilter <int[]>] [-Protocol <string[]>] [-Tag <string[]>]
DESCRIPTION
This function retrieves Prowlarr indexer statistics without changing settings. An unbounded date range can require a large statistics query.
EXAMPLES
EXAMPLE 1
Get-StarrProwlarrIndexerStatistic -InstanceName 'Main' -IndexerIdFilter 1,2 -Protocol Torrent -Tag movies
EXAMPLE 2
PARAMETERS
-ApiKey
The API key used to authenticate with Prowlarr.
Type: System.String
DefaultValue: ''
SupportsWildcards: false
Aliases: []
ParameterSets:
- Name: Explicit
Position: Named
IsRequired: true
ValueFromPipeline: false
ValueFromPipelineByPropertyName: false
ValueFromRemainingArguments: false
DontShow: false
AcceptedValues: []
HelpMessage: ''
-EndDate
The end of the statistics interval; omitted values use the server default.
Type: System.DateTime
DefaultValue: ''
SupportsWildcards: false
Aliases: []
ParameterSets:
- Name: (All)
Position: Named
IsRequired: false
ValueFromPipeline: false
ValueFromPipelineByPropertyName: false
ValueFromRemainingArguments: false
DontShow: false
AcceptedValues: []
HelpMessage: ''
-IndexerIdFilter
The indexer identifiers to include.
Type: System.Int32[]
DefaultValue: ''
SupportsWildcards: false
Aliases: []
ParameterSets:
- Name: (All)
Position: Named
IsRequired: false
ValueFromPipeline: false
ValueFromPipelineByPropertyName: false
ValueFromRemainingArguments: false
DontShow: false
AcceptedValues: []
HelpMessage: ''
-InstanceName
The saved Prowlarr instance name. When omitted, the only matching instance is used.
Type: System.String
DefaultValue: ''
SupportsWildcards: false
Aliases:
- Name
ParameterSets:
- Name: Named
Position: Named
IsRequired: false
ValueFromPipeline: false
ValueFromPipelineByPropertyName: false
ValueFromRemainingArguments: false
DontShow: false
AcceptedValues: []
HelpMessage: ''
-Protocol
The download protocols to include.
Type: System.String[]
DefaultValue: ''
SupportsWildcards: false
Aliases: []
ParameterSets:
- Name: (All)
Position: Named
IsRequired: false
ValueFromPipeline: false
ValueFromPipelineByPropertyName: false
ValueFromRemainingArguments: false
DontShow: false
AcceptedValues: []
HelpMessage: ''
-StartDate
The beginning of the statistics interval; omitted values use the server default.
Type: System.DateTime
DefaultValue: ''
SupportsWildcards: false
Aliases: []
ParameterSets:
- Name: (All)
Position: Named
IsRequired: false
ValueFromPipeline: false
ValueFromPipelineByPropertyName: false
ValueFromRemainingArguments: false
DontShow: false
AcceptedValues: []
HelpMessage: ''
-Tag
Existing tag labels or numeric tag identifiers to include. Commas within a tag are not accepted.
Type: System.String[]
DefaultValue: ''
SupportsWildcards: false
Aliases: []
ParameterSets:
- Name: (All)
Position: Named
IsRequired: false
ValueFromPipeline: false
ValueFromPipelineByPropertyName: false
ValueFromRemainingArguments: false
DontShow: false
AcceptedValues: []
HelpMessage: ''
-Url
The absolute base URL of the Prowlarr instance.
Type: System.String
DefaultValue: ''
SupportsWildcards: false
Aliases: []
ParameterSets:
- Name: Explicit
Position: Named
IsRequired: true
ValueFromPipeline: false
ValueFromPipelineByPropertyName: false
ValueFromRemainingArguments: false
DontShow: false
AcceptedValues: []
HelpMessage: ''
CommonParameters
This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutBuffer, -OutVariable, -PipelineVariable, -ProgressAction, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters.
INPUTS
None.
You cannot pipe objects to this function.
OUTPUTS
PSStarr.Prowlarr.IndexerStatistic
This function returns deserialized Prowlarr response objects.
NOTES
RELATED LINKS
https://psstarr.xyz/command-reference/commands/Get-StarrProwlarrIndexerStatistic/