Adguardhome: Add API (feature request)

[tjorim]

Description

An AdGuard Home add-on for Home Assistant is in the works.
Some users (including myself) would like to show statistics,
the same way as it's possible with the Pi-hole sensor.
However, at the moment there doesn't seem to be an API to gat data like this from AdGuard.
While Pi-hole is preparing their new API, the docs for the current one are available here to check out.

Expected behavior

An API to pull statistics data is available

Actual behavior

It is not implemented currently

Your environment

NA

Additional details

Below is a short list of statistics that are available for Pi-hole in Home Assistant:

ads_blocked_today
Total number of blocked ads today.

ads_percentage_today
Percentage of blocked ads.

dns_queries_today
Total number of DNS queries handled by Pi-hole today.

domains_being_blocked
Total number of domains blocked by Pi-hole.

queries_cached
Total number of cache queries on the last 24 hours.

queries_forwarded
Total number of forwarded queries on the last 24 hours.

unique_clients
Total number of unique clients on the last 24 hours.

unique_domains
Total number of unique domains on the last 24 hours.

clients_ever_seen
Total number of seen clients

[ameshkov]

First of all, please check what API is available:
https://github.com/AdguardTeam/AdGuardHome/tree/master/openapi

If there's something you'd like to be added, please post a comment here with the details on what you'd like to have there and why you need it.

[tjorim]

Thanks for pointing me to this, didn't find it at first (just searched the readme and wiki), will check it out!

[rothgar]

I also would love metrics. Another possibility besides building it into the API is to have a prometheus compatible /metrics endpoint that serves plain text metrics.

More information available here https://prometheus.io/docs/concepts/data_model/

[ameshkov]

@rothgar there's already a feature request for that: #516

[frenck]

@tjorim You question regarding Home Assistant availability, that integration is currently in progress and expected to land in Home Assistant pretty soon (stats & controls).

[stale[bot]]

This issue has been automatically marked as stale because it has not had recent activity. It will be closed if no further activity occurs. Thank you for your contributions.

[frenck]

This can be closed actually, since Home Assistant now has an AdGuard Home integration.