Join us January 15th for an AMA with Champion Achaia Walton, who will be talking about her article on Event-Based Reporting and Measuring Content Groups!
SOLVED
Report Suit
Will this be an ongoing date pull on a schedule or a one-time pull? Have you considered using Data Warehouse to pull this data into a CSV file that you can process? Even Data Warehouse can be scheduled, so depending on your needs, that still may be easier than the API...
However, using the method I mentioned below, I can pull data in that format in a single API call:
I've hidden my totals for my screenshot, and just pulled in a sample of my marketing channels (you would pull in all of yours as columns, and which ever metric you need, you may want Visit, or you may want Page Views or Marketing Channel Instance, etc)
This is the JSON formatted API request that pulled the Workspace Report above, and what provided to me by using the debugger (you can put in the correcy suite, change the date range, change the Marketing Channels and Orders based on your needs, and probably drop the who "project association thing" as that is specific to Workspace):
{
"rsid": "SUITEIDHERE",
"globalFilters": [
{
"type": "dateRange",
"dateRange": "2021-01-01T00:00:00.000/2023-12-01T00:00:00.000"
}
],
"metricContainer": {
"metrics": [
{
"columnId": "1",
"id": "metrics/visits",
"filters": [
"0"
]
},
{
"columnId": "2",
"id": "metrics/visits",
"filters": [
"1"
]
},
{
"columnId": "3",
"id": "metrics/visits",
"filters": [
"2"
]
},
{
"columnId": "4",
"id": "metrics/visits",
"filters": [
"3"
]
},
{
"columnId": "5",
"id": "metrics/visits",
"filters": [
"4"
]
},
{
"columnId": "6",
"id": "metrics/visits",
"filters": [
"5"
]
},
{
"columnId": "7",
"id": "metrics/visits",
"filters": [
"6"
]
}
],
"metricFilters": [
{
"id": "0",
"type": "breakdown",
"dimension": "variables/marketingchannel",
"itemId": "2"
},
{
"id": "1",
"type": "breakdown",
"dimension": "variables/marketingchannel",
"itemId": "1"
},
{
"id": "2",
"type": "breakdown",
"dimension": "variables/marketingchannel",
"itemId": "7"
},
{
"id": "3",
"type": "breakdown",
"dimension": "variables/marketingchannel",
"itemId": "9"
},
{
"id": "4",
"type": "breakdown",
"dimension": "variables/marketingchannel",
"itemId": "3"
},
{
"id": "5",
"type": "breakdown",
"dimension": "variables/marketingchannel",
"itemId": "10"
},
{
"id": "6",
"type": "breakdown",
"dimension": "variables/marketingchannel",
"itemId": "5"
}
]
},
"dimension": "variables/daterangeday",
"settings": {
"countRepeatInstances": true,
"includeAnnotations": true,
"limit": 400,
"page": 0,
"dimensionSort": "asc",
"nonesBehavior": "return-nones"
},
"statistics": {
"functions": [
"col-max",
"col-min"
]
},
"capacityMetadata": {
"associations": [
{
"name": "applicationName",
"value": "Analysis Workspace UI"
},
{
"name": "projectId",
"value": "undefined"
},
{
"name": "projectName",
"value": "New project"
},
{
"name": "panelName",
"value": "Freeform table"
}
]
}
}
Look at my instructions below... I didn't write this, I used the Adobe generated API call here..
However, when it comes to Marketing Channels, they all have a specific numeric ID which the above map to:
Marketing Channel Manager:
(Admin > Report Suites (choose suite) Edit Settings > Marketing Channels > Marketing Channel Manager)
You can see in the Workspace screenshot above, I had "Organic Search" as my first column, in the Marketing Channel Manager you can see Organic Search is "2", and the first item in the JSON formatted API Request is
{
"id": "0",
"type": "breakdown",
"dimension": "variables/marketingchannel",
"itemId": "2"
},
itemId "2" corresponds to the Channel ID "2"..
Not everything will always be numerically identified, but in this case, it is...
We don't use the APIs much right now, but if we did, using the built-in debugger is where I would go first, to save myself a lot of time... let it build the basics, then try to understand what it's doing, then make modifications if needed.
You can have segments at the panel level. You can also stack Segments right into your tables...
You can even have them in your breakdowns, as well as stack over one or more columns:
Everything in workspaces is driven by APIs... so if you can build it, the API can be replicated.
In addition to the above documentation, here is a little known trick for building out API calls:
Workspace Reports are all built using the API, and you can get all the calls that are used to make your tables of data.
You first have to enable the debugger:
This will add a new icon onto your tables:
When you click on this, it will first ask you if you want to get the calls for the Freeform Table or for the Sparkline (choose the Table)
Next, it will show you different timestamps, some complex tables may need multiple calls, you can check each of these, and when you choose them, it will take you to a new screen that will show you the API requests in different languages (you can take the one relevant to you and use it as is, or modify it to suite you better.
Basically, if you can build a basic freeform table that returns the data you need in Workspaces, you can use those same calls to get the same data into your external data pulls.
Good luck.
Related Conversations
