umami python
v0.2.17
ไคลเอนต์สำหรับแพลตฟอร์มการวิเคราะห์อูมามิโอเพนซอร์สอูมามิที่ให้ความสำคัญตาม httpx และ pydantic
umami-analytics มีไว้สำหรับการเพิ่มข้อมูลที่กำหนดเองให้กับอินสแตนซ์ UMAMI ของคุณ (โฮสต์ตัวเองหรือ SaaS) เหตุการณ์อูมามิหลายเหตุการณ์สามารถให้โดยตรงจาก HTML ผ่านคุณลักษณะ data-* อย่างไรก็ตามบางคนไม่สามารถ ตัวอย่างเช่นหากคุณมีเหตุการณ์ที่เกิดขึ้นในแอพของคุณ แต่ไม่มีการกระทำ HTML ที่ชัดเจนคุณสามารถเพิ่มเหตุการณ์ที่กำหนดเองได้ สิ่งเหล่านี้จะปรากฏที่ด้านล่างของหน้าอูมามิอัลลีทิกส์ของคุณสำหรับเว็บไซต์
ตัวอย่างหนึ่งคือเหตุการณ์ การซื้อหลักสูตร ที่เกิดขึ้นลึกเข้าไปในรหัส Python มากกว่าใน HTML ที่ Talk Python Training นี่คือสิ่งที่ส่วนกิจกรรมของเราดูเหมือนสำหรับวันหยุดสุดสัปดาห์ทั่วไป (เวลา US Pacific):
Umami API นั้นกว้างขวางและส่วนใหญ่มีไว้สำหรับรหัสส่วนหน้าของพวกเขาเพื่อให้สามารถทำงานได้ คุณอาจไม่ต้องการหรือต้องการสิ่งนั้น umami-analytics เฉพาะชุดย่อยที่นักพัฒนาส่วนใหญ่จะต้องใช้สำหรับการกระทำ SaaS ทั่วไปเช่นการเพิ่มเหตุการณ์ที่กำหนดเอง ที่กล่าวว่า PRS เป็น weclome
ดูตัวอย่างการใช้งานด้านล่างสำหรับ Python API รอบ ๆ คุณสมบัติเหล่านี้
- Async ได้รับการสนับสนุน แต่ไม่จำเป็น สำหรับรหัส Python ของคุณ สำหรับฟังก์ชั่นที่เข้าถึงเครือข่ายมีตัวแปร func() และ func_async() ที่ใช้งานได้กับ async และ await ของ Python
เพียง 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 ที่มีความซื่อสัตย์สูงมาก หากคุณต้องการตัวอย่างที่ใช้งานได้จริงให้ดูตัวอย่างไคลเอนต์ใน repo
ดูเอกสาร API สำหรับจุดสิ้นสุดที่เหลือที่จะเพิ่ม ยินดีต้อนรับ PRS แต่โปรดเปิดปัญหาก่อนเพื่อดูว่าคุณลักษณะที่เสนอนั้นเหมาะสมกับทิศทางของห้องสมุดนี้หรือไม่
สนุก.
