Intro to Reporting API

The Reporting API allows the integration of portal data with 3rd party platforms and dashboards for a variety of uses. To get started with the Reporting API, submit a ticket to Technical Support.

Follow the required on-boarding process to gain access to the Reporting API. Before beginning to work with our Reporting API, prepare the following:

  • Access to Analytics Reports - contact your Account Manager.
  • Setup an Application Account with the Verizon Media Ad Platform team.
  • Link the Application Account and public clientID to your Analytics Reports user. Email support@verizonmedia.com, provide your public clientID, and request to have the application account added as the "ONE Central Application ID".

Important! Integration with Reporting API requires some server-side development to generate OAuth 2.0 access client ID and Secret that is linked to your Portal user.

Using the Reporting API

Follow the steps below to begin using the API.

  1. Obtain a Token - For full detailed instructions read Create a Token for Reporting API.
  2. Create a Report - by sending an HTML POST request to https://api.stage.onereporting.aol.com/v4/report-management/report.
  1. Request data for a report - Follow the possible operations outlined here: https://api.onereporting.aol.com/v4/index.html#/.
    Both a Report IDClosed from the API response, the ID of the required report and Report ParametersClosed used to define filters for a report and include time and date range, organization ID, and any other filters configured for the report are required.
  2. Update report - update the report body to contain all required fields including the ID of the template and each of the existing blocks. Then send an HTML PUT request to https://api.onereporting.aol.com/v4/report-management/report.

Report ID

To use the Reporting API, the relevant Report ID must be known. There are a few ways to get it.

  1. Use the Reporting API to get a list of possible reports
  2. Edit a report to view the report ID listed in the deep link

Example link: https://one.aol.com/publisher/report...75d90001d9d42b

Report id in this case is: 59c16112c475d90001d9d42b

  1. View a report and look for the ID listed as the "first" ID in the deep link

Example link: https://one.aol.com/publisher/report...z=US%2FEastern

Report id: 59c16112c475d90001d9d42b

Report Parameters

Each report has a set of parameters that correspond to filters on the Analytics Reports user interface.

There are two ways to see all the filters and parameters and their potential values.

  • Deep link on Analytics Reports UI - Run a report to generate a deep link with the reporting parameters attached. Use those same parameters with our Reporting API.
    • Sample deep link: https://one.aol.com/publisher/reporting/index.html#/report/59a570d1159c350001f55b89?sd=2017-09-19T00&ed=2017-09-20T00&tz=US%2FEastern&ocOrgId=7878062793
    • Report template ID - 59a570d1159c350001f55b89
    • Start date parameter - sd=2017-09-19T00
    • End date parameter - ed=2017-09-20T00
    • Timezone parameter - tz=US%2FEastern
    • Organization ID parameter - ocOrgId=7878062793
  • GET request for report ID - Issue a GET Request with the Report ID which will return information about the contents of the report as well as all parameters.
    • Structure of the parameters section - "parameters": [ { "id": "string", "optional": true, "defaultValue": "string" } ]
    • The ID of each parameter
    • Whether or not that parameter is mandatory or optional
    • Any default values assigned to that parameter (e.g. reports default to yesterday as the date range)

Once the parameters and their structure has been obtained run a report using the POST report task.

  • If all parameters in a report have default values (based on the GET request), make a POST request with just the report template id (and our API will fetch data with those defaults).
  • If some parameters do not have defaults OR if defaults should be overridden, all mandatory parameters must be provided in a POST request along with the report template ID.