# 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][1].\
[Getting Started details on Github](./docs/getting_started.md).
[Appendix for running on a server](./docs/authenticating_without_config_json.md)
## Versions
A documentation about the releases information can be found here : [aanalytics2 releases](./docs/releases.md)
## 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](./docs/main.md)
### Data Ingestion APIs
* Data Ingestion API from API 1.4
* Bulk Data Insertion API
documentation on ingestion APIs [here](./docs/ingestion.md)
## 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](./docs/legacyAnalytics.md)
## 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](./docs/requestCreator.md)
## 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](./docs/annotationCreator.md)
## 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](./docs/dwhCreator.md)
## Project Data
There is a feature to retrieve the Workspace projects and the components used.\
Refer to this [documentation on Project](./docs/projects.md) for more information.
## 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](./docs/logging.md)
## Getting Started
To install the library with PIP use:
```cli
pip install aanalytics2
```
or
```cli
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
* PyJWT
* PyJWT[crypto]
* 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](./docs/test.md)
## Others Sources
You can find information about the Adobe Analytics API 2.0 here :
* [https://adobedocs.github.io/analytics-2.0-apis][2]
* [https://github.com/AdobeDocs/analytics-2.0-apis/blob/master/reporting-guide.md][3]
[1]: https://www.datanalyst.info
[2]: https://adobedocs.github.io/analytics-2.0-apis
[3]: https://github.com/AdobeDocs/analytics-2.0-apis/blob/master/reporting-guide.md
Raw data
{
"_id": null,
"home_page": "https://github.com/pitchmuc/adobe-analytics-api-2.0",
"name": "aanalytics2",
"maintainer": null,
"docs_url": null,
"requires_python": ">=3.6",
"maintainer_email": null,
"keywords": "adobe, analytics, API, python",
"author": "Julien Piccini",
"author_email": "Julien Piccini <piccini.julien@gmail.com>",
"download_url": "https://files.pythonhosted.org/packages/93/44/170c5651150a816131c0ea3c30fc11915db30f3fbb730ca26218e63bb985/aanalytics2-0.4.3.tar.gz",
"platform": null,
"description": "# Adobe Analytics API v2.0\r\n\r\n-----------------------\r\n\r\nThis is a python wrapper for the adobe analytics API 2.0.\r\n\r\n## Documentation\r\n\r\nMost of the documentation for this API will be hosted at [datanalyst.info][1].\\\r\n[Getting Started details on Github](./docs/getting_started.md).\r\n\r\n[Appendix for running on a server](./docs/authenticating_without_config_json.md)\r\n\r\n## Versions\r\n\r\nA documentation about the releases information can be found here : [aanalytics2 releases](./docs/releases.md)\r\n\r\n## Functionalities\r\n\r\nFunctionalities that are covered :\r\n\r\n### Reporting API\r\n\r\n* Run a report statement\r\n* Retrieve Users, Segments, Metrics, Dimensions, Calculated Metrics, DateRange ,Virtual Report Suites, Tags, Projects, Annotations\r\n* Update Segment, Calculated Metric, Tags, Project, DateRange, Annotation, \r\n* Delete Segment, CalculatedMetric, VirtualReportSuite, Project, DateRange, Annotation\r\n* Create a Project\r\n* Create a Scheduling job for a Workspace Project\r\n* Retrieve Usage Logs from users\r\n* Manage Data Source\r\n* Manage Data Warehouse Requests \r\n\r\ndocumentation on reporting [here](./docs/main.md)\r\n\r\n### Data Ingestion APIs\r\n\r\n* Data Ingestion API from API 1.4\r\n* Bulk Data Insertion API\r\n\r\ndocumentation on ingestion APIs [here](./docs/ingestion.md)\r\n\r\n## Legacy Analytics API 1.4\r\n\r\nThis module provide limited support for the 1.4 API.\r\nIt basically wrapped your request with some internal module and you can pass your request path, method, parameters and / or data.\r\nMore information in the [dedicated documentation for 1.4](./docs/legacyAnalytics.md)\r\n\r\n## RequestCreator class\r\n\r\nThe `aanalytics2` module enables you to generate request dictionary for the getReport method easily.\\\r\nYou will have no need to go to the UI in order to create a report template JSON anymore.\\\r\nDo it automatically from the python interface.\r\nMore information on the [`RequestCreator` documentation](./docs/requestCreator.md)\r\n\r\n## AnnotationCreator\r\n\r\nThe `aanalytics2` module simplifies the creation of annotation definition via a specific module and class.\\\r\nThe `annotationCreator` module contains the `AnnotationCreator` class.\\\r\nIt is a builder that helps you create your annotation programmatically.\\\r\nMore information on the [`AnnotationCreator` documentation](./docs/annotationCreator.md)\r\n\r\n## Data Warehouse Creator\r\n\r\nThe `aanalytics2` module tries to simplify the creation of the data warehouse request definitions.\\\r\nA builder has been provided in an additional module: `dwhCreator`.\\\r\nThe module contains a class `DwhCreator` that should provide helpful functionalities to define your report requests.\\\r\nMore information on the [`DwhCreator` class](./docs/dwhCreator.md)\r\n\r\n## Project Data\r\n\r\nThere is a feature to retrieve the Workspace projects and the components used.\\\r\nRefer to this [documentation on Project](./docs/projects.md) for more information.\r\n\r\n## Logging capability\r\n\r\nIn case you want to use the logging capability for your script.\\\r\nYou can look at the reference for this on the [logging documentation page](./docs/logging.md)\r\n\r\n## Getting Started\r\n\r\nTo install the library with PIP use:\r\n\r\n```cli\r\npip install aanalytics2\r\n```\r\n\r\nor\r\n\r\n```cli\r\npython -m pip install --upgrade git+<https://github.com/pitchmuc/adobe_analytics_api_2.0.git#egg=aanalytics2>\r\n```\r\n\r\n## Dependencies\r\n\r\nIn order to use this API in python, you would need to have those libraries installed :\r\n\r\n* pandas\r\n* requests\r\n* json\r\n* PyJWT\r\n* PyJWT[crypto]\r\n* pathlib\r\n* dicttoxml\r\n* pytest\r\n\r\n## Test\r\n\r\nA test support has been added with pytest.\r\nThe complete documentation to run the test can be found here : [testing aanalytics2](./docs/test.md)\r\n\r\n## Others Sources\r\n\r\nYou can find information about the Adobe Analytics API 2.0 here :\r\n\r\n* [https://adobedocs.github.io/analytics-2.0-apis][2]\r\n* [https://github.com/AdobeDocs/analytics-2.0-apis/blob/master/reporting-guide.md][3]\r\n\r\n[1]: https://www.datanalyst.info\r\n[2]: https://adobedocs.github.io/analytics-2.0-apis\r\n[3]: https://github.com/AdobeDocs/analytics-2.0-apis/blob/master/reporting-guide.md\r\n",
"bugtrack_url": null,
"license": "Apache License 2.0",
"summary": "Adobe Analytics API 2.0 and 1.4 python wrapper",
"version": "0.4.3",
"project_urls": {
"Homepage": "https://github.com/pitchmuc/adobe-analytics-api-2.0",
"changelog": "https://github.com/pitchmuc/adobe-analytics-api-2.0/blob/master/docs/releases.md"
},
"split_keywords": [
"adobe",
" analytics",
" api",
" python"
],
"urls": [
{
"comment_text": null,
"digests": {
"blake2b_256": "72bb6fd5083a315ec92838d5936a71e40ef1d65163d6d33a2b7ad99a158f03b3",
"md5": "a8279329557f1b606d19ea01d8a95308",
"sha256": "d26d899dd4ab900ffcdb34031a8d997544c60df4a3211f8282f51a35cf94251a"
},
"downloads": -1,
"filename": "aanalytics2-0.4.3-py3-none-any.whl",
"has_sig": false,
"md5_digest": "a8279329557f1b606d19ea01d8a95308",
"packagetype": "bdist_wheel",
"python_version": "py3",
"requires_python": ">=3.6",
"size": 86446,
"upload_time": "2025-08-17T13:51:07",
"upload_time_iso_8601": "2025-08-17T13:51:07.308591Z",
"url": "https://files.pythonhosted.org/packages/72/bb/6fd5083a315ec92838d5936a71e40ef1d65163d6d33a2b7ad99a158f03b3/aanalytics2-0.4.3-py3-none-any.whl",
"yanked": false,
"yanked_reason": null
},
{
"comment_text": null,
"digests": {
"blake2b_256": "9344170c5651150a816131c0ea3c30fc11915db30f3fbb730ca26218e63bb985",
"md5": "7894e9f29c1bfbb42924eaa4a6397a12",
"sha256": "7053d6051b0e40800adb291b67aa5e0f60cfabb65723a1a59f37cf674aef15f9"
},
"downloads": -1,
"filename": "aanalytics2-0.4.3.tar.gz",
"has_sig": false,
"md5_digest": "7894e9f29c1bfbb42924eaa4a6397a12",
"packagetype": "sdist",
"python_version": "source",
"requires_python": ">=3.6",
"size": 175636,
"upload_time": "2025-08-17T13:51:08",
"upload_time_iso_8601": "2025-08-17T13:51:08.852417Z",
"url": "https://files.pythonhosted.org/packages/93/44/170c5651150a816131c0ea3c30fc11915db30f3fbb730ca26218e63bb985/aanalytics2-0.4.3.tar.gz",
"yanked": false,
"yanked_reason": null
}
],
"upload_time": "2025-08-17 13:51:08",
"github": true,
"gitlab": false,
"bitbucket": false,
"codeberg": false,
"github_user": "pitchmuc",
"github_project": "adobe-analytics-api-2.0",
"travis_ci": false,
"coveralls": false,
"github_actions": false,
"requirements": [
{
"name": "pandas",
"specs": [
[
">",
"1.0.0"
]
]
},
{
"name": "PyJWT",
"specs": [
[
">=",
"1.7.1"
]
]
},
{
"name": "PyJWT",
"specs": [
[
">=",
"1.7.1"
]
]
},
{
"name": "pathlib2",
"specs": [
[
">=",
"2.3.5"
]
]
},
{
"name": "requests",
"specs": [
[
">=",
"2.22.0"
]
]
},
{
"name": "dicttoxml",
"specs": [
[
">=",
"1.7.4"
]
]
},
{
"name": "pathlib",
"specs": [
[
">=",
"1.0.0"
]
]
},
{
"name": "openpyxl",
"specs": [
[
">=",
"2.6.1"
]
]
}
],
"lcname": "aanalytics2"
}
JSON
