Skip to main content
Yanked

This release has been yanked by its maintainers, and will be ignored by installers, except when explicitly specified.
Consider using release 0.5.5.post2 instead.
Reason given by maintainers: upgrade to MCP 2.0

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 :

Metadata

Release files for aanalytics2 0.5.4.post6

For a detailed explanation of source distributions (sdists) and built distributions (wheels), please see the package formats documentation.

Source distribution (sdist)

Source distribution for aanalytics2 0.5.4.post6
File Size Uploaded
aanalytics2-0.5.4.post6.tar.gz 300.5 kB Details

Built distribution (wheel)

Table of built distributions (wheels) for aanalytics2 0.5.4.post6
File Interpreter ABI Platform
aanalytics2-0.5.4.post6-py3-none-any.whl Python 3 none any Details

Total release size: 475.0 kB

Release files / aanalytics2-0.5.4.post6.tar.gz

Download URL aanalytics2-0.5.4.post6.tar.gz
Size 300.5 kB
Tags Source
SHA-256 checksum
How to use checksums
92608ff40d54f235c3081c6a9f621c53509cc42d05522fe1ab3491a583748283
BLAKE2b-256 checksum
How to use checksums
01627ecb578347fc325b1b45241698b280a410c0441c344eb6a845263b5b0ca1
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.4.post6-py3-none-any.whl

Download URL aanalytics2-0.5.4.post6-py3-none-any.whl
Size 174.6 kB
Tags Python 3
SHA-256 checksum
How to use checksums
fb508fb3a81651b5139848867105ed725ac586f574147fb3a1386f571a368bde
BLAKE2b-256 checksum
How to use checksums
d51898828277e68b9641d0a152900005dc5aea18706172e4febb5d0116a484a4
Upload date
Uploaded using Trusted Publishing?
What is trusted publishing?
No
Uploaded via twine/6.1.0 CPython/3.13.3

Release history Release notifications | RSS feed

0.5.5

2 release files

This release

0.5.4.post6 This release

2 release files

0.5.4

2 release files

0.5.3

2 release files

0.5.2

2 release files

0.5.1

2 release files

0.5.0

2 release files

0.4.4

2 release files

0.4.3

2 release files

0.4.2

2 release files

0.4.1

2 release files

0.3.5

2 release files

0.3.4

2 release files

0.3.3

2 release files

0.3.2

2 release files

0.3.1

2 release files

0.3.0

2 release files

0.2.9

2 release files

0.2.8

2 release files

0.2.7

2 release files

0.2.6

2 release files

0.2.5

2 release files

0.2.4

3 release files

0.2.3

2 release files

0.2.2

2 release files

0.2.1

2 release files

0.2.0

2 release files

0.1.9

2 release files

0.1.8

2 release files

0.1.7

2 release files

0.1.6

2 release files

0.1.5

2 release files

0.1.4

2 release files

0.1.3

2 release files

0.1.2

2 release files

0.1.1

2 release files

0.1.0

2 release files

0.0.10

2 release files

0.0.9

2 release files

0.0.8

2 release files

0.0.7

2 release files

0.0.6

2 release files

0.0.5

2 release files

Anthropic, PBC Visionary sponsor Bloomberg Visionary sponsor Hudson River Trading Visionary sponsor Meta Visionary sponsor NVIDIA Visionary sponsor Microsoft Sustainability sponsor Depot Continuous Integration AWS Cloud computing and Security Sponsor Datadog Monitoring Fastly CDN Google Download Analytics Sentry Error logging StatusPage Status page