J den Hartog
41bb9258b9
By submitting this pull request, I confirm the following (please check boxes, eg [X] - no spaces) Failure to fill the template will close your PR: Please submit all pull requests against the development branch. Failure to do so will delay or deny your request [X] I have read and understood the contributors guide. [X] I have checked that another pull request for this purpose does not exist. [X] I have considered, and confirmed that this submission will be valuable to others. [X] I accept that this submission may not be used, and the pull request closed at the will of the maintainer. [X] I give this submission freely, and claim no ownership to its content. How familiar are you with the codebase?: 2 Fixed minor typo in help.php text. This template was created based on the work of udemy-dl.
Pi-hole Admin Dashboard
Using AdminLTE, this project will create a Web interface for the ad-blocking Pi-hole: a black hole for Internet advertisements.
From this interface, you will be able to see stats on how well your Pi-hole is performing. You will also be able to update the lists used to block ads.
API
A read-only API can be accessed at /admin/api.php. With either no parameters or api.php?summary it returns the following JSON:
{
"domains_being_blocked": "136,708",
"dns_queries_today": "18,108",
"ads_blocked_today": "14,648",
"ads_percentage_today": "80.9"
}
There are many more parameters, such as summaryRaw, overTimeData, topItems, recentItems, getQueryTypes, getForwardDestinations, getQuerySources, and finally getAllQueries.
getAllQueries can optionally be set with one of these values to return JSON hash ordered as value implies: orderByClientDomainTime, orderByClientTimeDomain, orderByTimeClientDomain, orderByTimeDomainClient, orderByDomainClientTime or orderByDomainTimeClient.