PUT Update Report

Report update is performed in two steps:

  1. GET Report Parameters by Report ID.
  2. PUT Update Report.

 

Get Report Parameters by Report ID

Get report parameters following the steps described in GET Request With the Report ID.

Note: This method returns information about the contents of the report as well as all report parameters and their IDs, including the IDs of the blocks.

 

PUT Update Report

Syntax

The following method is used to update an existing report object in the system using PUT.

Note: Your PUT request is required to have updated body, that contains all required fields including report ID and each block ID.

URL

https://api.onereporting.aol.com/v3/report-management/report

JSON object

Pass a valid JSON report object via the method's 'Body'. The updated JSON report object must contain all required fields including the report ID of and each block ID.

Note: The following JSON Object is sent via the 'Body' with a 'Parameter content type' set to 'application/json'.

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

{
  "id": "REPORT_ID",
  "name": "Pawel's Report - updated",
  "platformAlias": "O2",
  "createdOn": 1512404503050,
  "archived": false,
  "shared": false,
  "mainFilter": "publisherCompanyWithAffiliates",
  "blocks": [
    {
      "id": "BLOCK_ID",
      "title": "Report Section 1",
      "blockType": "TABLE",
      "withTotal": false,
      "metrics": [
        "billableImpressions"
      ],
      "dimensions": [
        "adCampaignId"
      ],
      "order": [
        {
          "columnId": "billableImpressions",
          "direction": "DESC"
        }
      ],
      "trendingTimeOption": "NONE",
      "forecasting": false
    }
  ]
}
  • REPORT_ID - Replace this placeholder with your report ID.
  • BLOCK_ID - Replace this placeholder with your block ID.

 

Example

JSON Object

{
"id": "5ab27ed730dbe2000197b9b5",
"name": "API TEST update",
"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
}
]
}

Response

no content

 

 

Have more questions? Submit a request