In this blog post, I would like to guide you on how to get started with the Adobe Customer Journey Analytics API with Python. I know that even if it makes your life easier, you still need to use python and that may be a bit daunting, therefore I created these videos to help you.
I will try to get you started from scratch, from installing python, jupyter notebook, going to the console.adobe.io (quickly) and then start using the different methods for generating report or analysis with the cjapy module.
To be noted: you can always find a getting started guide on my github: https://github.com/pitchmuc/cjapy/blob/master/docs/getting_started.md
Important: all methods available for the cjapy module are documented in the cjapy github.
Getting Started with Python, Jupyter and CJA API
In this video, I will (very) quickly go around the main requirement on python and jupyter installation.
After that, we will create a connection to the CJA API via console.adobe.io and the requirement to have an AEP connection as well.
Jupyter is not a requirement for the module but I find it very easy to use it with Jupyter, as you can have auto-complete and more interaction than creating a python program.
In this video, we will see how we can install the python module I built : cjapy.
We will also get an overview of the module itself and how it is built.
I am using the module to prepare the connection to the CJA API and I will realize a call to retrieve the data views.
The Workspace class instance
In this video, we will see how we can use the getReport method from the cjapy module and more specifically, describing the object it returns; a Workspace class instance.
This object is a great improvement over the previous result returned via the aanalytics2 module.
It allows you to realize a breakdown automatically from the data returned.
The RequestCreator class
In the previous video, I showed you how you can generate a report from connecting to Customer Journey Analytics workspace interface and use the debugger.
In this video, I happy to demonstrate that I created a capability to build your own report request directly via python methods. You will need to use the RequestCreator class that I am demonstrating in this video.
The Project class
Customer Journey Analytics API allows you to fetch the different Workspace projects that have been built in the interface.
The Project class allows you to decipher the response returned and undrstand how the different projects are built and realize analysis on your
This video is to show you on how you can generate a multilevel dimension report with the getMultidimensionalReport method.
At the time of the recording and the publication of this blog post, this method is still in Beta and need testing before production deployment.
Also, even though this return a Workspace class, the brekadown method will not work properly on the results.
This is it for me.
Let me know in the comments here or of the videos if you would like to have some additional video training.
I know that the quality is not the best but I try my best with the equipment I have.