Umami Analytics Client for Python
Project description
Umami Analytics Client for Python
Analytics client for privacy-preserving, open source Umami platform based on
httpx
and pydantic
.
Partially implemented
Implemented endpoints:
POST /api/auth/login
aslogin_async
andlogin
POST /api/auth/verify
asverify_token_async
andverify_token
GET /api/websites
aswebsites_async
andwebsites
POST /api/send
asnew_event_async
andnew_event
See the API documentation for the remaining endpoints to be added (PRs welcome).
Installation
Just pip install umami-analytics
Usage
import umami
umami.set_url_base("https://umami.hostedbyyouorthem.com")
login = umami.login(username, password)
# Skip the need to pass the target website in subsequent calls.
umami.set_website_id('cc726914-8e68-4d1a-4be0-af4ca8933456')
umami.set_hostname('somedomain.com')
# List your websites
websites = umami.websites()
# Create a new event in the events section of the dashboards.
event_resp = umami.new_event(
website_id=sit'a7cd-5d1a-2b33', # Only send if overriding default above
event_name='Umami-Test',
title='Umami-Test', # Defaults to event_name if omitted.
hostname='somedomain.com', # Only send if overriding default above.
url='/users/actions',
custom_data={'client': 'umami-tester-v1'},
referrer='https://some_url')
# Call after logging in to make sure the auth token is still valid.
umami.verify_token()
Project details
Release history Release notifications | RSS feed
Download files
Download the file for your platform. If you're not sure which to choose, learn more about installing packages.
Source Distribution
umami_analytics-0.1.8.tar.gz
(4.8 kB
view hashes)
Built Distribution
Close
Hashes for umami_analytics-0.1.8-py3-none-any.whl
Algorithm | Hash digest | |
---|---|---|
SHA256 | 3a8a4a03c1e7f1073614e89f95adb8b58a0d08bc3296521731945d1d060eaae7 |
|
MD5 | 6355d9b2ce904673854cdadacf3d5a64 |
|
BLAKE2b-256 | 17dfc507bb6414c8c428a0632a94f1c7da2f32260dc3d498832d70295244194b |