httpx 및 pydantic 을 기반으로 한 개인 정보 보호, 오픈 소스 Umami Analytics 플랫폼의 클라이언트.
umami-analytics 우마미 인스턴스 (자체 호스팅 또는 SAA)에 사용자 정의 데이터를 추가하기위한 것입니다. 많은 우마미 이벤트는 data-* 속성을 통해 HTML에서 직접 공급할 수 있습니다. 그러나 일부는 할 수 없습니다. 예를 들어, 앱에 트리거되었지만 명확한 HTML 작업이없는 이벤트가있는 경우 사용자 정의 이벤트를 추가 할 수 있습니다. 이것들은 웹 사이트의 Umami Analtytics 페이지의 맨 아래에 나타납니다.
한 가지 예는 Talk Python Training의 HTML이 아닌 Python 코드 내부에서 깊숙이 발생하는 구매 코스 이벤트입니다. 이것은 우리의 이벤트 섹션이 전형적인 주말 날 (미국 태평양 시간)의 모습입니다.
우마미 API는 광범위하며 그 중 상당수는 프론트 엔드 코드가 작동 할 수 있도록 의도 된 것입니다. 당신은 아마 그것을 원하거나 필요로하지 않을 것입니다. umami-analytics 대부분의 개발자가 사용자 정의 이벤트 추가와 같은 일반적인 SaaS 동작에 필요한 하위 집합 만 포함합니다. 즉, PR은 weclome입니다.
이러한 기능 주변의 Python API에 대한 아래 사용 예제를 참조하십시오.
? Async는 지원되지만 Python 코드에는 필요하지 않습니다 . 네트워크 await 액세스하는 함수의 경우 Python의 async 와 함께 작동하는 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 코드입니다. 실제로 실행 가능한 예제를 원한다면 Repo의 예제 클라이언트를 참조하십시오.
나머지 엔드 포인트를 추가 할 API 문서를 참조하십시오. PR을 환영합니다. 그러나 제안 된 기능 이이 라이브러리의 방향에 적합한 지 확인하려면 먼저 문제를 열어주십시오.
즐기다.