January 9, 2019
We've made a number of improvements to organization, look-and-feel, and content of docs.openx.com so that you can find the help you need more easily:
- A more intuitive navigation better reflects your integration paths and workflows.
- Developer topics that are relevant to specific types of integrations are now located with those topics instead of in a separate Developers section. For example, you can find iOS and Android SDK guidance in Integrations > Mobile SDKs in the Publishers section.
- A new Platform API section includes guidance on more general API operations, such as authentication.
- The Home page is more engaging and provide better initial direction.
November 15, 2018
Demand Partner Name no longer available in bid_perf report
You can no longer include the Demand PartnerA company which purchases ad inventory on OpenX Ad Exchange. Name as an attribute in the bid_perf report via the API.
October 18, 2018
Bundle ID now available in exch_perf and inv_perf reports
August 9, 2018
ISO country codes now available in inv_rev report
You can now include the two-letter ISO country codes rather than country names when running the inv_rev report via the API, to better synchronize your data.
May 31, 2018
ISO country codes now available in exch_perf report
You can now include the two-letter ISO country codes rather than country names when running the exch_perf report via the API, to better synchronize your data.
video_perf report deprecated
OpenX has deprecated the video_perf report to ensure that you use the most current reporting API and to eliminate data discrepancies associated with some legacy reports. You can use the video_event report to track event metrics for video impressions.
April 19, 2018
New attributes added to Video Events Report
You can now gain more status and inventoryAd space available on a website or app. The basic unit of inventory for OpenX is an ad unit. segmentation insights by adding the following attributes to your Video Events report (
video_event). These new attributes are not default attributes. To include these attributes in a Video Events report, use the
do_break parameter with the values listed in the table below.
April 6, 2018
deal_id from several API reports
February 22, 2018
Report column renaming
To facilitate analysis between different reports, the following reporting columns have been renamed in the Inventory Revenue Report to align with the naming conventions of other OpenX reports.
Inventory Revenue Report
Old field name
New field name
February 8, 2018
Increased character limit for
oauth_callback parameter for browser-based authentication now supports 512 characters.
July 14, 2017
New Python client library
$ 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,
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 inventory 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
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 COPPAChildren's Online Privacy Protection Act, a law created to protect the privacy of children under 13. 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:
Bid Performance Report
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 package
Refer to the Working With Comments section for more detailed information on using this feature.