add top clients

PiHoleShell/PiHoleShell.psm1

@@ -28,7 +28,7 @@ Export-ModuleMember -Function @(
         #Padd.ps1
         'Get-PiHolePadd', `
         #Metrics.ps1
-        'Get-PiHoleStatsRecentBlocked', 'Get-PiHoleStatsQueryType', 'Get-PiHoleStatsTopDomain', 'Get-PiHoleStatsSummary', `
+        'Get-PiHoleStatsRecentBlocked', 'Get-PiHoleStatsQueryType', 'Get-PiHoleStatsTopDomain', 'Get-PiHoleStatsSummary', 'Get-PiHoleStatsTopClient' `
         #ListManagement.ps1
         'Get-PiHoleList', 'Search-PiHoleListDomain', 'Add-PiHoleList', 'Remove-PiHoleList', `
         #FTLInformation.ps1

PiHoleShell/Public/Metrics.ps1

@@ -179,6 +179,94 @@ https://TODOFINDNEWAPILINK
     }
 }
 
+function Get-PiHoleStatsTopClient {
+    <#
+.SYNOPSIS
+Get top clients
+Request the top clients (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 clients by blocked queries instead of total queries
+
+.PARAMETER RawOutput
+This will dump the response instead of the formatted object
+
+.EXAMPLE
+Get-PiHoleStatsTopClient -PiHoleServer "http://pihole.domain.com:8080" -Password "fjdsjfldsjfkldjslafjskdl" -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_clients?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.clients) {
+                $Object = $null
+                $Object = [PSCustomObject]@{
+                    IP    = $Item.ip
+                    Name  = $Item.name
+                    Count = $Item.count
+                }
+                Write-Verbose -Message "Client - $($Item.ip) ($($Item.name)): $($Item.count)"
+                $ObjectFinal += $Object
+            }
+            Write-Output $ObjectFinal
+        }
+    }
+
+    catch {
+        Write-Error -Message $_.Exception.Message
+        break
+    }
+
+    finally {
+        if ($Sid) {
+            Remove-PiHoleCurrentAuthSession -PiHoleServer $PiHoleServer -Sid $Sid -IgnoreSsl $IgnoreSsl
+        }
+    }
+}
+
 function Get-PiHoleStatsSummary {
     <#
 .SYNOPSIS