Public/Metrics/Get-PiHoleStatsTopDomain.ps1
|
function Get-PiHoleStatsTopDomain { <# .SYNOPSIS Get top domains Request the top domains (by query count) .PARAMETER PiHoleServer The URL to the PiHole Server, for example "http://pihole.domain.com:8080", or "http://192.168.1.100" .PARAMETER Password The API Password you generated from your PiHole server .PARAMETER MaxResult How many results should be returned .PARAMETER Blocked If true, returns top domains by blocked queries instead of total queries .PARAMETER RawOutput This will dump the response instead of the formatted object .EXAMPLE Get-PiHoleStatsTopDomain -PiHoleServer "http://pihole.domain.com:8080" -Password "your-app-password" -MaxResult 10 #> [CmdletBinding()] [System.Diagnostics.CodeAnalysis.SuppressMessageAttribute("PSAvoidUsingPlainTextForPassword", "Password")] param ( [Parameter(Mandatory = $true)] [System.URI]$PiHoleServer, [Parameter(Mandatory = $true)] [string]$Password, [int]$MaxResult = 10, [bool]$Blocked = $false, [bool]$IgnoreSsl = $false, [bool]$RawOutput = $false ) try { $Sid = Request-PiHoleAuth -PiHoleServer $PiHoleServer -Password $Password -IgnoreSsl $IgnoreSsl switch ($Blocked) { $false { $BlockedParam = "false" } $true { $BlockedParam = "true" } Default { throw "ERROR" } } Write-Verbose "Blocked: $BlockedParam" Write-Verbose "MaxResult: $MaxResult" $Params = @{ Headers = @{sid = $($Sid) } Uri = "$($PiHoleServer.OriginalString)/api/stats/top_domains?blocked=$BlockedParam&count=$MaxResult" Method = "Get" SkipCertificateCheck = $IgnoreSsl ContentType = "application/json" } $Response = Invoke-RestMethod @Params if ($RawOutput) { Write-Output $Response } else { $ObjectFinal = @() foreach ($Item in $Response.domains) { $Object = [PSCustomObject]@{ Domain = $Item.domain Count = $Item.count } Write-Verbose -Message "Domain - $($Item.domain): $($Item.count)" $ObjectFinal += $Object } Write-Output $ObjectFinal } } catch { Write-Error -Message $_.Exception.Message } finally { if ($Sid) { Remove-PiHoleCurrentAuthSession -PiHoleServer $PiHoleServer -Sid $Sid -IgnoreSsl $IgnoreSsl } } } |