https://github.com/ouuan/plausible-visitor-count

Proxy to get visitor count for a specific page from Plausible Analytics
https://github.com/ouuan/plausible-visitor-count

Last synced: 2 months ago
JSON representation

Proxy to get visitor count for a specific page from Plausible Analytics

• Host: GitHub
• URL: https://github.com/ouuan/plausible-visitor-count
• Owner: ouuan
• License: apache-2.0
• Created: 2022-07-20T03:34:45.000Z (over 2 years ago)
• Default Branch: master
• Last Pushed: 2024-10-13T04:43:36.000Z (3 months ago)
• Last Synced: 2024-10-15T21:13:40.386Z (3 months ago)
• Language: TypeScript
• Size: 733 KB
• Stars: 2
• Watchers: 1
• Forks: 1
• Open Issues: 1
• Metadata Files:
  • Readme: README.md
  • License: LICENSE

Awesome Lists containing this project

README

        
# plausible-visitor-count

Proxy to get visitor count for a specific page from [Plausible Analytics](https://plausible.io), because Plausible [does not support scoped API keys](https://github.com/plausible/analytics/discussions/1767).

The site's timezone needs to be set as GMT+0.

## API

`GET /api/visitors/:path`: The `path` should be URI encoded. For example: `GET /api/visitors/example%2Fpage` to get the visitor count of `$PLAUSIBLE_SITE_ID/example/page`. It returns a JSON object `{ statusCode: 200, path: string, visitors: number }` or `{ statusCode: number, error: string, message: string }` with corresponding HTTP status code. The period is from 2019-01-01 to now, i.e. all stats.

`GET /api/visitors`: To get the visitor count of the whole website. It returns a JSON object `{ statusCode: 200, visitors: number }` or `{ statusCode: number, error: string, message: string }` with corresponding HTTP status code. The period is from 2019-01-01 to now, i.e. all stats.

`GET /api/realtime`: Same format, realtime.

## Config

Configs are via environment variables.

`PLAUSIBLE_URL`: optional, default is `https://plausible.io`

`PLAUSIBLE_SITE_ID`: required

`PLAUSIBLE_API_TOKEN`: required

`LISTEN_HOST`: optional, default is `0.0.0.0`