Adobe Analytics API v2.0
This is a python wrapper for the adobe analytics API 2.0.
Documentation
Most of the documentation for this API will be hosted at datanalyst.info.
Getting Started details on Github.
Appendix for running on a server
Versions
A documentation about the releases information can be found here : aanalytics2 releases
Functionalities
Functionalities that are covered :
Reporting API
- Run a report statement
- Retrieve Users, Segments, Metrics, Dimensions, Calculated Metrics, DateRange ,Virtual Report Suites, Tags, Projects, Annotations
- Update Segment, Calculated Metric, Tags, Project, DateRange, Annotation,
- Delete Segment, CalculatedMetric, VirtualReportSuite, Project, DateRange, Annotation
- Create a Project
- Create a Scheduling job for a Workspace Project
- Retrieve Usage Logs from users
- Manage Data Source
- Manage Data Warehouse Requests
documentation on reporting here
Data Ingestion APIs
- Data Ingestion API from API 1.4
- Bulk Data Insertion API
documentation on ingestion APIs here
Command Line Interface (CLI)
The aanalytics2 package ships with an interactive command-line interface.
It gives you a terminal REPL to explore and manage your Adobe Analytics account without writing Python code, wrapping the Analytics and RequestCreator classes.
More information on the CLI documentation
Legacy Analytics API 1.4
This module provide limited support for the 1.4 API. It basically wrapped your request with some internal module and you can pass your request path, method, parameters and / or data. More information in the dedicated documentation for 1.4
RequestCreator class
The aanalytics2 module enables you to generate request dictionary for the getReport method easily.
You will have no need to go to the UI in order to create a report template JSON anymore.
Do it automatically from the python interface.
More information on the RequestCreator documentation
AnnotationCreator
The aanalytics2 module simplifies the creation of annotation definition via a specific module and class.
The annotationCreator module contains the AnnotationCreator class.
It is a builder that helps you create your annotation programmatically.
More information on the AnnotationCreator documentation
Data Warehouse Creator
The aanalytics2 module tries to simplify the creation of the data warehouse request definitions.
A builder has been provided in an additional module: dwhCreator.
The module contains a class DwhCreator that should provide helpful functionalities to define your report requests.
More information on the DwhCreator class
Data Repair API
The data repair API allows to delete or transform data that has been already ingested in Adobe Analytics.
The Data Repair API is an additional SKU in the Adobe Analytics licence, make sure you are provisionned before trying to use the module and API.
More information on the data repair module
Project Data
There is a feature to retrieve the Workspace projects and the components used.
Refer to this documentation on Project for more information.
Knowledge Graph
You can build an RDF Knowledge Graph out of your Adobe Analytics implementation, connecting your dimensions, metrics, segments, calculated metrics, and Workspace projects, along with their usage and co-occurrence relationships.
More information on the Knowledge Graph documentation
MCP Server
The aanalytics2 package ships with an MCP server, exposing Adobe Analytics — and, optionally, the Knowledge Graph above — as tools for MCP-compatible LLM clients such as Claude Desktop or VS Code.
More information on the MCP Server documentation
Logging capability
In case you want to use the logging capability for your script.
You can look at the reference for this on the logging documentation page
Getting Started
To install the library with PIP use:
pip install aanalytics2
or
python -m pip install --upgrade git+<https://github.com/pitchmuc/adobe_analytics_api_2.0.git#egg=aanalytics2>
Dependencies
In order to use this API in python, you would need to have those libraries installed :
- pandas
- requests
- json
- pathlib
- dicttoxml
- pytest
Test
A test support has been added with pytest. The complete documentation to run the test can be found here : testing aanalytics2
Others Sources
You can find information about the Adobe Analytics API 2.0 here :
1 maintainer
Metadata
1 maintainer
Release files for aanalytics2 0.5.5
For a detailed explanation of source distributions (sdists) and built distributions (wheels), please see the package formats documentation.
Source distribution (sdist)
| File | Size | Uploaded | |
|---|---|---|---|
| aanalytics2-0.5.5.tar.gz | 305.8 kB | Details |
Built distribution (wheel)
| File | Interpreter | ABI | Platform | Reset |
|---|---|---|---|---|
| aanalytics2-0.5.5-py3-none-any.whl | Python 3 | none | any | Details |
Total release size: 485.0 kB
Release files / aanalytics2-0.5.5.tar.gz
| Download URL | aanalytics2-0.5.5.tar.gz |
|---|---|
| Size | 305.8 kB |
| Tags | Source |
|
SHA-256 checksum How to use checksums |
7ff442205054927566f4a43d797b1570796d386449332be9d03fd2fefe92cff9
|
|
BLAKE2b-256 checksum How to use checksums |
e63d5e1f058b5c89d572a6c423c45aa1879eec5c91f71f5b626793e4e9df58dd
|
| Upload date | |
|
Uploaded using Trusted Publishing? What is trusted publishing? |
No |
| Uploaded via |
twine/6.1.0 CPython/3.13.3
|
Release files / aanalytics2-0.5.5-py3-none-any.whl
| Download URL | aanalytics2-0.5.5-py3-none-any.whl |
|---|---|
| Size | 179.2 kB |
| Tags | Python 3 |
|
SHA-256 checksum How to use checksums |
bd6cf240b0a4d4e782a05629d107237a5e4b791084d1126ef680d4849345b61c
|
|
BLAKE2b-256 checksum How to use checksums |
eed2b85404cd8a91354966896166263a38e485494a9c03a1d0eca1bc5cabe17d
|
| Upload date | |
|
Uploaded using Trusted Publishing? What is trusted publishing? |
No |
| Uploaded via |
twine/6.1.0 CPython/3.13.3
|
