Public/History/Get-PiHoleHistoryDatabase.ps1
|
function Get-PiHoleHistoryDatabase { <# .SYNOPSIS Get activity graph data (long-term data) .DESCRIPTION Request the long-term (on-disk database) data needed to generate the "total queries over time" graph for a given time range. The sum of Cached/Blocked/Forwarded for a given entry may be smaller than Total - the remainder are queries that don't fit into any of those categories (e.g. a busy database, or an unknown query status). .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 From Local date/time from when the data should be requested. Defaults to 8 hours ago. .PARAMETER Until Local date/time until when the data should be requested. Defaults to now. .PARAMETER IgnoreSsl Set to $true to skip SSL certificate validation .PARAMETER RawOutput This will dump the response instead of the formatted object .EXAMPLE Get-PiHoleHistoryDatabase -PiHoleServer "http://pihole.domain.com:8080" -Password "your-app-password" .EXAMPLE Get-PiHoleHistoryDatabase -PiHoleServer "http://pihole.domain.com:8080" -Password "your-app-password" -From (Get-Date).AddDays(-7) -Until (Get-Date) #> [CmdletBinding(HelpUri = 'https://ftl.pi-hole.net/master/docs/#get-/history/database')] [System.Diagnostics.CodeAnalysis.SuppressMessageAttribute("PSAvoidUsingPlainTextForPassword", "Password")] param ( [Parameter(Mandatory = $true)] [System.URI]$PiHoleServer, [Parameter(Mandatory = $true)] [string]$Password, [datetime]$From = (Get-Date).AddHours(-8), [datetime]$Until = (Get-Date), [bool]$IgnoreSsl = $false, [bool]$RawOutput = $false ) try { $Sid = Request-PiHoleAuth -PiHoleServer $PiHoleServer -Password $Password -IgnoreSsl $IgnoreSsl $FromUnixTime = (Convert-LocalTimeToPiHoleUnixTime -Date $From).UnixTime $UntilUnixTime = (Convert-LocalTimeToPiHoleUnixTime -Date $Until).UnixTime $Params = @{ Headers = @{sid = $($Sid) } Uri = "$($PiHoleServer.OriginalString)/api/history/database?from=$FromUnixTime&until=$UntilUnixTime" Method = "Get" SkipCertificateCheck = $IgnoreSsl ContentType = "application/json" } $Response = Invoke-RestMethod @Params if ($RawOutput) { Write-Output $Response } else { $ObjectFinal = foreach ($Item in $Response.history) { [PSCustomObject]@{ Timestamp = (Convert-PiHoleUnixTimeToLocalTime -UnixTime $Item.timestamp).LocalTime Total = $Item.total Cached = $Item.cached Blocked = $Item.blocked Forwarded = $Item.forwarded } } Write-Output $ObjectFinal } } catch { Write-Error -Message $_.Exception.Message } finally { if ($Sid) { Remove-PiHoleCurrentAuthSession -PiHoleServer $PiHoleServer -Sid $Sid -IgnoreSsl $IgnoreSsl } } } |