Universal Analytics for Python
It's a fork of universal-analytics-python whith support for Python 3, batch requests, synchronous and asynchronous API calls.
This library provides a Python interface to Google Analytics, supporting the
Universal Analytics Measurement Protocol, with an interface modeled (loosely)
after Google's analytics.js.
NOTE this project is reasonably feature-complete for most use-cases, covering all relevant features of the Measurement Protocol, however we still consider it beta. Please feel free to file issues for feature requests.
Installation
The easiest way to install universal-analytics is directly from PyPi using pip
by running the following command:
pip install universal-analytics-python3
Usage
For the most accurate data in your reports, Analytics Pros recommends establishing a distinct ID for each of your users, and integrating that ID on your front-end web tracking, as well as back-end tracking calls. This provides for a consistent, correct representation of user engagement, without skewing overall visit metrics (and others).
A simple example for synchronous usage:
from universal_analytics import Tracker, HTTPRequest, HTTPBatchRequest
with HTTPRequest() as http:
tracker = Tracker("UA-XXXXX-Y", http, client_id="unique-id")
tracker.send("event", "Subscription", "billing")
with HTTPBatchRequest() as http:
tracker = Tracker("UA-XXXXX-Y", http, client_id="unique-id")
tracker.send("event", "Subscription", "billing")
A simple example for asynchronous usage:
import asyncio
from universal_analytics import Tracker, AsyncHTTPRequest, AsyncHTTPBatchRequest
async def main():
async with AsyncHTTPRequest() as http:
tracker = Tracker("UA-XXXXX-Y", http, client_id="unique-id")
await tracker.send("event", "Subscription", "billing")
async with AsyncHTTPBatchRequest() as http:
tracker = Tracker("UA-XXXXX-Y", http, client_id="unique-id")
await tracker.send("event", "Subscription", "billing")
loop = asyncio.get_event_loop()
loop.run_until_complete(main())
This library support the following tracking types, with corresponding (optional) arguments:
- pageview: [ page path ]
- event: category, action, [ label [, value ] ]
- social: network, action [, target ]
- timing: category, variable, time [, label ]
Additional tracking types supported with property dictionaries:
- transaction
- item
- screenview
- exception
Property dictionaries permit the same naming conventions given in the analytics.js Field Reference, with the addition of common spelling variations, abbreviations, and hyphenated names (rather than camel-case).
Further, the property dictionaries support names as per the Measurement Protocol Parameter Reference, and properties/parameters can be passed as named arguments.
Example:
# As python named-arguments
tracker.send("pageview", path="/test", title="Test page")
# As property dictionary
tracker.send("pageview", {"path": "/test", "title": "Test page"})
Server-side experiments:
# Set the experiment ID and variation ID
tracker.set("exp", "$experimentId.$variationId")
# Send a pageview hit to Google Analytics
tracker.send("pageview", path="/test", title="Test page")
License
This code is distributed under the terms of the MIT license.
Changes
A full changelog is maintained in the CHANGELOG file.
Contributing
universal-analytics-python3 is an open source project and contributions are welcome! Check out the Issues page to see if your idea for a contribution has already been mentioned, and feel free to raise an issue or submit a pull request.
Metadata
Release files for universal-analytics-python3 1.1.1
For a detailed explanation of source distributions (sdists) and built distributions (wheels), please see the package formats documentation.
Source distribution (sdist)
| File | Size | Uploaded | Provenance | Actions |
|---|---|---|---|---|
| universal-analytics-python3-1.1.1.tar.gz | 11.9 kB | Without provenance | Details for universal-analytics-python3-1.1.1.tar.gz |
Built distribution (wheel)
| File | Interpreter | ABI | Platform | Actions Reset |
|---|---|---|---|---|
| universal_analytics_python3-1.1.1-py3-none-any.whl | Python 3 | none | any | Details for universal_analytics_python3-1.1.1-py3-none-any.whl |
Total release size: 22.4 kB
Release files / universal-analytics-python3-1.1.1.tar.gz
| Download URL | universal-analytics-python3-1.1.1.tar.gz |
|---|---|
| Size | 11.9 kB |
| Tags | Source |
|
SHA-256 checksum How to use checksums |
f58b6ab7cef2389aefed80f145b873e447dc4083256330f187122783792f7fad
|
|
BLAKE2b-256 checksum How to use checksums |
75f2973fd8a70ae06c8c46c15c88c7aac31192cd6a254c4969591f0a7b0cb039
|
| Upload date | |
|
Uploaded using Trusted Publishing? What is trusted publishing? |
No |
| Uploaded via |
twine/3.4.1 importlib_metadata/4.0.1 pkginfo/1.7.0 requests/2.25.1 requests-toolbelt/0.9.1 tqdm/4.60.0 CPython/3.9.4
|
Release files / universal_analytics_python3-1.1.1-py3-none-any.whl
| Download URL | universal_analytics_python3-1.1.1-py3-none-any.whl |
|---|---|
| Size | 10.5 kB |
| Tags | Python 3 |
|
SHA-256 checksum How to use checksums |
dc408a41865d3bd0adf5c04337f3f20fe418f2633155190e6e87de84e0b75cf1
|
|
BLAKE2b-256 checksum How to use checksums |
7b0314c1e481b6f4d4208b30847dd788da5b5de4abcafbf95dc98d8c07a5c95f
|
| Upload date | |
|
Uploaded using Trusted Publishing? What is trusted publishing? |
No |
| Uploaded via |
twine/3.4.1 importlib_metadata/4.0.1 pkginfo/1.7.0 requests/2.25.1 requests-toolbelt/0.9.1 tqdm/4.60.0 CPython/3.9.4
|
Security for universal-analytics-python3 1.1.1
Provenance
Provenance describes where a file came from. On PyPI, provenance is shared via attestations, which provide a verifiable record of the build or publishing details. View details, limitations and caveats.
No provenance found
None of the files in this release were uploaded with provenance metadata.
A note on package security
PyPI is a repository for distributing packages, not a service for auditing them. While third-party security researchers and our staff do their best to detect and remove malicious packages, PyPI cannot guarantee the quality, security or suitability of any given package.
To learn more about protecting yourself from malicious actors, visit our package security documentation.