httpxとpydanticに基づいた、プライバシー普及のオープンソースUmami Analyticsプラットフォームのクライアント。
umami-analytics Umamiインスタンス(自己ホストまたはSaaS)にカスタムデータを追加することを目的としています。多くのUMAMIイベントはdata-*属性を介してHTMLから直接提供できます。ただし、できない人もいます。たとえば、アプリでトリガーされているが明確なHTMLアクションがないイベントがある場合は、カスタムイベントを追加できます。これらは、WebサイトのUmami Analtyticsページの下部に表示されます。
1つの例は、Talk PythonトレーニングのHTMLではなく、Pythonコードの奥深くで発生する購入コースイベントです。これは、私たちのイベントセクションが典型的な週末の日(米国太平洋時間)のどのように見えるかです。
UMAMI APIは広範囲であり、その多くはフロントエンドコードが機能することを目的としています。あなたはおそらくそれを望んでいないか、必要としないでしょう。 umami-analyticsほとんどの開発者がカスタムイベントの追加などの一般的なSaaSアクションに必要なサブセットのみをカバーしています。とはいえ、PRSはWeclomeです。
これらの機能に関するPython APIについては、以下の使用例を参照してください。
? Asyncはサポートされていますが、Pythonコードには必要ありません。ネットワークにアクセスする関数の場合、Pythonのasyncで動作してawaitいるfunc()およびfunc_async()バリアントがあります。
pip install umami-analyticsだけです
import umami
umami . set_url_base ( "https://umami.hostedbyyouorthem.com" )
# Auth is NOT required to send events, but is for other features.
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 = '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' )
# Create a new page view in the pages section of the dashboards.
page_view_resp = umami . new_page_view (
website_id = 'a7cd-5d1a-2b33' , # Only send if overriding default above
page_title = 'Umami-Test' , # Defaults to event_name if omitted.
hostname = 'somedomain.com' , # Only send if overriding default above.
url = '/users/actions' ,
referrer = 'https://some_url' )
# Call after logging in to make sure the auth token is still valid.
umami . verify_token ()このコードリストは、非常に高い忠実度PSUEDOコードです。実際に実行可能な例が必要な場合は、リポジトリのクライアントのサンプルを参照してください。
追加する残りのエンドポイントについては、APIドキュメントを参照してください。 PRは大歓迎です。ただし、最初に問題を開いて、提案された機能がこのライブラリの方向に適合するかどうかを確認してください。
楽しむ。