mirror of
https://github.com/pi-hole/web.git
synced 2026-04-22 09:48:56 +01:00
28 lines
1.6 KiB
Markdown
28 lines
1.6 KiB
Markdown
Pi-hole Admin Dashboard
|
|
============
|
|
[](https://gitter.im/pi-hole/AdminLTE?utm_source=badge&utm_medium=badge&utm_campaign=pr-badge&utm_content=badge)
|
|
|
|
[](https://www.paypal.com/cgi-bin/webscr?cmd=_s-xclick&hosted_button_id=3J2L3Z4DHW9UY "Donate")
|
|
|
|
Using **[AdminLTE](https://almsaeedstudio.com)**, 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:
|
|
```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`.
|