Developer

Automate reporting with the API

Pull stats from Umami programmatically to build custom reports, Slack notifications, email digests, or automated dashboards.

Authentication#

Self-hosted#

Authenticate with username and password to get a bearer token:

Use the token in subsequent requests:

Umami Cloud#

Use your API key instead:

Example: Daily traffic summary#

Fetch yesterday's stats and format them for a report:

Example: Send to Slack#

Example: Top pages report#

Example: Weekly comparison#

Compare this week vs. last week to detect trends:

Running on a schedule#

Use a cron job, GitHub Actions, or a serverless function to run your reporting script on a schedule:

Cron (Linux/Mac):

GitHub Actions:

See the full API reference for all available endpoints.