Getting started

The Deals API allows publishers to view, create, and manage their Private Marketplace deals that they have negotiated with buyers at Index Exchange (Index). Follow the steps below to get started using the Deals API.


Before you begin:

You require an Index UI account username and password to establish authentication. If you do not have an Index UI account, contact your Index representative.

  1. To submit API requests, you will first need to establish authentication using the Generate user account token route.
  2. Create an inventory group to group site tags to create categories within your inventory that you want to target in the same way and apply to a specific deal.
  3. Create a deal based on the terms negotiated between publishers and buyers. Configure deal, inventory, and targeting setting that the deal requires.



Required fields: A red asterisk (*) beside a field name indicates that it is a required field.