You are here: Developers > OpenX Platform API > Release Notes

Release Notes

See also:

February 8, 2018

Increased character limit for oauth_callback

The oauth_callback parameter for browser-based authentication now supports 512 characters.

July 14, 2017

New Python client library

You can download the new Python client library directly from PyPI or by running either of the following commands:

$ pip install ox3apiclient
$ pip3 install ox3apiclient

April 20, 2017

RTB Health Stats report available via service API

You can use the RTB Health Stats report via the API to more easily ingest and integrate data that which allows you to monitor your bid performance. This report can be run using the API report name, rtb_stats.

Device Category information available in Domain Performance Report API

Device category information will now be returned in your Domain Performance report API data. With the addition of device category information, you can now conduct more in-depth analysis of your inventoryAd space available on a website or app. The basic unit of inventory for OpenX is an ad unit. performance.

March 23, 2017

Ability to run Video Events report via report service API

Using the API report name, video_event, you can now more easily integrate video events data with your internal databases and analytical platforms.

Frequency capping included in forecasting

Frequency cappingUsing cookies to track the impression count of ads served and stop any given ad being shown to a single visitor more than the set number of times. is now available for forecasting. You can add a frequency cap when generating a forecast by passing the "session_display_cap":integer argument into your call, where integer is > 0 and represents the number of impressions per day.

May 4, 2016

TFCD Query Argument Added

The tfcd query argument has been added to the Ad RequestCommunication from a web browser or app to an ad server to display an ad. API request parameters to ensure COPPA compliance. Possible values are 0 and 1.

  • 0 = Not COPPA compliant
  • 1 = COPPA compliant

For more information about the tfcd query argument, refer to the Ad Tag Parameters page.

February 11, 2016

'Adproduct' call removed

For this release, all adproduct calls have been removed and are no longer accessible to users via the OpenX UI and Platform API.

Updated ad tags

OpenX ad tags are now automatically updated to detect HTTP/HTTPS. Ad tags are now protocol-less and will work automatically for both secure and non-secure sites without requiring users to manually change the tags from HTTP to HTTPS.

January 28, 2016

API Functionality and Technical Documentation

The OpenX Platform API now supports enhanced API functionality for forecasting and legacy reporting. UI functionality remains unchanged for both of these features, however, users will be able to access forecasting and reporting features via the OpenX Platform API, as well as detailed technical documentation describing how to use these features in the API Developer's Guide.


Users may now run forecasts using the OpenX Platform API. Users wil still be able to use this feature via the user interface; however, if you choose to use the OpenX Platform API, you only need to make a single POST call to run a forecast.

For more detailed information about forecasting via the OpenX Platform API, please see the Forecasting documentation.


With this release, you may generate three different reports using the Platform API. You will still be able to access and generate these reports via the user interface, but you will now also be able to generate these reports via the Platform API. The three type of reports you can generate using the Platform API are:

Please see the Reporting documentation for more detailed information on how to use the OpenX Platform API for reporting.

November 9, 2015


The OpenX API now supports adding, editing, and retrieving comments using the OpenX API. With the OpenX API, you can:

  • Add a new comment to an object

  • Edit your own comments

  • Retrieve a list of comments for an object

Comments can be used to add notes to objects (e.g. line items, creatives, etc.) for other users to see; however, users will not be notified about new comments. Furthermore, one can only view comments when in the edit mode of an object.

If you are using the API to add/edit a comment, the following objects can have comments applied: account, ad, adunit, adunitgroup, audiencesegment, creativeThe media asset associated with an ad, such as an image or video file., creativetemplate, lineitem, optimization, order, siteAn OpenX component that represents top-level domains or subdomains and is used to organize ad units. Sites enable you to target and report on inventory performance., deal, floorrule, and packageA bundle of targeting criteria for similar inventory segments which you can offer at a predetermined price (typically to facilitate regular sales efforts) and automatically create line items from in OpenX.

Refer to the Working With Comments section for more detailed information on using this feature.

See also:

Feedback form