Skip to content

Latest commit

 

History

History
157 lines (125 loc) · 5.88 KB

requestCreator.md

File metadata and controls

157 lines (125 loc) · 5.88 KB
Raw

aanalytics2 : RequestCreator class

The aanalytics2 module provide a way for you to create request dictionary to Adobe Analytics servers, it is done via the usage of the RequestCreatorclass.
This class will provide you an instance that contains methods to modify your request definition.
In this documentation, we will review the different methods available.

RequestCreator instanciation

In order to generate an instance of the RequestCreator, once you have loaded the aanalytics2 module, you can either directly call the class or pass an existing request definition.\

Creating an empty request

import aanalytics2
### creating an empty request 
myRequest = aanalytics2.RequestCreator()

The myRequest object will contain the following definition:

{
        "globalFilters": [],
        "metricContainer": {
            "metrics": [],
            "metricFilters": [],
        },
        "dimension": "",
        "settings": {
            "countRepeatInstances": True,
            "limit": 20000,
            "page": 0,
            "nonesBehavior": "exclude-nones",
        },
        "statistics": {"functions": ["col-max", "col-min"]},
        "dataId": "",
    }

Uploading a template request

import aanalytics2, json
### loading your existing request, downloaded from Adobe Analytics interface
with open('mySavedRequest.json','r') as f:
    saveRequest = json.load(f)
### passing the definition to the RequestCreator
myRequest = aanalytics2.RequestCreator(saveRequest)

In this case, myRequest will contain the definition that you have passed on the initiation of the RequestCreator instance.

Methods availables on RequestCreator instance

Once your instance has been created, example: myRequest, several methods are available to you.
We will review the different methods available via the object.

  • to_dict() This method returns the current request definition, in a dictionary.

  • save() This method saves the current request definition in a JSON file. Arguments:

    • filename : OPTIONAL : Name of the file. (default aa_request_<timestamp>.json)

  • setDimension() Set the dimension to be used for reporting. Arguments:

    • dimension : REQUIRED : the dimension to build your report on

  • setRSID() Set the reportSuite ID to be used for the reporting. Arguments:

    • rsid : REQUIRED : The reportSuite ID to be passed.

  • addMetric() Add a metric to the Request.

  • addGlobalFilter() Add a global filter to the report. NOTE : You need to have a dateRange filter at least in the global report. Arguments:

    • filterId : REQUIRED : The filter to add to the global filter.
      example:
      "s293120jf3q9jf38301jd029f030128z482s" -> segment ID
      "2020-01-01T00:00:00.000/2020-02-01T00:00:00.000" -> dateRange "dimension:::itemId" -> dimension value

  • removeGlobalFilter() Remove a specific filter from the globalFilter list. You can use either the index of the list or the specific Id of the filter used. Arguments:

    • index : REQUIRED : index in the list return
    • filterId : REQUIRED : the id of the filter to be removed (ex: filterId, dateRange)

  • setNoneBehavior() Set the behavior of the None values in that request. Arguments:

    • returnNones : OPTIONAL : True or False (True by default)

  • setRepeatInstance() Specify if repeated instances should be counted. Arguments:

    • repeat : OPTIONAL : True or False (True by default)

  • setLimit() Specific the number of element to retrieve. Default is 10. Arguments:

    • limit : OPTIONAL : number of elements to return

  • addMetricFilter() Add a filter to a metric. Arguments:

    • metricId : REQUIRED : metric where the filter is added
    • filterId : REQUIRED : The filter to add. When breakdown, use the following format for the value "dimension:::itemId"
    • metricIndex : OPTIONAL : If used, set the filter to the metric located on that index.

  • removeMetricFilter() remove a filter from a metric Arguments:

    • filterId : REQUIRED : The filter to add. when breakdown, use the following format for the value "dimension:::itemId"

  • updateDateRange() Update the dateRange filter on the globalFilter list One of the 3 elements specified below is required. Arguments:

    • dateRange : OPTIONAL : string representing the new dateRange string, such as: 2020-01-01T00:00:00.000/2020-02-01T00:00:00.000
    • shiftingDays : OPTIONAL : An integer, if you want to add or remove days from the current dateRange provided. Apply to end and beginning of dateRange. So 2020-01-01T00:00:00.000/2020-02-01T00:00:00.000 with +2 will give 2020-01-03T00:00:00.000/2020-02-03T00:00:00.000
    • shiftingDaysEnd : : OPTIONAL : An integer, if you want to add or remove days from the last part of the current dateRange. Apply only to end of the dateRange. So 2020-01-01T00:00:00.000/2020-02-01T00:00:00.000 with +2 will give 2020-01-01T00:00:00.000/2020-02-03T00:00:00.000
    • shiftingDaysStart : OPTIONAL : An integer, if you want to add or remove days from the last first part of the current dateRange. Apply only to beginning of the dateRange. So 2020-01-01T00:00:00.000/2020-02-01T00:00:00.000 with +2 will give 2020-01-03T00:00:00.000/2020-02-01T00:00:00.000

Instance attributes

At the moment, there are only limited attributes available on the instance of the RequestCreator class.

dates

In order to help build the main date request for your global filter, I have prepared some predefined dates available to you.
The different timeframe available through the dates attributes are the following:

  • thisMonth : full month date
  • untilToday : start of the month till yesterday midnight
  • todayIncluded : start of the month, today included
  • last30daysTillToday
  • last30daysTodayIncluded
  • last7daysTillToday
  • last7daysTodayIncluded

today

todayattribute is a datetime object, with today timestamp.
This can help you derive other dates if needed.