frodeaa / adminlte

Pi-hole Dashboard for stats and more

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, overTimeData10mins, topItems, topClients or getQuerySources, getQueryTypes, getForwardDestinations, and finally getAllQueries. Together with a token it is also possible to enable and disable (also with a set timeout) blocking via the API

The API returns more information (in a slighly different format if FTL is running) - it supports a fall-back to the "old" PHP API if FTL is not running. Test the type and/or version of the API by using the parameter type and version.

---

We use BrowserStack for multi-platform multi-browser testing.