Nekometrics

=== Nekometrics - Your WordPress Numbers on Your Dashboard === Contributors: TigrouMeow Tags: metrics, dashboard, mailpoet, statistics, api Donate link: https://www.patreon.com/meowapps Requires at least: 6.0 Tested up to: 7.1 Requires PHP: 8.1 Stable tag: 0.0.1 License: GPLv2 or later License URI: https://www.gnu.org/licenses/gpl-2.0.html

Lets Nekometrics read the numbers of your site, such as your MailPoet subscribers, through a read-only API protected by a key you control.

== Description ==

Nekometrics is a dashboard where you gather the numbers you actually care about, from all the services you use, in one place. Most of those services have an API you can plug into. Your own WordPress site does not, at least not for the things that matter: how many people are on your newsletter, how many comments came in this month, how your content is growing.

This plugin fills that gap. It adds one small read-only API to your site, and Nekometrics comes and asks it for a number now and then. That is the whole plugin.

= What it shares =

• MailPoet subscribers, for the whole site or for one list. MailPoet has no HTTP API of its own, so this is the only clean way to graph your newsletter next to the rest of your numbers. Count the active ones, the number MailPoet itself shows you and the people your next newsletter will reach, or everyone registered, which adds the ones it stopped sending to for never opening anything.
• Users, approved comments and published content, per post type.

You choose which of these are exposed, on a settings page that fits on one screen.

= Curves from day one =

Most metrics plugins start you off with a flat line, because nobody was recording anything before you installed them. This one looks at what your site already knows: when each subscriber joined, when each comment was approved, when each post went out. From that it rebuilds the past months, so your widget has a real curve the moment you connect it.

The reconstruction is honest about itself. Today's number is always the true one, and anything the site no longer remembers, such as a subscriber who was deleted years ago, is flagged as an estimate rather than presented as fact.

= About the key =

The plugin generates one key, and that key unlocks nothing but these few read-only endpoints. It cannot publish, edit, delete, or read your content. If you would rather not keep it in the database, define NEKOMETRICS_API_KEY in your wp-config.php and the plugin will use that instead.

Nothing is sent anywhere on its own. There is no phoning home, no tracking, no analytics. Nekometrics asks, your site answers, and that only happens because you pasted the key there yourself.

= Adding your own metrics =

Any plugin or theme can expose its own numbers through the same API with the nekometrics_providers filter. Return a class extending Meow_NKMT_Providers_Provider, describe your metrics, and they show up in Nekometrics like the built-in ones.

== Installation ==

1. Install and activate the plugin.
2. Go to Meow Apps > Nekometrics (or Settings > Nekometrics).
3. Copy the endpoint and the key.
4. In Nekometrics, add a WordPress source and paste both.

== Frequently Asked Questions ==

= Do I need a Nekometrics account? =

Yes. The plugin only exposes the data. Nekometrics is where you build the dashboard.

= Does it slow down my site? =

No. Nothing runs on your visitors' page loads. The code only does anything when Nekometrics asks for a number, which is a few times a day.

= Is MailPoet required? =

No. Without it you still get users, comments and published content, and the MailPoet source simply shows as unavailable.

= Can I revoke access? =

Generate a new key on the settings page, or deactivate the plugin. Either one cuts Nekometrics off immediately.

= Where is the history stored? =

Nowhere on your site. The plugin computes it from data WordPress and MailPoet already keep, and Nekometrics stores what it fetches. Uninstalling leaves nothing behind but one deleted option.

== Changelog ==