Expand my Community achievements bar.

Join us for the next Community Q&A Coffee Break on Tuesday April 23, 2024 with Eric Matisoff, Principal Evangelist, Analytics & Data Science, who will join us to discuss all the big news and announcements from Summit 2024!
SOLVED

Analytics reporting API

Avatar

Level 2

Hi,

I am trying to fetch some variables(both conversion & traffic variables) using reporting API , tried the QUEUE method which is step-1 in API explorer. PFB the code .

{

  "reportDescription":{

  "reportSuiteID":"XXXXXdev",

  "dateFrom":"2017-12-01",

  "dateTo":"2017-12-25",

  "metrics":[

  {

  "id":"Visits"

  }

  ],

  "sortBy":"Visits",

  "elements":[

  {

  "id":"eVar1",

   "top":2

  }

  ],

  }

}

The above code is working and i am getting the response with the report ID. But , if i change the "id" in "elements"  to some out-of-the box variable name , i am getting error. PFB the code and error message .  Please help me on this.

CODE :

{

  "reportDescription":{

  "reportSuiteID":"XXXXXXdev",

  "dateFrom":"2017-12-01",

  "dateTo":"2017-12-25",

  "metrics":[

  {

  "id":"Visits"

  }

  ],

  "sortBy":"Visits",

  "elements":[

  {

  "id":"cities",

  "top":2

  }

  ],

  }

}

ERROR:

{

  "error":"element_id_invalid",

  "error_description":"Element \"cities\" not found",

  "error_uri":"https:\/\/marketing.adobe.com\/developer\/en_US\/documentation\/analytics-reporting-1-4\/elements"

}

"cities" is the out-of-the-box variable in Visitor Profile -> GeoSegmentation . There is no eVar/prop allocated , hence i am giving name of the variable only in "id" .

1 Accepted Solution

Avatar

Correct answer by
Level 9

Look at the content of the error response. The error response attempts to give you information to point you in the right direction for what's going wrong. If you go to the URL shown in the error_uri response (Analytics Elements | Adobe Developer Connection) you will see that "cities" is not listed as valid element (which is also reflected in the error_message itself).

Perhaps you meant to use "geocity" ? Note that you must have geo-segmentation enabled on the report suite to use this element (which you may have not asked client care to do, since it looks like you used a dev report suite in your JSON).

Alternatively, is this actually a classification column for an actual variable (e.g. eVar1) ?  If this is the case, then "id" should be the parent/root variable for the classification, and the "classification" property should be used to specify the classification column.

Example (assuming eVar1 is the root/parent dimension):

"elements": [

    {

        "id": "eVar1",

        "classification": "cities",

        "top": 2

    }

],

View solution in original post

2 Replies

Avatar

Correct answer by
Level 9

Look at the content of the error response. The error response attempts to give you information to point you in the right direction for what's going wrong. If you go to the URL shown in the error_uri response (Analytics Elements | Adobe Developer Connection) you will see that "cities" is not listed as valid element (which is also reflected in the error_message itself).

Perhaps you meant to use "geocity" ? Note that you must have geo-segmentation enabled on the report suite to use this element (which you may have not asked client care to do, since it looks like you used a dev report suite in your JSON).

Alternatively, is this actually a classification column for an actual variable (e.g. eVar1) ?  If this is the case, then "id" should be the parent/root variable for the classification, and the "classification" property should be used to specify the classification column.

Example (assuming eVar1 is the root/parent dimension):

"elements": [

    {

        "id": "eVar1",

        "classification": "cities",

        "top": 2

    }

],

Avatar

Level 1

The error response insightfully highlights the issue, pointing out that "cities" is not a valid element according to Analytics Elements on the Adobe Developer Connection, and suggests considering "Sobha Crystal Meadows" as a potential alternative. It emphasizes the importance of ensuring the activation of relevant features, such as geo-segmentation, for proper integration with the report suite. Furthermore, it raises the possibility that "cities" might serve as a classification column for a variable like eVar1. In such a case, it recommends using "id" as the root variable and employing the "classification" property to specify the classification column. To address the problem, a thorough review and adjustment of the element in question, aligning it with Sobha Crystal Meadows and Adobe Analytics configuration settings, are advised for seamless integration and accurate reporting.