OpenX Platform API

Last updated on November 20, 2017

The OpenX Platform API is a JSON-based REST API which allows you to communicate with the OpenX Platform.

For developers who plan to integrate their applications with OpenX, this topic explains the basics of using the OpenX Platform API.

Authenticating users

Authenticating users involves four steps.

  1. Request an unauthorized request token.
  2. Authorize the user.
  3. Request an access token.
  4. Use the access token to access protected resources.

You can complete user authentication using one of two methods:

  • Browser-based authentication. Use browser-based authentication if you provide an interactive web-based login form for users, other than yourself.

  • Programmatic authentication. Use programmatic authentication if you access protected OpenX resources with your own credentials and do not provide a web-based login form for other users.

Making requests

When making an API request, you must follow standard HTTP API request structure. This ensures the request is properly formatted.

Request format

method base_URI/resource/identifier?parameter&parameter
Parameter Description

HTTP method.

Example: GET


OpenX server name or admin hostname. This is the same URI used to log into the OpenX UI.



API object or service.

Example: report


UID, ID, or request for specific values.

Example: run

Note: An identifier is not required for all objects or services. Refer to the specific object or service for more information.


Specific additional request information. The first parameter must begin with a question mark (?). Each subsequent parameter must begin with an ampersand (&).

Example: ?report=inv_perf_pub&start_date=0

The OpenX Platform API returns standard JSON responses to all standard HTTP API requests.