Adobe Customer Journey Analytics (CJA) wrapper
Project description
Adobe Customer Journey API
This is a python wrapper for the Adobe Customer Journey API.
One important element when starting with CJA API is that you need to have your adobe console.io Project containing access to AEP and CJA.
You cannot use the API without having access to both elements.
Documentation
Documentation is split in different places:
- Core methods to setup
cjapy
: main documentation - Methods provided by the CJA class instance: cja documentation
- Workspace class documentation: Workspace class
- RequestCreator class documentation: RequestCreator class
- Project class documentation : Project class
Versions
A documentation about the releases information can be found here : cjapy releases
Functionalities
Functionalities that are covered :
- Get Dimensions & Metrics
- Get, Update and Delete Tags & Shares
- Get, Update and Delete Dataview
- Get, Update and Delete Date Ranges
- Get, Update and Delete Filters
- Get Top items for a dimension
- Get, Update and delete projects
- Digest Project Information and analyse them via the
Project
class - Run a report (by default returning a Workspace instance)
- (BETA) Run a multi dimensional report
Getting Started
A documentation is provided to get started quickly with the CJA API wrapper in python.
You can find it here: get started on cjapy
To install the library with PIP use:
pip install cjapy
or, to get the latest version from github
python -m pip install --upgrade git+<https://github.com/pitchmuc/cjapy.git#egg=cjapy>
Logging capability
A logging capability is present on the module for debugging purposes.
There is a proper documentation in place to understand how you can add the logging messages to your runtime.
Documentation on logging in cjapy
Dependencies
In order to use this API in python, you would need to have those libraries installed :
- pandas
- requests
- json
- PyJWT
- PyJWT[crypto]
- pathlib
- pytest
Test
TBW
Others Sources
You can find information about the CJA API here :
- [https://www.adobe.io/cja-apis/docs/api/]
- [https://www.adobe.io/cja-apis/docs/use-cases/]
Project details
Release history Release notifications | RSS feed
Download files
Download the file for your platform. If you're not sure which to choose, learn more about installing packages.
Source Distribution
Built Distribution
Hashes for cjapy-0.2.3.post2-py3-none-any.whl
Algorithm | Hash digest | |
---|---|---|
SHA256 | 94ee0ef974658be19886d16f041fc45e456fada2db06a8ec9d89bc33013bf637 |
|
MD5 | caa48593f17f4ef82e187d48a63d8bf4 |
|
BLAKE2b-256 | 1ced61ed8094342d85e9a3d2fcd6e32f6be70f0b8ba7d6159a26c94f00607525 |