Reporting API: Report Breakdown for specific item. Skip to end of metadata - alcazes/Adobe-Analytics-from-A-To-Z GitHub Wiki

Report to obtain

If you want to obtain the same report as follow via Adobe Analytics Reporting API:

Report Breakdown

Then you should run one of these Report.Queue requests:

API requests

Selected in Elements

{
    "reportDescription":{
         
        "reportSuiteID":"saintgbdprodnewsite",
         
        "dateFrom":"2016-06-01",
       
        "dateTo":"2016-06-30",
       
        "metrics":[
        
            {
                 
                "id":"instances"
             
            }
        ],
        "elements":[
           {
                "id":"evar30",
                "selected":[
                    "0"
                ]
            },
            {
                "id":"eVar1"
            }
        ]
    }
}

Documentation for first solution

The documentation for the solution above can be found here : https://marketing.adobe.com/developer/documentation/analytics-reporting-1-4/r-reportdescriptionelement#reference_9ECD594AEDD240D7A475868824079F06

Name Type Description
selected array(xsd:string) (Optional) Defines a specific list of items to request instead of using search, top, and startingWith to set the element parameters.

Using Inline Segments without container scope

{
   "reportDescription":{
         
        "reportSuiteID":"saintgbdprodnewsite",
         
        "dateFrom":"(string)",
                 
        "dateFrom":"2016-06-01",
       
        "dateTo":"2016-06-30",
       
        "metrics":[
             
            {
                 
                "id":"instances"
             
            }
        ],
        "elements":[
            {
                "id":"evar30"
            },
            {
                "id":"eVar1"
            }
        ],
        "segments":[
            {
                 
                "element":"evar30",
             
                "selected":[
               
                    "0"
                 
                ]
            }
        ]
    }
}

Documentation for inline segmentation without container scope

The documentation for the solution above can be found here : https://marketing.adobe.com/developer/documentation/analytics-reporting-1-4/inline-segments

Inline segmentation using containers

{
    "reportDescription":{
         
        "reportSuiteID":"saintgbdprodnewsite",
         
        "dateFrom":"(string)",
                 
        "dateFrom":"2016-06-01",
       
        "dateTo":"2016-06-30",
       
        "metrics":[
             
            {
                 
                "id":"instances"
             
            }
        ],
        "elements":[
            {
                "id":"evar30",
            },
            {
                "id":"eVar1"
            }
        ],
        "segments":[
            {
                "container":{
                     
                    "type":"hits",
                 
                    "rules":[
                   
                        {
                         
                            "name":"evar30 = 0",
       
                            "element":"evar30",
                             
                            "operator":"equals",
           
                            "value":"0"
   
                        }
         
                    ]
                 
                }
            }
        ]
    }
}

Documentation for inline segmentation using container scope

You can find the documentation here : https://marketing.adobe.com/developer/blog/inline-segments-in-1-4-reporting-api

https://marketing.adobe.com/developer/documentation/segments-1-4/r-segment-container#reference_03A15B1791EF4607910FA17247F9ADA7

[https://marketing.adobe.com/developer/documentation/segments-1-4/r-segment-rule#reference_62E104F8CA1C42819B9715CDDDD61E31