Connect to the Adobe Analytics API v2.0, which powers Analysis Workspace. The package was developed with the analyst in mind and will continue to be developed with the guiding principles of iterative, repeatable, timely analysis. New features are actively being developed and we value your feedback and contribution to the process. Please submit bugs, questions, and enhancement requests as issues in this Github repository.
The Adobe Analytics v1.4 API, while on its way out, still has some functionality that is not (yet?) available in the v2.0 API. As such, the RSiteCatalyst package created by Randy Zwitch remains a useful package. While this is not a comprehensive list, some of the features that are available through RSiteCatalyst that are not available through the v2.0 API (and, by extension, are not available through this package) are:
The v1.4 API also allows the user to pull data once they have web services access set up for their account and the client ID and client secret that comes along with that. In other words, it does not require that an Adobe Console API project be created, which is something that is required to use the v2.0 API. The benefit of getting an Adobe Console API project set up, though, is that the user then does not need web services access set up on an account-by-account basis to pull data using the package.
As a purely editorial side note, the creators and maintainers of this package would like to express their eternal gratitude to Randy for the work he put in to creating and maintaining
RSiteCatalyst. His work brought the power of R combined with data pulled directly via the Adobe Analytics API to a global audience, and we can only hope (for ourselves and the analyst community writ large) that
adobeanalyticsr can live up to the high standard he set with his work.
There are four setup steps required to start accessing your Adobe Analytics data. The following steps are each outlined in greater detail in the following sections:
company_idby using the function
Regardless of how many different Adobe Analytics accounts you will be accessing, you only need a single Adobe Console API project (you will still need to have working user credentials for each account you want to access, but the Adobe Console API project is just the way you then get access to authenticate using those user credentials; yes…confusing!):
* This is simply a helper site I’ve set up in order to make it easier to generate a token. The site does not store any information.
If you are knowledgeable of the ins and outs of this auth process and feel you have a better way to explain and/or set this up, please submit an issue or create a pull request with your recommendation!
Creating an Adobe Console API Project in under 60 seconds
This file is essential to keeping your information secure. It also speeds up analysis by limiting the number of arguments you need to add to every function call.
If you do not have an
.Renviron file (if you have never heard of this file you almost certainly don’t have one!), then create a new file and save it with the name
.Renviron. You can do this from within the RStudio environment and save the file either in your
Home directory (which is recommended; click on the Home button in the file navigator in RStudio and save it to that location) or within your project’s working directory.
Get the following variables from the OAuth project and add them to the file* (see Creating an Adobe Console API Project above):
AW_CLIENT_ID- OAuth client id found in the Adobe Developer Console
AW_CLIENT_SECRET- OAuth client secret key found in the Adobe Developer Console
AW_REPORTSUITE_ID variables once you know them (how to find available values for these two variables is described in step 4 below).
After adding these 2-4 variables to the
.Renviron file and saving it, restart your R session (Session > Restart R in RStudio) and reload
* The format of variables in the
.Renviron file is straightforward. If you add all four of the variables above, they would simply each be their own line in the file:
AW_CLIENT_ID = "[OAuth client ID]" AW_CLIENT_SECRET = "[OAuth client secret]" AW_COMPANY_ID = "[Company ID]" AW_REPORTSUITE_ID = "[RSID]"
The last step is to get your
company_id (or, if you have access to multiple accounts, get the
company_id you want to work with). This is also an excellent way to confirm that everything is set up correctly:
.Renvironfile as described in step 2 above. Otherwise, you can specify it within each function call that requires it.
AW_REPORTSUITE_IDin your file as described in step 2 above. You can retrieve all of the report suite IDs for a given
company_idusing the function
aw_get_reportsuites(company_id = '[the company ID for account of interest]').
If you added any values to your
.Renviron file (and then saved it!), then restart your R session (Session > Restart R in RStudio) and reload