Poznote Statistics via API

[qadhegh]

Thank you for the great Work so far.

It would be nice to get some Statistics via a simple GET request. Something like /public/statistics. This could provide General information like:

• Number of User
• Number of Notes
• Number of Workspaces
• Storage Consumption
• Last Successful Backup
• Last Successful Git Sync
• Error message (Backup Failed...)
• Update available

Not all are useful for everyone of cause, but I hope you get the Idea. The reason for my request is, I'm using a Dashboard (gethomepage) which allows me to create Widgets with Information about the Application. Getting this kind of information via the already available API would get quite complicated. And would require some kind of Authentication. But if Poznote can provide this kind of Information without Authentication (because read-only, nothing Personal like names or Misaddresses) would make it much easier.

Thanks in Advance
Qad

[timothepoznanski]

Thanks for the idea, it is in the next release.

GET /api/v1/public/statistics returns the number of users, notes, workspaces, folders and attachments, the storage used and the free disk space, the last local and S3 backups (when they last ran, whether it went through, when one last succeeded), the last Git sync, the installed and latest versions with an update_available flag, and a status field that turns to "warning" when a backup failed, a Git sync had errors or an update is out.

An admin turns it on in Settings > Admin Tools > Statistics API, in one of two ways. The first is a read-only token that Homepage sends in a header: it unlocks this summary and nothing else, so it can sit in your services.yaml without giving out an account password, and you can replace or revoke it at any time. The second is a "Public statistics, without a token" option, off by default, for instances that are not reachable from the internet. Either way the summary only holds counts, sizes and dates, never a username, a note title or an error message.

The full list of fields is in the API documentation, in the Instance Statistics section of docs/API-REST.md.