API Reference

Demo

Discord

GitHub

Medama Analytics

Documentation

Retrieve the information of the user with the matching user ID.

Get User Info

UserSettings

CookieAuth

UserGet

Medama Analytics is an open-source project dedicated to providing self-hostable, cookie-free website analytics. With a lightweight tracker of less than 1KB, it aims to offer useful analytics while prioritising user privacy.

Introduction

Page Views

Overview

Page Events

Click Events

Privacy-focused by default, transparency by design.

Metrics

Unique Visitors

Location

Bounce Rate

Installation

Single Binary

Docker

Simple deployment with an easy-to-use platform.

Fly.io

Railway

Environment Variables

Configuring how the tracking snippet behaves.

Tracking Snippet

Login to the service and retrieve a session token for authentication.

Login

Logout of the service and destroy the session token.

Logout

Send a hit event to register a user view or interaction.

Send Hit Event

Ping endpoint to determine if the user is unique or not.

Ping

Delete User

Update User Info

Get the current CPU, memory and disk usage of the server.

Get Resource Usage

Get a list of all websites from the user.

List Websites

Add Website

Get website details for an individual website.

Get Website

Delete Website

Update Website

Get Stat Summary

Get Page Stats

Get a list of pages and their time stats.

Get Time Stats

Get Referrer Stats

Get a list of UTM sources and their stats.

Get UTM Source Stats

Get a list of UTM mediums and their stats.

Get UTM Medium Stats

Get a list of UTM campaigns and their stats.

Get UTM Campaign Stats

Get Browser Stats

Get OS Stats

Get Device Stats

Get Country Stats

Get Language Stats

Get a list of custom properties and their stats. If a property name is provided, it will return the stats for that property instead.

API Reference

Authentication

Event

User

Website

Stats

Get User Info

Authorizations

Cookies

Response