Retrieving Overall data from the API | Community
Skip to main content
July 23, 2024
Question

Retrieving Overall data from the API

  • July 23, 2024
  • 3 replies
  • 812 views

Hello,

I need my product to pull "overall" users from the Adobe API. There is no dimension that I see associated with this (unless I am missing something), and I know if we just use the requests library we can make a request without a dimension (attached below). This does not appear valid through adobe analytics API 2.0 and fails as there is no "dimension" value. Is there a different way to pull "overall" users across years?

 

{ "rsid": "{rsid}", "globalFilters":[ { "type":"dateRange", "dateRange": "2023-12-01T00:00:00/2024-01-31T23:59:59.999999" }, { "type": "segment", "segmentId": "{segment}" }], "metricContainer": { "metrics": [{"columnId": "Overall", "id": "metrics/visitors" }] "metricFilters": [] }, "settings": { "countRepeatInstances": true, "limit": 10000, "page": 0 } }

This post is no longer active and is closed to new replies. Need help? Start a new post to ask your question.

3 replies

Jennifer_Dungan
Community Advisor and Adobe Champion
Community Advisor and Adobe Champion
July 24, 2024

I am not sure if the visitor id (in the raw data this is a combination of visid_high and visid_low) is available via the API... it's not available in Workspace either....

 

One of the things I do in my implementation is pass the ECID (which is close, but not exact to the User Identity) into a custom dimension.

 

This sadly won't help you retroactively....

Abhishek_Dubey
Level 2
July 24, 2024

Hi @andreaku2 

I am unsure of the actuall requirement as the question is somewhat unclear however you can try testing out Analytics API 2.0 on the swagger page (https://developer.adobe.com/analytics-apis/docs/2.0/apis/) to see if your requirements are being fullfilled there then you can try replicating the same in you code/app

Josh Stephens
Community Advisor
Community Advisor
July 30, 2024

hi @andreaku2,

If I understand your question correctly, you want to retrieve something similar to what we'd see in this table from demo data.  This uses the All Visits segment to return the total count.  If that's right, the JSON object from debugger is below for reference.

 

{
"rsid": "{rsid}",
"globalFilters": [
{
"type": "dateRange",
"dateRange": "2024-06-30T00:00:00.000/2024-07-28T00:00:00.000",
"dateRangeId": "last4FullWeeks"
}
],
"metricContainer": {
"metrics": [
{
"columnId": "metrics/visitors:::0",
"id": "metrics/visitors",
"filters": [
"STATIC_ROW_COMPONENT_1"
]
},
{
"columnId": "metrics/visits:::2",
"id": "metrics/visits",
"filters": [
"STATIC_ROW_COMPONENT_3"
]
}
],
"metricFilters": [
{
"id": "STATIC_ROW_COMPONENT_1",
"type": "segment",
"segmentId": "All_Visits"
},
{
"id": "STATIC_ROW_COMPONENT_3",
"type": "segment",
"segmentId": "All_Visits"
}
]
},
"settings": {
"countRepeatInstances": true,
"includeAnnotations": true
},
"statistics": {
"functions": [
"col-max",
"col-min"
]
},
"capacityMetadata": {
"associations": [
{
"name": "applicationName",
"value": "Analysis Workspace UI"
}
]
}
}