GET Request With the Report ID

Syntax

The following method is used to obtain the report parameters in the system using GET.

Note: This method returns information about the contents of the report as well as all report parameters.

Note: This method will return the ID of each parameter, whether that parameter is mandatory or optional, and any default values assigned to that parameter (e.g. reports will default to yesterday as the date range).

URL

Note: The parameter highlighted in red is a placeholder for the mandatory value described below.

https://api.onereporting.aol.com/v3/report/REPORT_ID
  • REPORT_ID - Replace this placeholder with your report ID.

    Note: To learn where you can find you report ID, please refer to How Can I Find the Report ID?

Response

{
"id": "5ab27ed730dbe2000197b9b5",
"name": "gauge test",
"platformAlias": "O2",
"createdOn": 1521647319350,
"archived": false,
"shared": false,
"parameters": [
{ "id": "cid",
"optional": false,
"multi": true
},
{
"id": "af",
"optional": false,
"multi": false
},
{
"id": "sd",
"optional": false,
"multi": false
},
{ "id": "ed",
"optional": false,
"multi": false
},
{
"id": "tz",
"optional": false,
"multi": false
}
],
"mainFilter": "publisherCompanyWithAffiliates",
"blocks": [
{
"id": "5ab27ed730dbe2000197b9b4",
"title": "Report Section 1",
"blockType": "GAUGE_CHART",
"withTotal": false,
"metrics": [
"videoStarts"
],
"trendingTimeOption": "NONE",
"forecasting": false
}
]
}
Have more questions? Submit a request