Index Exchange API

Getting started

To access the REST API, you require an Index Exchange publisher account and a password.

First, you must establish authentication and then you can submit requests to the API.

About the REST API

REST (representational state transfer) is a program architecture that uses Hypertext Transfer Protocol to communicate as follows:

You can use the REST API to access and change publisher data in your Index Exchange account.

You can access the API by using an HTTP client such as Advanced Rest Client.

Requests

Submission methods

You can submit requests to the Index Exchange API with the following HTTP verbs:

Request format

You can submit PUT, PATCH and POST requests in JSON.

Note: GET and DELETE request parameters must be URL-encoded.

Rate limits

You can make up to 1,000 requests per hour using the Index Exchange API. If you exceed the maximum of 1,000 requests per hour, you may experience rate limiting.

Responses

Response format

Responses are available in JSON.

Errors

When an error occurs, an error code and path are returned.

The code parameter returns a code that explains why the error occurred. For a list of error codes, see below.

The path parameter contains the submitted field(s) and/or subfield(s) that are relevant to the error. The path parameter always starts with the #/ value. For example: when a site ID within a request is incorrect, #/siteID is returned. When only #/ is returned, the entire document or more than one parameter contains errors.

The error codes are as follows:

Error code Description
ARRAY_LENGTH_LONG The specified array is too long.
ARRAY_LENGTH_SHORT The submitted array is too short.
ARRAY_UNIQUE The specified array contains duplicates and duplicates are not accepted.
CONFLICT_DATA The specified data conflicts with data that is already in the system. The path parameter indicates the field containing the conflicting data.
CONFLICT_REQUEST One or more submitted values conflict with other information in your request.
DUPLICATE_ENTITY One or more submitted values is a duplicate and duplicates are not accepted.
ENTITY_CONFIG_INCORRECT An entity that was directly or indirectly referenced in the request has a configuration that conflicts with the request. For example: a request to update proxy publisher settings does not succeed because the included user ID does not belong to a proxy publisher.
ENTITY_NOT_FOUND The specified entity does not exist in the system. The entity may have been deleted, for example. The path parameter indicates the field containing the entity that does not exist.
ENTITY_NOT_PERMITTED The request was not successful because permissions to access or update the specified entity do not exist.
ENTITY_STATUS_INCORRECT The specified entity or one of the specified entities has a status that conflicts with your request.
INTERNAL_ERROR An internal error occurred during validation.
INVALID_TYPE The specified entity or one of the specified entities has the incorrect data type. For example: a string was submitted although integer is the only accepted data type.
INVALID_VALUE One or more of the submitted values is not valid.
MAX_LENGTH The specified string contains too many characters.
MAXIMUM The specified number is higher than the maximum value.
MIN_LENGTH The specified string does not contain enough characters.
MINIMUM The specified number is lower than the minimum value.
OBJECT_ADDITIONAL_PROPERTIES The specified data contains additional properties that should not be included in the request.
OBJECT_MISSING_REQUIRED_PROPERTY The request does not include a required parameter. The path indicates the required parameter.
TOO_MANY_ENTITIES The entity or entities could not be added because the database has reached its maximum amount.

Status codes

Status code Description
200 The request was successful.
202 The request was successful. The action you requested has been queued.
400 The request was invalid. Usually this means the request failed validation.
401 The user was unauthenticated or does not have access to this resource.
403 The user does not have the privileges to perform this action.
404 This resource does not exist.
405 The resource exists but cannot be accessed via the specified HTTP verb.
500 An error occurred within the application.
501 The requested functionality has not yet been implemented but will be in future.
502 The request was not processed because the server is down.
503 The service is unavailable. This can occur when the IP address has been rate limited.

Authentication

You can establish authentication by completing the following steps:

  1. Generate an API key on your profile page
  2. Generate an OAuth token
  3. Authenticate requests with the OAuth token

Step 1: Generate an API key on your publisher profile page

Note: API keys can only be generated once per hour.

Complete the following steps to generate an API key:

  1. Navigate to https://system.indexexchange.com/login in a browser.
  2. Enter your publisher email address, password and then click SIGN IN.
    If authentication is successful, the Index Exchange main page appears.
  3. Within the publisher application, click your username in the top right corner and then click My Account.
    Your profile page appears.
  4. Click the Generate API Key button (API tab).
    Your API key is generated.
  5. Copy your API key and store it within a secure location.

Proceed to the next step.

Step 2: Generate an OAuth token

In this step, you will use the API key you generated to submit your credentials and generate an OAuth token.

Example request URL

https://auth.indexexchange.com/auth/oauth/token

Example request header

{
    "Content-Type": "application/json; charset=utf-8",
    "Cache-Control": "no-cache"
}

Example request body

{
    "username": "janedoe@indexexchange.com",
    "key": "se82qXk04ulmnyPfF37JHHTojxipLp4V"
}

Example JSON response

{
    "data": {
        "accessToken": "eyJ0eXAiOiJKV1QiLCJhbGciOiJIUzI1N"
    },
    "responseCode": 200
}

To generate an OAuth token, make a POST request to https://auth.indexexchange.com/auth/oauth/token with the following:

Request parameter Type Description
username string The email address registered with the account.
key string The API key you generated for the account in Step 1.

If your credentials are correct and the request is formatted properly, the response will contain an accessToken.

Response parameter Type Description
accessToken string A Bearer token string granting access to the API.

Note: Each Bearer token expires after 1 hour. After token expiration, you will need to generate a new Bearer token.

Proceed to the next step.

Step 3: Authenticate requests with the OAuth token

You can insert the accessToken you obtained into the Authorization header of every HTTPS request you submit to the API.

Example request header

{
     "Authorization": "Bearer eyJ0eXAiOiJKV1QiLCJhbGciOiJIUzI1N",
     "Cache-Control": "no-cache"
}

Include the token in the following format:

Authorization: Bearer [accessToken]

Overview

There are a variety of requests you can make to access, add, update and delete data using the REST API.

You can submit requests to access and update inventory, such as site tags and placements. You can also access and update passbacks and floors.

You can retrieve information about demand (campaigns) and earnings. You can also access and change private exchange information, such as deals and deal sections.

Inventory

Private exchange

Demand

Reporting

Campaigns

This section includes information about campaign data you can query, such as status, performance, trading desk, brands, content group and creative.

Get campaign names

Returns a list of campaign names.

Method

POST

URL structure

https://api01.indexexchange.com/api/campaigns/name

Example JSON request body

{
    "campaignID": [
        102947
    ]
}

Request parameters

Parameter Type Required? Description
campaignID integer array Required. Specifies the IDs of campaigns. You can specify one or more campaigns.

Example JSON response

{
    "data": {
        "102947": "pljXRwQN TUTDX- hq/DL"
    },
    "responseCode": 200,
    "version": "e54d17a3d69c3dda"
}

Response values

A set of key-value pairs where the key is the campaignID (string) and the value is the name of the campaign (string).

Get campaign brands

Returns a list of advertiser brand IDs associated with each campaign in the user account.

To retrieve advertiser brand names, see Get brands.

Method

POST

URL structure

https://api01.indexexchange.com/api/campaigns/brand

Example JSON request body

{
    "campaignID": [
        102947
    ]
}

Request parameters

Parameter Type Required? Description
campaignID integer array Required. Specifies the IDs of campaigns. You can specify one or more campaigns.

Example JSON response

{
    "data": {
        "102947": 6317
    },
    "responseCode": 200,
    "version": "e54d17a3d69c3dda"
}

Response values

A set of key-value pairs where the key is the campaignID (string) and the value is the associated brand ID (integer).

Get campaign content groups

Returns content groups associated with campaigns.

Method

POST

URL structure

https://api01.indexexchange.com/api/campaigns/contentgroups

Example JSON request body

{
    "campaignID": [
        596036
    ]
}

Request parameters

Parameter Type Required? Description
campaignID integer array Required. Specifies the IDs of campaigns. You can specify one or more campaigns.

Example JSON response

{
    "data": {
        "596036": [
            22,
            38,
            49
        ]
    },
    "responseCode": 200,
    "version": "e54d17a3d69c3dda"
}

Response values

A set of key-value pairs where the key is the campaignID (string) and the value is the following parameter:

Parameter Type Description
contentID integer array The IDs of the content groups associated with the campaign.

Campaign properties

Get ad units

Returns a list of ad units.

Example JSON response

{
   "data": [
      {
         "adFormatName": "Banner",
         "adFormatID": 2,
         "adUnitID": 2,
         "adUnitName": "728x90 (Banner)"
      },
      {
         "adFormatName": "Banner",
         "adFormatID": 2,
         "adUnitID": 12,
         "adUnitName": "970x250 (Billboard)"
      },
      {
         "adFormatName": "Banner",
         "adFormatID": 2,
         "adUnitID": 14,
         "adUnitName": "970x90 (Pushdown)"
      }

   ],
   "responseCode": 200,
   "version": "e54d17a3d69c3dda"
}

Method

GET

URL structure

https://api01.indexexchange.com/api/rtb/adunits

Response values

An array of objects containing the following information is returned:

Parameter Type Description
adFormatName string The name of the ad format.
adFormatID integer The ID of the ad format.
adUnitID integer The ID of the ad unit.
adUnitName string The name and dimensions of the ad unit.

Get audience segments

Returns a list of audience segments.

Example JSON response

{
   "data": [
      {
         "segmentID": 30001,
         "segmentSource": "G Media",
         "segmentName": "G Readers",
         "segmentTypeName": "First Party"
      },
      {
         "segmentID": 30002,
         "segmentSource": "G Media",
         "segmentName": "G Women",
         "segmentTypeName": "First Party"
      },
      {
         "segmentID": 30004,
         "segmentSource": "G Media",
         "segmentName": "G Finance",
         "segmentTypeName": "First Party"
      }
   ],
   "responseCode": 200,
   "version": "e54d17a3d69c3dda"
}

Method

GET

URL structure

https://api01.indexexchange.com/api/publishers/audiencesegments

Response values

An array of objects containing the following information is returned:

Parameter Type Description
segmentID integer The ID of the audience segment.
segmentSource string The source of the audience segment.
segmentName string The name of the audience segment.
segmentTypeName string The name of the audience segment type.

Get audience types

Retrieves a list of audience types.

Example JSON response

{
   "data": [
      {
         "criteriaID": 0,
         "name": "No Cookie"
      },
      {
         "criteriaID": 1,
         "name": "Cookie Enabled"
      },
      {
         "criteriaID": 2,
         "name": "Data & Cookie Enabled"
      }
   ],
   "responseCode": 200,
   "version": "e54d17a3d69c3dda"
}

Method

GET

URL structure

https://api01.indexexchange.com/api/rtb/audiencetypes

Response values

An array of objects containing the following information is returned:

Parameter Type Description
criteriaID integer The ID associated with the audience type.
name string The name of the audience type.

Get brand criteria

Returns a list of brand criteria.

Example JSON response

{
    "data": [{
        "criteriaID": 9,
        "name": "APAC Local"
    }, {
        "criteriaID": 8,
        "name": "APAC National"
    }, {
        "criteriaID": 2,
        "name": "Direct Response"
    }],
    "responseCode": 200,
    "version": "29d0734400225108"
}

Method

GET

URL structure

https://api01.indexexchange.com/api/brands/brandcriteria

Response values

An array of brand criteria objects is returned with the parameters below.

Parameter Type Description
criteriaID integer The ID of the brand criteria.
name string The name of the brand criteria.

Get brand name

Returns names of advertiser brands. Returns advertiser brand IDs and advertiser brand names.

Example JSON request body

{
   "brandID": [8, 9]
}

Example JSON response

{
    "data": {
        "8": "IBM",
        "9": "Netflix"
    },
    "responseCode": 200,
    "version": "e54d17a3d69c3dda"
}

Method

POST

URL structure

https://api01.indexexchange.com/api/brands/names

Request parameter

Parameter Type Required? Description
brandID array integer Optional Specifies the ID of the advertiser brand. When brandID is not specified, all brand IDs are returned.

Response values

Returns an object with one or more brandID keys and associated brandName values.

Get brands

Returns information about advertiser brands. Returns advertiser brand IDs, brand names & brand criteria.

Example Request URL

https://api01.indexexchange.com/api/brands/info?limit=1&offset=1

Example JSON response

{
   "data": [
       {
           "brandID": 0,
           "name": "N/A",
           "criteriaID": []
       },
       {
           "brandID": 32350,
           "name": "Waters Inn Island Resort",
           "criteriaID": [
               4
           ]
       },
       {
           "brandID": 31928,
           "name": "(DPS) Documents" ,
           "criteriaID": [
               7
           ]
       }
   ],
   "responseCode": 200,
   "version": "661319190ff66b04"
}

Method

GET

URL structure

https://api01.indexexchange.com/api/brands/info

Request parameter

Parameter Type Required? Description
limit integer Optional. Specifies the maximum number of brands to return.
offset integer Optional. Specifies the offset at which the results begin. For example: an offset of 2 skips the first brand.

Response values

An array of brand criteria objects is returned with the parameters below.

Parameter Type Description
brandID integer The ID of the brand.
name string The name of the brand criteria.
criteriaID array integer The ID of the brand criteria.

Get buyers

Retrieves a list of buyer IDs and buyer names.

Method

GET

Example Request URL

https://api01.indexexchange.com/api/buyers/name?buyerID=99

Example JSON response

{
   "data": {
      "99": "VivaKi/AOD"
   },
   "responseCode": 200,
   "version": "e54d17a3d69c3dda"
}

URL structure

https://api01.indexexchange.com/api/buyers/name?buyerID=[buyerID]

Request parameter

Parameter Type Required? Description
buyerID array integer Optional Specifies the ID of the buyer. If a buyer ID is not specified in the request, a list of buyers is returned.

Response values

Returns a list of buyer IDs and the associated buyer names. If buyerID is specified in the request, only the specified buyer ID is returned with the associated name.

Get content groups

Returns a list of content groups.

Example JSON response

{
    "data": [{
        "contentID": 52,
        "name": "App Store Landing Pages"
    }, {
        "contentID": 49,
        "name": "Images/creative - Animated"
    }, {
        "contentID": 11,
        "name": "Images/creative - Mature"
    }],
    "responseCode": 200,
    "version": "29d0734400225108"
}

Method

GET

URL structure

https://api01.indexexchange.com/api/contentgroups

Response values

An array of content group objects is returned with the following fields.

Parameter Type Description
contentID integer The ID of the content group.
name string The name of the content group.

Get country codes

Returns a list of country IDs and country names.

Example JSON response

{

   "data": [
      {
         "countryID": "AF",
         "name": "Afghanistan"
      },
      {
         "countryID": "AX",
         "name": "Aland Islands"
      },
      {
         "countryID": "ZW",
         "name": "Zimbabwe"
      }
   ],
   "version": "e54d17a3d69c3dda",
   "responseCode": 200
}

Method

GET

URL structure

https://api01.indexexchange.com/api/countries/codes

Response values

Parameter Type Description
countryID string The ID of the country.
name string The name of the country associated with the ID.

Get domain depths

Returns a list of domain depths. Domain depths are ranges that measure the number of impressions a unique visitor accesses in a sixty minute session.

Example JSON response

{
    "data": [
        {
            "id": 0,
            "name": "1 - 2"
        },
        {
            "id": 1,
            "name": "3 - 6"
        },
        {
            "id": 2,
            "name": "7 - 14"
        }
    ],
    "responseCode": 200,
    "version": "e54d17a3d69c3dda"
}      

Method

GET

URL structure

https://api01.indexexchange.com/api/rtb/domaindepths

Response values

An array of objects containing the following information is returned:

Parameter Type Description
ID integer Specifies the ID of the associated domain depth bucket.
name string Specifies the range of subdomains accessed by unique visitors.

Get DSPs

Retrieves a list of DSPs and information about the DSPs, including exchange and campaign modes.

Method

GET

Example JSON response

{
   "data": [
      {
         "dspID": 10,
         "name": "Acuity",
         "exchangeMode": 0,
         "campaignMode": 0,
         "protected": 0,
         "dealIDNumeric": 0
      },
      {
         "dspID": 41,
         "name": "AdGear",
         "exchangeMode": 0,
         "campaignMode": 0,
         "protected": 0,
         "dealIDNumeric": 0
      },
      {
         "dspID": 89,
         "name": "Vizury",
         "exchangeMode": 0,
         "campaignMode": 0,
         "protected": 0,
         "dealIDNumeric": 0
      }
   ],
   "responseCode": 200,
   "version": "e54d17a3d69c3dda"
}

URL structure

https://api01.indexexchange.com/api/dsps

Response values

Parameter Type Description
dspID integer The ID of the demand side platform.
name string The name of the demand side platform.
exchangeMode integer A boolean specifying if the DSP is associated with a placement or a deal section. 1 denotes the DSP is associated with a placement and 0 denotes the DSP is associated with a deal section.
campaignMode integer A boolean specifying if a DSP can use all of their campaigns for a specific deal. 1 denotes the DSP can use all of their campaigns for a specific deal whereas 0 denotes the DSP cannot use all of their campaigns for a specific deal.
protected integer A boolean specifying if the DSP is protected or not. 1 denotes the DSP is protected whereas 0 denotes the DSP is not protected.
dealIDNumeric integer A boolean specifying if the deal ID is numeric or if other values are allowed, such as alphabetical values. 0 denotes the deal ID allows non-numeric values whereas 1 denotes the deal ID is numeric.

Get tier timeouts

Returns a list of tier timeouts in milliseconds.

Example JSON response

{
   "data": [
      10,
      20,
      30,
      40,
      50,
      60,
      70,
      80,
      90,
      100,
      110,
      120,
      130,
      140
   ],
   "responseCode": 200,
   "version": "e54d17a3d69c3dda"
}

Method

GET

URL structure

https://api01.indexexchange.com/api/rtb/tiers/timeouts

Response values

A list of valid timeouts in milliseconds is returned.

Get trading desks

Retrievers a list of all DSPs and associated trading desks in the account

Method

GET

Example JSON response

{
   "data": [
      {
         "dspID": 2,
         "externalTradingDeskID": [
            1
         ]
      },      
      {
         "dspID": 20,
         "externalTradingDeskID": [
            1
         ]
      },
      {
         "dspID": 27,
         "externalTradingDeskID": [
            1
         ]
      }
   ],
   "responseCode": 200,
   "version": "e54d17a3d69c3dda"
}

URL structure

https://api01.indexexchange.com/api/dsps/buyers

Response values

Parameter Type Description
dspID integer The ID of the demand side platform.
externalTradingDeskID array integer The ID of the external trading desk associated with the DSP in the array object.

Campaign settings

Get auto-approval settings

Returns a list of sites that have various modes of auto-approval enabled. If you specify the ID of a particular site, information about auto-approval settings is returned for the individual site only.

Example request URL

https://api01.indexexchange.com/api/sites/autoapproval?siteID=163211

Method

GET

URL structure

https://api01.indexexchange.com/api/sites/autoapproval?siteID=[siteID]

Request parameter

Parameter Type Required? Description
siteID array integer Required. Specifies one or more sites you want to retrieve. Any specified sites must be currently active and accessible to the user.

Example JSON response

{
   "data": {
      "163211": {
         "brandAutoApprove": 1,
         "buyerAutoApprove": 1,
         "campaignAutoApprove": 1,
         "contentGroupAutoApprove": 1,
         "creativeTypeAutoApprove": 1,
         "dspAutoApprove": 1,
         "industryAutoApprove": 1
      }
   },
   "responseCode": 200,
   "version": "e54d17a3d69c3dda"
}

Response values

Parameter Type Description
brandAutoApprove integer A boolean indicating whether brand auto-approval is enabled. 1 denotes brand auto-approval is enabled whereas 0 denotes auto-approval is disabled.
buyerAutoApprove integer A boolean indicating whether buyer auto-approval is enabled. 1 denotes buyer auto-approval is enabled whereas 0 denotes auto-approval is disabled.
campaignAutoApprove integer A boolean indicating whether campaign auto-approval is enabled. 1 denotes campaign auto-approval is enabled whereas 0 denotes auto-approval is disabled.
contentGroupAutoApprove integer A boolean indicating whether content group auto-approval is enabled. 1 denotes content group auto-approval is enabled whereas 0 denotes auto-approval is disabled.
creativeTypeAutoApprove integer A boolean indicating whether creative type auto-approval is enabled. 1 denotes creative type auto-approval is enabled whereas 0 denotes auto-approval is disabled.
dspAutoApprove integer A boolean indicating whether DSP auto-approval is enabled. 1 denotes DSP auto-approval is enabled whereas 0 denotes auto-approval is disabled.
industryAutoApprove integer A boolean indicating whether industry auto-approval is enabled. 1 denotes industry auto-approval is enabled whereas 0 denotes auto-approval is disabled.

Get blacklisted campaigns

Returns all blacklisted campaigns associated with the specified site(s).

Example request URL

https://api01.indexexchange.com/api/sites/blocks/blacklists

Method

POST

URL structure

https://api01.indexexchange.com/api/sites/blocks/blacklists

Example JSON request body

{
   "siteID": [17,18],
   "campaignID": [56]
}

Request parameter

Parameter Type Required? Description
siteID array integer Required. Specifies the site ID(s) associated with the blacklisted campaign(s) you want to retrieve.
campaignID array integer Optional. Specifies the campaign ID. If this parameter is not included in the request, all blacklisted campaigns associated with the specified site ID(s) are returned.

Example JSON response

{
    "data": {
        "56": [17, 18]
    },
    "responseCode": 200,
    "version": "6f45736b796e5734"
}

Response values

Returns an object containing a list of campaignID keys and siteID values. The keys are the blacklisted campaign IDs and the values are the site IDs associated with the blacklisted campaigns.

Get blocked brand criteria

Returns all blocked brand criteria and the sites from which they are blocked.

Example request URL

https://api01.indexexchange.com/api/sites/blocks/brandcriteria

Example JSON request body

{
    "siteID": [17, 18],
    "criteriaID": [9]
}

Method

POST

URL structure

https://api01.indexexchange.com/api/sites/blocks/brandcriteria

Request parameter

Parameter Type Required? Description
siteID array integer Required. Specifies the site ID(s).
criteriaID array integer Optional. Specifies the blocked brand criteria ID(s). If this parameter is not included in the request, all blocked brand criteria IDs associated with the specified site ID(s) are returned.

Example JSON response

{
    "data": {
        "9": [17, 18]
    },
    "responseCode": 200,
    "version": "6f45736b796e5734"
}

Response values

Returns an object containing a list of criteriaID keys and siteID values. The keys are the blocked brand criteria IDs and the values are the site IDs from which the brand criteria are blocked.

Get blocked brands

Returns all blocked brands and the sites from which they are blocked.

Example JSON request body

{
   "siteID": [17,18],
   "brandID": [25582]
}

Method

POST

URL structure

https://api01.indexexchange.com/api/sites/blocks/brands

Request parameter

Parameter Type Required? Description
siteID array integer Required. Specifies the site ID(s).
brandID array integer Optional. Specifies the advertiser brand ID(s). If this parameter is not included in the request, all blocked brands associated with the specified site ID(s) are returned.

Example JSON response

{
    "data": {
        "25582": [17, 18]
    },
    "responseCode": 200,
    "version": "6f45736b796e5734"
}

Response values

Returns an object containing a list of brandID keys and siteID values. The keys are the blocked brand IDs and the values are the site IDs from which the brands are blocked.

Get blocked buyers

Returns all blocked buyers and the sites from which they are blocked.

Example request URL

https://api01.indexexchange.com/api/sites/blocks/buyers

Example JSON request body

{
   "siteID": [17,18],
   "buyerID": [99]
}

Method

POST

URL structure

https://api01.indexexchange.com/api/sites/blocks/buyers

Request parameter

Parameter Type Required? Description
siteID array integer Required. Specifies the site ID(s).
buyerID array integer Optional. Specifies the buyer ID(s). If this parameter is not included in the request, all blocked buyers associated with the specified site ID(s) are returned.

Example JSON response

{
    "data": {
        "56": [17, 18]
    },
    "responseCode": 200,
    "version": "6f45736b796e5734"
}

Response values

Returns an object containing a list of buyerID keys and siteID values. The keys are the blocked buyer IDs and the values are the site IDs from which the buyers are blocked.

Get blocked content groups

Returns all blocked content groups and the sites from which they are blocked.

Example request URL

https://api01.indexexchange.com/api/sites/blocks/contentgroups

Example JSON request body

{
    "siteID": [17, 18],
    "contentID": [52]
}

Method

POST

URL structure

https://api01.indexexchange.com/api/sites/blocks/contentgroups

Request parameter

Parameter Type Required? Description
siteID array integer Required. Specifies the site ID(s).
contentID array integer Optional. Specifies the content group ID(s). If this parameter is not included in the request, all blocked content groups associated with the specified site ID(s) are returned.

Example JSON response

{
    "data": {
        "52": [17, 18]
    },
    "responseCode": 200,
    "version": "6f45736b796e5734"
}

Response values

Returns an object containing a list of contentID keys and siteID values. The keys are the blocked content group IDs and the values are the site IDs from which the content groups are blocked.

Get blocked DSPs

Returns all blocked DSPs and the sites from which they are blocked.

Example request URL

https://api01.indexexchange.com/api/sites/blocks/dsps

Example JSON request body

{
   "siteID": [17,18],
   "dspID": [56]
}

Method

POST

URL structure

https://api01.indexexchange.com/api/sites/blocks/dsps

Request parameter

Parameter Type Required? Description
siteID array integer Required. Specifies the site ID(s).
dspID array integer Optional. Specifies the DSP ID(s). If this parameter is not included in the request, all blocked DSPs associated with the specified site ID(s) are returned.

Example JSON response

{
    "data": {
        "56": [17, 18]
    },
    "responseCode": 200,
    "version": "6f45736b796e5734"
}

Response values

Returns an object containing a list of dspID keys and siteID values. The keys are the blocked DSP IDs and the values are the site IDs from which the DSPs are blocked.

Get blocked trading desks

Returns all blocked trading desks and the sites from which they are blocked.

Example request URL

https://api01.indexexchange.com/api/sites/blocks/tradingdesks

Example JSON request body

{
    "siteID": [17, 18],
    "tradingdesks": [
        [98, 13],
        [99, 12]
    ]
}

Method

POST

URL structure

https://api01.indexexchange.com/api/sites/blocks/tradingdesks

Request parameter

Parameter Type Required? Description
siteID array integer Required. Specifies the site ID(s).
tradingdesks array Optional. The following must be specified for this parameter:

Example JSON response

{
    "data": {
        "98": {
            "13": [18]
        },
        "99": {
            "12": [17]
        }
    },
    "responseCode": 200,
    "version": "6f45736b796e5734"
}

Response values

Returns an object containing a list of dspID mapped to objects.

Each of these objects contain a list of externalTradingDeskID keys and siteID values. The keys are the blocked trading desk IDs and the values are the site IDs from which the trading desks are blocked.

Get whitelisted campaigns

Returns all whitelisted campaigns associated with the specified site(s).

Example request URL

https://api01.indexexchange.com/api/sites/blocks/whitelists

Method

POST

URL structure

https://api01.indexexchange.com/api/sites/blocks/whitelists

Example JSON request body

{
   "siteID": [17,18],
   "campaignID": [56]
}

Request parameter

Parameter Type Required? Description
siteID array integer Required. Specifies the site ID(s) associated with the whitelisted campaign(s) you want to retrieve.
campaignID array integer Optional. Specifies the campaign ID. If this parameter is not included in the request, all whitelisted campaigns associated with the specified site ID(s) are returned.

Example JSON response

{
    "data": {
        "56": [17, 18]
    },
    "responseCode": 200,
    "version": "6f45736b796e5734"
}

Response values

Returns an object containing a list of campaignID keys and siteID values. The keys are the whitelisted campaign IDs and the values are the site IDs associated with the whitelisted campaigns.

Block brand criteria

Blocks the specified brand criteria.

Example JSON request body

{
    "task": "siteBrandCriteriaBlock",
    "data": [
        {
            "value": 0,
            "siteID": [2, 3],
            "criteriaID": [50, 51]
        }
    ]
}

Example JSON response

{
    "result": "queued",
    "rqid": "56f3803150c43f0ac29f0c392aae22b9",
    "responseCode": 202,
    "version": "e54d17a3d69c3dda"
}

Method

PUT

URL structure

https://api01.indexexchange.com/api/tasks

Request parameters

Parameter Type Required? Description
task string Required. The name of the task, which must be siteBrandCriteriaBlock.
data array object Required. This object must have the following properties:
  • value (integer): Must be 0 for unblock or 1 for block.
  • siteID (array integer): An array of sites associated with the brand criteria to block.
  • criteriaID (array integer): An array of brand criteria to block.

Response values

Parameter Type Description
result string If the task queued successfully, queued will be returned. If the task failed to queue, failed will be returned.
rqid integer An identifier for the task that is queued.

Block brands

Blocks the specified brands.

Example JSON request body

{
    "task": "siteBrandBlock",
    "data": [
        {
            "value": 0,
            "siteID": [2, 3],
            "brandID": [50, 51]
        }
    ]
}

Example JSON response

{
    "result": "queued",
    "rqid": "56f3803150c43f0ac29f0c392aae22b9",
    "responseCode": 202,
    "version": "e54d17a3d69c3dda"
}

Method

PUT

URL structure

https://api01.indexexchange.com/api/tasks

Request parameters

Parameter Type Required? Description
task string Required. The name of the task to be executed, which must be siteBrandBlock.
data array object Required. This object must have the following properties:
  • value (integer): Must be 0 for unblock or 1 for block.
  • siteID (array integer): An array of sites associated with the brands to block.
  • brandID (array integer): An array of brands to block.

Response values

Parameter Type Description
result string If the task queued successfully, queued will be returned. If the task failed to queue, failed will be returned.
rqid integer An identifier for the task that is queued.

Block buyers

Blocks the specified buyers.

Example JSON request body

{
    "task": "siteBuyerBlock",
    "data": [
        {
            "value": 0,
            "siteID": [2, 3],
            "buyerID": [50, 51]
        }
    ]
}

Example JSON response

{
    "result": "queued",
    "rqid": "56f3803150c43f0ac29f0c392aae22b9",
    "responseCode": 202,
    "version": "e54d17a3d69c3dda"
}

Method

PUT

URL structure

https://api01.indexexchange.com/api/tasks

Request parameters

Parameter Type Required? Description
task string Required. The name of the task to execute. Must be siteBuyerBlock.
data array object Required. Must have the following properties:
  • value (integer): Must be 0 for unblock or 1 for block.
  • siteID (array integer): An array of sites associated with the buyers to block.
  • buyerID (array integer): An array of buyers to block.

Response values

Parameter Type Description
result string If the task queued successfully, queued will be returned. If the task failed to queue, failed will be returned.
rqid integer An identifier for the task that is queued.

Block content groups

Blocks the specified content groups.

Example JSON request body

{
    "task": "siteContentGroupBlock",
    "data": [
        {
            "value": 0,
            "siteID": [2, 3],
            "contentID": [50, 51]
        }
    ]
}

Example JSON response

{
    "result": "queued",
    "rqid": "56f3803150c43f0ac29f0c392aae22b9",
    "responseCode": 202,
    "version": "e54d17a3d69c3dda"
}

Method

PUT

URL structure

https://api01.indexexchange.com/api/tasks

Request parameters

Parameter Type Required? Description
task string Required. The name of the task to execute. Must be siteContentGroupBlock.
data array object Required. Must have the following properties:
  • value (integer): Must be 0 for unblock or 1 for block.
  • siteID (array integer): An array of sites associated with the content groups to block.
  • contentID (array integer): An array of content groups to block.

Response values

Parameter Type Description
result string If the task queued successfully, queued will be returned. If the task failed to queue, failed will be returned.
rqid integer An identifier for the task that is queued.

Block DSPs

Blocks the specified DSPs.

Example JSON request body

{
    "task": "siteDSPBlock",
    "data": [
        {
            "value": 0,
            "siteID": [2, 3],
            "dspID": [50, 51]
        }
    ]
}

Example JSON response

{
    "result": "queued",
    "rqid": "56f3803150c43f0ac29f0c392aae22b9",
    "responseCode": 202,
    "version": "e54d17a3d69c3dda"
}

Method

PUT

URL structure

https://api01.indexexchange.com/api/tasks

Request parameters

Parameter Type Required? Description
task string Required. The name of the task to execute. Must be siteContentGroupBlock.
data array object Required. Must have the following properties:
  • value (integer): Must be 0 for unblock or 1 for block.
  • siteID (array integer): An array of sites associated with the content groups to block.
  • dspID (array integer): An array of DSPs to block.

Response values

Parameter Type Description
result string If the task queued successfully, queued will be returned. If the task failed to queue, failed will be returned.
rqid integer An identifier for the task that is queued.

Block trading desks

Blocks the specified trading desks.

Example JSON request body

{
    "task": "siteTradingDeskBlock",
    "data": [
        {
            "value": 0,
            "siteID": [2, 3],
            "tradingDesk": [
                [1, 50],
                [2, 51]
            ]
        }
    ]
}

Example JSON response

{
    "result": "queued",
    "rqid": "56f3803150c43f0ac29f0c392aae22b9",
    "responseCode": 202,
    "version": "e54d17a3d69c3dda"
}

Method

PUT

URL structure

https://api01.indexexchange.com/api/tasks

Request parameters

Parameter Type Required? Description
task string Required. The name of the task to execute. Must be siteTradingDeskBlock.
data array object Required. Must have the following properties:
  • value (integer): Must be 0 for unblock or 1 for block.
  • siteID (array integer): An array of sites associated with the brand(s) to block.
  • tradingDesk (array integer): An array of [dspID, externalTradingDeskID] tuples identifying the trading desks to block.

Response values

Parameter Type Description
result string If the task queued successfully, queued will be returned. If the task failed to queue, failed will be returned.
rqid integer An identifier for the task that is queued.

Update site settings

Updates site settings.

Example JSON request body

{
    "task": "siteUpdate",
    "data": [
        {
            "siteID": [2, 3],
            "brandAutoApprove": 0,
            "buyerAutoApprove": 1,
            "dspAutoApprove": 1
        }
    ]
}

Example JSON response

{
    "result": "queued",
    "rqid": "56f3803150c43f0ac29f0c392aae22b9",
    "responseCode": 202,
    "version": "e54d17a3d69c3dda"
}

Method

PUT

URL structure

https://api01.indexexchange.com/api/tasks

Request parameters

Parameter Type Required? Description
task string Required. The name of the task to execute. Must be siteUpdate.
data array object Required. Must have the following property:Optionally provide the following properties:
  • brandAutoApprove (integer): Provide 1 to auto approve; 0 otherwise.
  • buyerAutoApprove (integer): Provide 1 to auto approve; 0 otherwise.
  • campaignAutoApprove (integer): Provide 1 to auto approve; 0 otherwise.
  • contentGroupAutoApprove (integer): Provide 1 to auto approve; 0 otherwise.
  • creativeTypeAutoApprove (integer): Provide 1 to auto approve; 0 otherwise.
  • dspAutoApprove (integer): Provide 1 to auto approve; 0 otherwise.
  • industryAutoApprove (integer): Provide 1 to auto approve; 0 otherwise.
  • semiTransparentURL (string): Provide a semi-transparent URL to associate with the sites.

Response values

Parameter Type Description
result string If the task queued successfully, queued will be returned. If the task failed to queue, failed will be returned.
rqid integer An identifier for the task that is queued.

Deals

Get deals

Returns a list of the publisher’s deals and information about each deal.

Example JSON Response

{
    "data": [
        {
            "userID": 182490,
            "userDealID": 4476,
            "dspID": 4,
            "name": "kDtCcaJdd_FdvD_GLn_1",
            "dealType": 0,
            "auctionType": "second",
            "rate": "4.96",
            "status": "A",
            "startDate": "2014-11-20",
            "endDate": "2015-12-31",
            "dealID": "5011202014",
            "priority": 5,
            "openMarket": 0,
            "payout": 1,
            "humanVerification": 1,
            "sectionID": [6619],
            "buyerID": [1]
        },
        {
            "userID": 182490,
            "userDealID": 14649,
            "dspID": 3,
            "name": "og_W2h_cQkDsswUx_XYY_sfBj2015",
            "dealType": 1,
            "auctionType": "second",
            "rate": "6.36",
            "status": "A",
            "startDate": "2015-07-16",
            "endDate": "2015-12-31",
            "dealID": "6607162015",
            "priority": 5,
            "openMarket": 0,
            "payout": 1,
            "humanVerification": 1,
            "sectionID": [6619]
        },
        {
            "userID": 182490,
            "userDealID": 14650,
            "dspID": 57,
            "name": "kk_x2z_nAxAgpLhB_yaa_sk_Lxct2015",
            "dealType": 1,
            "auctionType": "second",
            "rate": "6.24",
            "status": "A",
            "startDate": "2015-07-16",
            "endDate": "2015-12-31",
            "dealID": "6707162015",
            "priority": 5,
            "openMarket": 0,
            "payout": 1,
            "humanVerification": 1,
            "sectionID": [7662],
            "buyerID": [1]
        }
    ],
    "responseCode": 200,
    "version": "e54d17a3d69c3dda"
}

Method

GET

URL structure

https://api01.indexexchange.com/api/publishers/deals

Response values

Returns an array of objects with the following properties:

Parameter Type Description
userID integer The ID of the user that can access the associated information.
userDealID integer The ID systematically assigned to identify the user-deal association.
dspID integer The ID of the DSP.
name string The name of the deal.
dealType integer The ID of the deal type. Possible values include 1 (one-to-many deal type) and 0 (one-to-one deal type).
auctionType string The auction type. Possible values include first, second and fixed.
rate string The floor rate of the deal. The format of the floor rate includes a decimal and two decimal places regardless of the publisher’s set currency. For example: 1.99.
status string The status of the deal. Possible statuses include A (active), D (deactivated or deleted) and N (new).
startDate string The start date of the deal in the following format: YYYY-MM-DD.
endDate string The end date of the deal in the following format: YYYY-MM-DD.
dealID string The ID the user assigned to the deal.
priority integer The priority of the deal. Possible values can be from 1 (lowest priority) to 10 (highest priority).
openMarket integer A boolean indicating whether the deal can compete in the open market. If 0 is returned, the deal is private whereas if 1 is returned, the deal is open to the market competition.
payout integer If 1 is returned, payout is enabled whereas if 0 is returned, payout is disabled. Impressions for the deal do not generate any revenue when payout is disabled.
humanVerification integer The value is 1 if auto-approval is not enabled and 0 if auto-approval is enabled. A value is returned only if the specified DSP and deal are active.
placementID array integer The IDs of the placements associated with the deal.
sectionID array integer The IDs of the deal sections associated with the deal.
buyerID array integer The IDs of the buyers involved in the deal.

Create a deal

Adds a deal according to the information you include in the request.

Example JSON Request body

{
    "dealID": "456123",
    "dspID": 3,
    "name": "deal 1",
    "dealType": 0,
    "startDate": "2015-09-20",
    "endDate": "2015-10-07",
    "auctionType": "fixed",
    "rate": "1.06",
    "placementID": [720, 718, 719]
}

Example JSON Response

{
    "userID": 100007,
    "userDealID": [1052]
}

Method

PUT

URL structure

https://api01.indexexchange.com/api/publishers/deals

Request parameters

Parameter Type Required? Description
dealID string Required. Specifies the ID the user assigned to the deal. The specified value must be 1 to 255 characters.
dspID integer Required. The ID of the DSP.
name string Required. The name of the deal.
dealType integer Optional. The ID of the deal type. Possible values include 1 (one-to-many deal type) and 0 (one-to-one deal type).
startDate string Required. Specifies the start date of the deal in the following format: YYYY-MM-DD. The specified date cannot be earlier than today’s date.
endDate string Required. Specifies the end date of the deal in the following format: YYYY-MM-DD. The specified date cannot be earlier than startDate.
auctionType string Required. Specifies the type of auction. Possible values include first, second and fixed. This parameter is case-sensitive.
rate string Required. Specifies the floor rate of the deal. The format of the floor rate includes a decimal and two decimal places. The maximum value is 99999.99.
priority integer Optional. The priority of the deal. Possible values can be from 1 (lowest priority) to 10 (highest priority). If priority is not specified, the deal is automatically assigned a priority of 1 (the default).
openMarket integer Optional. Specifies whether the deal can compete in the open market. Provide 0 for a private deal and 1 for an open deal that is open to market competition. If openMarket is not specified, openMarket is automatically assigned a value of 0 (the default).
payout integer Optional. Specifies whether payout is enabled. 1 specifies payout is enabled whereas 0 specifies payout is disabled. Impressions for the deal do not generate any revenue when payout is disabled. If payout is not specified, payout is automatically assigned a value of 1 (the default).
humanVerification integer Optional. Specifies whether auto-approval is enabled. Specify 0 to enable auto-approval and turn human verification off. Specify 1 to disable auto-approval and turn human verification on. If humanVerification is not specified, payout is automatically assigned a value of 1 (the default).
placementID array integer Required if exchangeMode of the DSP is 1. Not allowed if exchangeMode is 0. Specifies an array indicating one or more placements. Any specified placements must currently be active and accessible to the user.
sectionID array integer Required if exchangeMode of the DSP is 0. Not allowed if exchangeMode is 1. Specifies the ID of the deal section associated with the deal. Any specified sections must currently be active and accessible to the user.
buyerID array integer Required if the exchangeMode of the DSP is 1. Optional if the DSP’s exchangeMode is 0. The IDs of the buyers involved in the deal.

Response values

Parameter Type Description
userDealID array integer An array with a single ID systematically assigned to identify the user-deal association.

Update a deal

Updates a publisher’s deal.

Example JSON request body

{
    "userDealID": 14650,
    "name": "changed deal"
}

Example JSON Response

{
    "userID": 100007,
    "userDealID": [1052]
}

Method

PATCH

URL structure

https://api01.indexexchange.com/api/publishers/deals

Request parameter

Parameter Type Required? Description
userDealID integer Required. The ID(s) systematically assigned to identify the user-deal association(s).
name string Optional. Specifies the name of the deal.
status string Optional. Specifies the status of the deal. Possible statuses include A (active) and P (paused).
startDate string Optional. Specifies the start date of the deal in the following format: YYYY-MM-DD. The specified date cannot be earlier than today’s date.
endDate string Optional. Specifies the end date of the deal in the following format: YYYY-MM-DD. The specified date cannot be earlier than startDate.
rate string Optional. Specifies the floor rate of the deal. The format of the floor rate includes a decimal and two decimal places. The maximum value is 99999.99.
auctionType string Optional. Specifies the type of auction. Possible values include first, second and fixed. This parameter is case-sensitive.
priority integer Optional. The priority of the deal. Possible values can be from 1 (lowest priority) to 10 (highest priority).
openMarket integer Optional. Specifies whether the deal can compete in the open market. Provide 0 for a private deal and 1 for an open deal that is open to market competition.
payout integer Optional. A boolean indicating whether payout is enabled. If 1 is returned, payout is enabled whereas if 0 is returned, payout is disabled. Impressions for the deal do not generate any revenue when payout is disabled.
placementID array integer Optional if exchangeMode of the DSP is 1. Not allowed if exchangeMode is 0. The ID of the placement associated with the deal. Any specified placements must currently be active and accessible to the user.
sectionID array integer Optional if exchangeMode of the DSP is 0. Not allowed if exchangeMode is 1. The ID of the deal section associated with the deal. Any specified sections must currently be active and accessible to the user.
buyerID array integer Optional. The ID of the buyer involved in the deal. Any specified value replaces the existing value.

Response values

Parameter Type Description
userID integer The ID of the user that can access the associated information.
userDealID array integer An array with a single ID systematically assigned to identify the user-deal association.

Delete a deal

Deletes a publisher’s deal.

Example Request URL

https://api01.indexexchange.com/api/publishers/deals?userDealID=14650

Example JSON response

{
    "data": {
        "userID": 182490,
        "deals": [
            {
                "userDealID": 14650
            }
        ]
    },
    "responseCode": 200,
    "version": "e54d17a3d69c3dda"
}

Method

DELETE

URL structure

https://api01.indexexchange.com/api/publishers/deals?userDealID=[userDealID]

Request parameters

Parameter Type Required? Description
userDealID integer Required. Specifies the ID that was systematically assigned to identify the user-deal association.

Response values

Parameter Type Description
userID integer The ID of the user that can access the associated information.
deals array object An array with a single object with the following property:
  • userDealID (integer): The ID systematically assigned to identify the user-deal association.

Get publisher deal information

Returns a list of the publisher’s deals and information about each deal.

Example JSON response

{
    "data": [
        {
            "userDealID": 4476,
            "name": "kDtCcaJdd_FdvD_GLn_1",
            "status": "A"
        },
        {
            "userDealID": 6402,
            "name": "GSxcqcqQN_XWV_PGQ_1",
            "status": "A"
        },
        {
            "userDealID": 16288,
            "name": "qSeVN_rQVvWxDpn_dJ_EzS 2015",
            "status": "A"
        },
        {
            "userDealID": 16588,
            "name": "Ji_a2x_vFhiCSmMz_Bod_sKVO2015",
            "status": "A"
        },
        {
            "userDealID": 16807,
            "name": "JbMTbph_a2R_KJxWcvjQS_hXH_RsyKxP2015",
            "status": "A"
        }
    ],
    "responseCode": 200,
    "version": "e54d17a3d69c3dda"
}

Method

GET

URL structure

https://api01.indexexchange.com/api/publishers/deals/info

Response values

Returns an array of objects with the following properties:

Parameter Type Description
userDealID integer The ID systematically assigned to identify the user-deal association.
name string Specifies the name of the deal.
status string The status of the deal. Possible statuses include A (active), D (deactivated) and N (new).

Get deal configuration information

Returns the deal configuration settings, including deal mode and auto-approval settings.

Example Request URL

https://api01.indexexchange.com/api/deals/config?dspID=4&dealID=5011202014

Example JSON Response

{
    "data": {
        "dealMode": 0,
        "humanVerification": 1
    },
    "responseCode": 200,
    "version": "e54d17a3d69c3dda"
}

Method

GET

URL structure

https://api01.indexexchange.com/api/publishers/deals/config?dspID=[dspID]&dealID=[dealID]

Request parameter

Parameter Type Required? Description
dspID integer Required. Specifies the ID of the DSP.
dealID string Required. Specifies the ID of the deal. The specified value must be 1 to 255 characters.

Response values

Parameter Type Description
dealMode integer The value is 1 if the campaign mode is one-to-many or 0 if the campaign mode is one-to-one (the default). A value is returned only if the specified DSP and deal are active.
humanVerification integer The value is 1 if auto-approval is not enabled and 0 if auto-approval is enabled. A value is returned only if the specified DSP and deal are active.

Get deal custom field definition

Returns information about custom field definitions.

Example Request URL

https://api01.indexexchange.com/api/publishers/customFields/definitions?metric=deal

Example JSON Response

{
    "data": [
        {
            "id": 0,
            "status": "A",
            "title": "Representative",
            "type": "singleSelectDropdown",
            "values": [
                {
                    "id": 0,
                    "status": "A",
                    "title": "John Doe"
                }
            ],
            "userID": 100007,
            "metric": "deal"
        },
        {
            "id": 1,
            "status": "A",
            "title": "Contact",
            "type": "singleSelectDropdown",
            "values": [],
            "userID": 100007,
            "metric": "deal"
        }
    ],
    "responseCode": 200,
    "version": "9d81955d6d478187"
}

Method

GET

URL structure

https://api01.indexexchange.com/api/publishers/customfields/definitions?metric=[metricID]

Request parameters

Parameter Type Required? Description
metric string Required. The value should be deal.

Response values

An array of custom field definition objects is returned with the following fields.

Parameter Type Description
userID integer The ID of the user that can access the associated information.
metric string The associated deal.
id integer The dealID of the definition.
status string The status of the definition.
title string The title of the definition
type string The definition type.
values array object Each object contains the following:
  • id (integer): The ID of the selection.
  • title (string): The title of the selection
  • status (string): The status of the selection.

Get deal custom field value

Returns information about custom field data.

Example Request Body

{
    "metric": "deal"
}

Example JSON Response

{
    "data": [
        {
            "id": 1,
            "metric": "deal",
            "userID": 100007,
            "selections": [
                {
                    "definition": 0,
                    "selection": 0
                }
            ]
        },
        {
            "id": 6009,
            "metric": "deal",
            "userID": 100007,
            "selections": [
                {
                    "definition": 0,
                    "selection": 1
                }
            ]
        }
    ],
    "responseCode": 200,
    "version": "9d81955d6d478187"
}

Method

POST

URL structure

https://api01.indexexchange.com/api/publishers/customfields/selections

Request parameters

Parameter Type Required? Description
metric string Required. The value should be deal.
id array integer Optional. The deal ID of the definition. If dealID is not specified, a list of custom field selections are returned.

Response values

An array of custom fields data objects is returned with the following fields.

Parameter Type Description
userID integer The ID of the user that can access the associated information.
metric string The associated deal.
id integer The dealID of the definition.
selections array object This object contains an array of the following:
  • definition (integer): Specifies the ID of definition.
  • selection (Integer): Specifies the ID of selection.

Update a deal custom field value

Updates the specified custom field selection.

Example Request Body

{
    "metric": "deal",
    "id": 6009,
    "selections": [
        {
            "definition": 0,
            "selection": 0
        }
    ]
}

Example JSON Response

{
    "data": {
        "userID": 100007,
        "metric": "deal",
        "id": [
            6009
        ]
    },
    "responseCode": 200,
    "version": "9d81955d6d478187"
}

Method

PUT

URL structure

https://api01.indexexchange.com/api/publishers/customfields/selections

Request parameters

Parameter Type Required? Description
metric string Required. The value should be deal.
id integer Required. The dealID of the definition.
selections array object Required. This object contains an array of the following:
  • definition (integer): Required. Specifies the ID of definition.
  • selection (Integer): Required. Specifies the ID of selection.

Response values

Parameter Type Description
userID integer The ID of the user that can access the associated information.
metric string The associated deal.
id array integer An array containing the deal IDs of the definition type.

Deal sections

Get deal sections

Returns information about all deal sections.

Example JSON response

{
    "data": [
        {
            "userID": 100005,
            "sectionID": 6619,
            "name": "fdhbkDzDX_kzN",
            "percent": 100,
            "entireSite": 1,
            "siteID": [
                159536,
                159855,
                160174
            ]
        },
        {
            "userID": 100005,
            "sectionID": 6878,
            "name": "hJw_DmN",
            "percent": 100,
            "entireSite": 1,
            "siteID": [
                159536,
                160174
            ]
        },
        {
            "userID": 100005,
            "sectionID": 7662,
            "name": "pMKiqphoe_nNZ_vu",
            "percent": 100,
            "entireSite": 1,
            "siteID": [
                159536,
                159855,
                160174,
                160175
            ],
            "countryRestrictions": [
                "CA"
            ]
        }
    ],
    "responseCode": 200,
    "version": "e54d17a3d69c3dda"
}

Method

GET

URL structure

https://api01.indexexchange.com/api/publishers/sections

Response values

An array of deal section objects, ordered by sectionID, is returned with the following fields:

Parameter Type Description
userID integer The ID of the user account that has access to the deal section.
sectionID integer The ID of the associated deal section.
name string The name of the deal section.
percent integer The coverage percentage the deal section has.
entireSite integer A binary that indicates whether the main domain must be matched (partially or in full) for the advertisement to serve. 0 indicates a full or partial URL match is required and 1 indicates a URL match is not required.
matches array object This array should contain one or more values if the entireSite parameter is set to 0. The objects in the array contain a URL and match type. The matchType parameter can contain a value of 1, which represents a full match type, or 2, which represents a partial match type.
siteID array integer The ID of the associated sites.
frequencyRestrictions array integer Displays any frequency restrictions by ID.
audienceRestrictions array integer Displays any audience restrictions by ID.
countryRestrictions array string Displays any country restrictions by ID.
adUnitRestrictions array integer Displays any ad Unit restrictions by ID.

Create a deal section

Adds a deal section.

Example JSON request body

{
    "name": "dvfs",
    "percent": 10,
    "entireSite": 0,
    "matches": [
        {
            "url": "http://cofdsf.uk",
            "matchType": 2
        }
    ],
    "siteID": [
        159536
    ],
    "frequencyRestrictions": [
        1
    ],
    "adUnitRestrictions": [
        4,
        5,
        12
    ]
}

Example JSON Response

{
    "data": {
        "userID": 100017,
        "sectionID": [
            8875
        ]
    },
    "responseCode": 200,
    "version": "6f45736b796e5734"
}

Method

PUT

URL structure

https://api01.indexexchange.com/api/publishers/sections

Request parameters

Parameter Type Required? Description
name string Required. Specifies the name of the deal section. The specified value must be 1 to 100 characters in length.
percent integer Required. Specifies the percent of coverage associated with the deal section. The specified value must be a number from 1 to 100.
entireSite integer Required. Indicates whether the main domain must be matched (partially or fully) for the advertisement to serve. 0 indicates a full or partial URL match is required and 1 indicates a URL match is not required. If you specify 0 the matches parameter must also be specified.
matches array object Only required if the entireSite parameter is set to 0. The parameter must not be included if entireSite is 1. An array of match objects. For each match object, define a URL and match type as follows: {“matchType”: [matchType], “url”: “[url]”}. For the matchType parameter, 1 represents a full match type and 2 represents a partial match type.
siteID array integer Required. The ID of the associated sites. The array cannot contain any duplicates.
frequencyRestrictions array integer Optional. Identifies any frequency restrictions by ID.
audienceRestrictions array integer Optional. Identifies any audience restrictions by ID.
countryRestrictions array string Optional. Identifies any country restrictions by ID.
adUnitRestrictions array integer Optional. Identifies any ad unit restrictions by ID.

Response values

Parameter Type Description
userID integer The ID of the user account that has access to the deal section.
sectionID array integer An array with a single ID that is associated with the new deal section.

Update a deal section

Updates specified information about a deal section.

Example JSON request body

{
    "sectionID": 6619,
    "name": "dvfs",
    "percent": 10,
    "entireSite": 0,
    "matches": [
        {
            "url": "http://cofdsf.uk",
            "matchType": 2
        }
    ]
}

Example JSON Response

{
    "data": {
        "userID": 182490,
        "sectionID": [
            6619
        ]
    },
    "responseCode": 200,
    "version": "e54d17a3d69c3dda"
}

Method

PATCH

URL structure

https://api01.indexexchange.com/api/publishers/sections

Request parameters

Parameter Type Required? Description
sectionID integer Required. Specifies the ID of the associated deal section.
name string Optional. Specifies the name of the deal section. The specified value must be 1 to 100 characters in length. The string must not contain any new lines, HTML tags or HTML entities.
percent integer Optional. Specifies the percent of coverage associated with the deal section. The specified value must be a number between 1 and 100.
entireSite integer Optional. Indicates whether the main domain must be matched (partially or fully) for the advertisement to serve. 0 indicates a full or partial URL match is required and 1 indicates a URL match is not required. If you specify 0, the matches parameter must also be specified.
matches array object Required if you are changing entireSite from 1 to 0. Do not include this object in your request if entireSite is 1. For each matches object in the array, define a URL and match type as follows: {“matchType”: [matchType], “url”: “[url]”}. For the matchType parameter, 1 represents a full match type and 2 represents a partial match type.
siteID array integer Optional. The ID of the associated sites. The array can contain a maximum of 5000 items and cannot contain any duplicates.
frequency restrictions array integer Optional. Identifies any frequency restrictions by ID.
audienceRestrictions array integer Optional. Identifies any audience restrictions by ID.
countryRestrictions array string Optional. Identifies any country restrictions by ID.
adUnitRestrictions array integer Optional. Identifies any ad unit restrictions by ID.

Response values

Parameter Type Description
userID integer The ID of the user account that has access to the deal section.
sectionID array integer An array with a single ID that is associated with the deal section.

Delete a deal section

Deletes a deal section.

Example request URL

https://api01.indexexchange.com/api/publishers/sections?sectionID=6619

Example JSON response

{
    "data": {
        "userID": 182490,
        "sections": [
            {
                "sectionID": 6619
            }
        ]
    },
    "responseCode": 200,
    "version": "e54d17a3d69c3dda"
}

Method

DELETE

URL structure

https://api01.indexexchange.com/api/publishers/sections?sectionID=[sectionID]

Request parameters

Parameter Type Required? Description
sectionID integer Required. Specifies the ID of the deal section you want to delete.

Response values

Parameter Type Description
userID integer The ID of the user account that has access to the deal section.
sections array object An array with a single object containing the following property:
  • sectionID (integer): The ID of the deleted deal section.

Reporting

Get earnings statistics

Returns statistics about a publisher’s open market earnings.

Method

POST

URL structure

https://api01.indexexchange.com/api/publishers/stats/earnings/open

Example JSON request body

{
    "filters": {
        "startDate": "2014-10-01",
        "endDate": "2015-09-30",
        "adUnitID": [
            2
        ]
    },
    "aggregation": "day"
}

Request parameter

Parameter Type Required? Description
filters object Required. You can specify the following filter parameters:
  • startDate (string): Required. Defines the start date of the earnings in YYYY-MM-DD format. For example: 2014-09-22.
  • endDate (string): Required. Defines the end date of the earnings in YYYY-MM-DD format. For example: 2015-09-22.
  • siteID (array integer): Optional. Defines the ID(s) of the site(s). Any specified site(s) must be active and accessible to the current user. For example: { “siteID”: [311425, 311436, 314445] }
  • placementID (array integer): Optional. Defines the ID(s) of the placement(s). For example: { “placementID”: [432465, 472467, 412461] }
  • adUnitID (array integer): Optional. Defines the ID(s) of the ad unit(s). For example: { “adUnitID”: [1, 5, 8] }
aggregation string Required. Specifies how you want to aggregate the return information with one of the following values:

Example JSON response

{
    "data": [
        {
            "aggregateID": "2014-11-21",
            "earnings": 5688,
            "impressions": 8
        },
        {
            "aggregateID": "2014-11-22",
            "earnings": 3648,
            "impressions": 6
        },
        {
            "aggregateID": "2015-09-20",
            "earnings": 12782143,
            "impressions": 58463
        },
        {
            "aggregateID": "2015-09-21",
            "earnings": 1111469,
            "impressions": 4649
        }
    ],
    "responseCode": 200,
    "version": "e54d17a3d69c3dda"
}

Response values

Returns an array of objects ordered as follows:

Parameter Type Description
aggregateID The ID of the aggregate, which corresponds to the aggregation parameter you specified in the request.
  • day (string): Returns the date in YYYY-MM-DD format. For example: 2015-05-29.
  • month (string): Returns the month in YYYY-MM format. For example: 2015-09.
  • siteID (integer): Returns the ID of the site.
  • tierID (integer): Returns the ID of the tier.
impressions integer The number of impressions.
earnings number The returned integer can be multiplied by 0.00001 to get the publisher’s earnings in their selected currency.

Get earnings statistics by hour

Returns statistics about a publisher’s open market earnings by hour.

Method

POST

URL structure

https://api01.indexexchange.com/api/publishers/stats/earnings/open/hourly

Example JSON request body

{
    "filters": {
        "date": "2015-09-14",
        "placementID": [1, 2, 3]
    },
    "aggregation": "hour"
}

Request parameters

Parameter Type Required? Description
filters object Required. You can specify the following filter parameters:
  • date (string): Required. Defines the date of the earnings statistics in YYYY-MM-DD format. For example: 2014-09-22.
  • siteID (array integer): Optional. Defines the ID(s) of the site(s). Any specified site(s) must be active and accessible to the current user. For example: { siteID: [311425, 311436, 314445] }
  • placementID (array integer): Optional. Defines the ID(s) of the placement(s). For example: { placementID: [432465, 472467, 412461] }
aggregation string Required. hour must be specified to aggregate the return information by hour.

Example JSON response

{
    "data": [
        {
            "aggregateID": "2015-09-30:10",
            "impressions": 5227,
            "earnings": 56421
        },
        {
            "aggregateID": "2015-09-30:11",
            "impressions": 6644,
            "earnings": 67516
        }
    ],
    "version": "e54d17a3d69c3dda",
    "responseCode": 200
}

Response values

Returns an array of objects ordered as follows:

Parameter Type Description
aggregateID The ID of the aggregate, which corresponds to the aggregation parameter you specified in the request.
  • hour (string): Returns the time in YYYY-MM-DD-HH format according to the 24 hour clock convention. For example: 2015-05-29:00 denotes midnight whereas 2015-05-29:14 denotes 2 pm.
impressions integer The number of impressions.
earnings integer The returned integer can be multiplied by 0.00001 to get the publisher’s earnings in their selected currency.

Get eligible campaigns

Returns campaigns that are eligible to serve on the specified site for the specified month.

Method

POST

URL structure

https://api01.indexexchange.com/api/sites/mappings/campaigns

Example JSON request body

{
    "siteID": [5, 4],
    "month": "2015-04",
    "view": "expandable"
}

Request parameters

Parameter Type Required? Description
siteID array integer Required. Specifies one or more sites you want to retrieve. Any specified sites must be currently active and accessible to the user. When this parameter is not included, information is returned for all active sites.
month string Required. Specifies the month of campaigns you want to retrieve. The accepted format is YYYY-MM.
Note: The current month cannot be specified.
view string Required. Specifies a category of campaigns to return. Accepted values are as follows:
  • expandable (expandable campaigns)
  • overlay (overlay/voken campaigns)
  • all (all campaigns)
  • french (French campaigns)
  • rtb (RTB campaigns)

Example JSON response

{
    "data": [{
        "campaignIDs": [34, 56, 67, 78, 89]
    }],
    "responseCode": 200,
    "version": "e54d17a3d69c3dda"
}

Response values

Returns an array of integers as follows:

Parameter Type Description
campaignID integer The ID of the campaign associated with the month specified in the request.

Get losing bids

Returns information about losing bids, such as associated campaigns, impressions and earnings.

Method

POST

URL structure

https://api01.indexexchange.com/api/sites/stats/bids/losing

Example JSON request body

{
    "userID": 100017,
    "month": "2015-04",
    "siteID": [6, 5],
    "campaignID": [4, 7, 2]
}

Request parameters

Parameter Type Required? Description
month string Required. Specifies the month of losing bids you want to retrieve. The accepted format is YYYY-MM.
siteID array integer Required. Specifies the site(s) associated with the losing bids you want to retrieve.
campaignID array integer Optional. Specifies one or more campaigns you want to retrieve.

Example JSON response

{
    "data": [{
        "campaignID": 2,
        "impressions": 246,
        "earnings": 123.56
    }, {
        "campaignID": 7,
        "impressions": 333,
        "earnings": 852.31
    }],
    "responseCode": 200,
    "version": "e54d17a3d69c3dda"
}

Response values

Returns an array of objects ordered as follows:

Parameter Type Description
campaignID integer The ID of the losing campaign.
impressions integer The number of impressions in the campaign.
earnings float The returned integer can be multiplied by 0.00001 to get the publisher’s earnings in their selected currency.

Get private earnings statistics

Returns statistics about a publisher’s private earnings.

Method

POST

URL structure

https://api01.indexexchange.com/api/publishers/stats/earnings/private

Example JSON Request

{
    "filters": {
        "startDate": "2015-09-14",
        "endDate": "2015-11-14"
    },
    "aggregation": "day"
}

Request parameters

Parameter Type Required? Description
filters object Required. You can specify the following filter parameters:
  • startDate (string): Required. Defines the start date of the earnings in YYYY-MM-DD format. For example: 2014-09-22.
  • endDate (string): Required. Defines the end date of the earnings in YYYY-MM-DD format. For example: 2015-09-22.
  • siteID (array integer): Optional. Defines the ID(s) of the site(s). Any specified site(s) must be active and accessible to the current user. For example: { siteID: [311425, 311436, 314445] }
  • placementID (array integer): Optional. Defines the ID(s) of the placement(s). For example: { placementID: [432465, 472467, 412461] }
  • adUnitID (array integer): Optional. Defines the ID(s) of the ad unit(s). For example: { adUnitID: [1, 5, 8] }
  • userDealID (array integer): Defines the ID of the user deal. The specified deal must be accessible to the current user.
aggregation string Required. Specify how you want to aggregate the return information with one of the following values:

Example JSON response

{
    "data": [
        {
            "aggregateID": "2015-09-14",
            "earnings": 5583970,
            "impressions": 14861
        },
        {
            "aggregateID": "2015-09-15",
            "earnings": 11771784,
            "impressions": 28645
        },
        {
            "aggregateID": "2015-09-16",
            "earnings": 9493674,
            "impressions": 28482
        },
        {
            "aggregateID": "2015-09-17",
            "earnings": 8893907,
            "impressions": 24164
        },
        {
            "aggregateID": "2015-09-18",
            "earnings": 5953413,
            "impressions": 20814
        },
        {
            "aggregateID": "2015-09-19",
            "earnings": 8592667,
            "impressions": 26010
        },
        {
            "aggregateID": "2015-09-20",
            "earnings": 9602195,
            "impressions": 30232
        },
        {
            "aggregateID": "2015-09-21",
            "earnings": 798806,
            "impressions": 2846
        }
    ],
    "responseCode": 200,
    "version": "e54d17a3d69c3dda"
}

Response values

Returns an array of objects ordered by the aggregateID object as follows:

Parameter Type Description
aggregateID The ID of the aggregate, which corresponds to the aggregation parameter you specified in the request.
  • day (string): Returns the date in YYYY-MM-DD format.
  • month (string): Returns the date in YYYY-MM format.
  • siteID (integer): Returns the associated site ID.
  • tierID (integer): Returns the associated tier ID.
  • userDealID (integer): Returns the associated user deal ID.
earnings number The returned integer can be multiplied by 0.00001 to get the publisher’s earnings in their selected currency.
impressions integer The number of impressions.

Get private earnings statistics by hour

Returns statistics about a publisher’s private earnings by hour.

Example JSON request

{
    "filters": {
        "date": "2014-10-21"
    },
    "aggregation": "hour"
}

Method

POST

URL structure

https://api01.indexexchange.com/api/publishers/stats/earnings/private/hourly

Request parameters

Parameter Type Required? Description
filters object Optional. You can specify the following filter parameters:
  • date (string): Required. Defines the date of the earnings statistics in YYYY-MM-DD format. For example: 2014-09-22
  • siteID (array integer): Optional. Defines the ID(s) of the site(s). Any specified site(s) must be active and accessible to the current user. For example: { siteID: [311425, 311436, 314445] }
  • placementID (array integer): Optional. Defines the ID(s) of the placement(s). For example: { placementID: [432465, 472467, 412461] }
aggregation string Required. hour must be specified to aggregate the return information by hour.

Example of JSON Response

{
    "data": [
        {
            "aggregateID": "2014-10-21:11",
            "impressions": 1024,
            "earnings": 23246
        }
    ],
    "responseCode": 200,
    "version": "e54d17a3d69c3dda"
}

Response values

Returns an array of objects ordered by the aggregateID object as follows:

Parameter Type Description
aggregateID The ID of the aggregate, which corresponds to the aggregation parameter you specified in the request.
  • hour (string): Returns the time in YYYY-MM-DD-HH format according to the 24 hour clock convention. For example: 2015-05-29:00 denotes midnight whereas 2015-05-29:14 denotes 2 pm.
impressions integer The number of impressions.
earnings number The returned integer can be multiplied by 0.00001 to get the publisher’s earnings in their selected currency.

Get served and deleted deals

Returns all of deals in the user account that have served and been deleted.

Example JSON response

{
    "data": [
        6402,
        7052,
        7053,
        14640,
        14649,
        14650,
        16807
    ],
    "responseCode": 200,
    "version": "e54d17a3d69c3dda"
}

Method

GET

URL structure

https://api01.indexexchange.com/api/publishers/stats/earnings/served/deleted/deals

Response values

Returns an array of IDs associated with deals:

Parameter Type Description
userDealID integer The ID associated with the deal.

Get served and deleted placements

Returns all of the placements in the user account that have served and been deleted.

Example JSON response

{
    "data": [
        9100,
        9101,
        9355,
        9589
    ],
    "responseCode": 200,
    "version": "e54d17a3d69c3dda"
}

Method

GET

URL structure

https://api01.indexexchange.com/api/publishers/stats/earnings/served/deleted/placements

Response values

Returns an array of IDs associated with placements in the user account.

Parameter Type Description
placementID integer The ID associated with the placement.

Get served and deleted tiers

Returns all of the tiers in the account that have served and been deleted.

Method

GET

URL structure

https://api01.indexexchange.com/api/publishers/stats/earnings/served/deleted/placements/tiers

Example JSON response

{
    "data": [
        18153,
        18154,
        18155,
        18156,
        18157,
        18158,
        18159,
        18160,
        18161,
        18162,
        19141,
        19142,
        19143,
        19144,
        19145,
        20130,
        20131,
        20132,
        20133,
        20134
    ],
    "responseCode": 200,
    "version": "e54d17a3d69c3dda"
}

Response values

Returns an array of IDs associated with tiers in the account.

Parameter Type Description
tierID integer The ID associated with the tier.

Get unfilled statistics

Returns statistics about a publisher’s unsold impressions, such as passbacks and PSAs (public service announcements).

Method

POST

URL structure

https://api01.indexexchange.com/api/publishers/stats/unsold

Example JSON request body

{
    "filters": {
        "startDate": "2014-10-21",
        "endDate": "2015-09-30"
    },
    "aggregation": "siteID"
}

Request parameters

Parameter Type Required? Description
filters object Required. You can specify the following filter parameters:
  • startDate (string): Required. Defines the start date of the unsold impressions statistics in YYYY-MM-DD format. For example: 2014-09-22.
  • endDate (string): Required. Defines the end date of the unsold impressions statistics in YYYY-MM-DD format. For example: 2015-09-22.
  • siteID (array integer): Optional. Defines the ID(s) of the site(s). Any specified site(s) must be active and accessible to the current user. For example: { “siteID”: [311425, 311436, 314445] }
  • placementID (array integer): Optional. Defines the ID(s) of the placement(s). For example: { “placementID”: [432465, 472467, 412461] }
  • adUnitID (array integer): Optional. Defines the ID(s) of the ad unit(s). For example: { “adUnitID”: [1, 5, 8] }
aggregation string Required. Specifies how you want to aggregate the return information with one of the following values:

Example JSON response

{
    "data": [
        {
            "aggregateID": 159536,
            "defaultImpressions": 4230221,
            "psaImpressions": 1716
        },
        {
            "aggregateID": 159855,
            "defaultImpressions": 4478882,
            "psaImpressions": 1979
        },
        {
            "aggregateID": 160174,
            "defaultImpressions": 524039,
            "psaImpressions": 260
        },
        {
            "aggregateID": 160175,
            "defaultImpressions": 559986,
            "psaImpressions": 305
        }
    ],
    "responseCode": 200,
    "version": "e54d17a3d69c3dda"
}

Response values

Returns an array of objects ordered as follows:

Parameter Type Description
aggregateID The ID of the aggregate, which corresponds to the aggregation parameter you specified in the request.
  • day (string): Returns the date in YYYY-MM-DD format. For example: 2015-05-29.
  • month (string): Returns the month in YYYY-MM format. For example: 2015-09.
  • siteID (integer): Returns the ID of the site.
  • tierID (integer): Returns the ID of the tier.
defaultImpressions integer The number of passback impressions.
psaImpressions integer The number of public service announcement impressions.

Get winning bids

Returns information about winning bids, such as associated campaigns, impressions and earnings.

Method

POST

URL structure

https://api01.indexexchange.com/api/sites/stats/bids/winning

Example JSON request body

{
    "userID": 100017,
    "month": "2015-04",
    "siteID": [6, 5],
    "campaignID": [4, 7, 2]
}

Request parameters

Parameter Type Required? Description
month string Required. Specifies the month of winning bids you want to retrieve. The accepted format is YYYY-MM.
siteID array integer Required. Specifies the site(s) associated with the winning bids you want to retrieve.
campaignID array integer Optional. Specifies one or more campaigns you want to retrieve.

Example JSON response

{
    "data": [{
        "campaignID": 2,
        "impressions": 246,
        "earnings": 123.56
    }, {
        "campaignID": 7,
        "impressions": 333,
        "earnings": 852.31
    }],
    "responseCode": 200,
    "version": "e54d17a3d69c3dda"
}

Response values

Returns an array of objects ordered as follows

Parameter Type Description
campaignID integer The ID of the winning campaign.
impressions integer The number of impressions in the campaign.
earnings float The returned integer can be multiplied by 0.00001 to get the publisher’s earnings in their selected currency.

Floors

Types and criteria

Various floor requests and responses include the type parameter. The type parameter identifies the ID of the floor type. Every type value corresponds to a primaryCriteria value.

For example, a type value of 1 means the Floor Type is Ad Unit and the primaryCriteria value identifies the ad unit ID.

type parameter primaryCriteria parameter secondaryCriteria parameter
Value Description Value Description Value Description
0 Identifies Master as the Floor Type.        
1 Identifies Ad Unit as the Floor Type. It varies.

The returned integer is the ID of the ad unit.

To retrieve a list of ad units, see Get ad units.

   
2 Identifies Advertiser Brand as the Floor Type. It varies.

The returned integer is the ID of the advertiser brand.

To retrieve a list of brands, see Get brands.

   
3 Identifies Audience Segment as the Floor Type. It varies.

The returned integer is the ID of the audience segment.

To retrieve a list of audience segments, see Get audience segments.

   
4 Identifies Audience Type as the Floor Type. It varies.

The returned integer is the ID of the audience type.

To retrieve a list of audience types, see Get audience types.

   
5 Identifies Country as the Floor Type. It varies.

The returned string is the ID of the country.

To retrieve a list of countries, see Get country codes.

   
6 Identifies Creative Type as the Floor Type. It varies.

The returned integer is the ID of the creative type.

To retrieve a list of creative types, see Get creative types.

   
7 Identifies DSP as the Floor Type. It varies.

The returned integer is the ID of the DSP.

To retrieve a list of DSPs, see Get DSPs.

   
8 Identifies DSP by Buyer as the Floor Type. It varies.

The returned integer is the ID of the buyer (that is, the trading desk).

To retrieve a list of trading desks, see Get trading desks.

When a type of 8 is returned in a response, the secondaryCriteria parameter is returned in addition to primaryCriteria to identify the associated DSP. If you are submitting a request with a type of 8, you must also specify the secondaryCriteria parameter.

It varies.

The returned integer is the ID of the DSP.

To retrieve a list of DSPs, see Get DSPs.

9 Identifies Frequency as the Floor Type. It varies.

The returned integer is the ID of the frequency (that is, domain depth).

To retrieve a list of domain depths, see Get domain depths.

   
10 Identifies Industry as the Floor Type. It varies.

The returned integer is the ID of the industry.

To retrieve a list of industries, see Get industries.

   

Get site floor types

Retrieves information about site floor types.

Example JSON response

{
    "data": [
        {
            "id": 0,
            "name": "Master"
        },
        {
            "id": 1,
            "name": "Ad Unit"
        },
        {
            "id": 2,
            "name": "Advertiser Brand"
        },
        {
            "id": 3,
            "name": "Audience Segment"
        },
        {
            "id": 4,
            "name": "Audience Type"
        },
        {
            "id": 5,
            "name": "Country"
        },
        {
            "id": 6,
            "name": "Creative Type"
        },
        {
            "id": 7,
            "name": "DSP"
        },
        {
            "id": 8,
            "name": "DSP by Buyer"
        },
        {
            "id": 9,
            "name": "Frequency"
        },
        {
            "id": 10,
            "name": "Industry"
        }
    ],
    "responseCode": 200,
    "version": "e54d17a3d69c3dda"
}

Method

GET

URL structure

https://api01.indexexchange.com/api/publishers/floors/sites/types

Response values

An array of site floor types is returned with the following information:

Parameter Type Description
id integer The ID of the site floor type.
name string The name of the site floor type.

Get site floors

Retrieves information about all site floors.

Example JSON response

{
    "data": [
        {
            "userID": 183444,
            "siteID": 164144,
            "type": 2,
            "rate": "2.33",
            "floorType": "H",
            "primaryCriteria": 14
        },
        {
            "userID": 183444,
            "siteID": 164145,
            "type": 6,
            "rate": "4.20",
            "floorType": "O",
            "primaryCriteria": 6743
        }
    ],
    "responseCode": 200,
    "version": "e54d17a3d69c3dda"
}

Method

GET

URL structure

https://api01.indexexchange.com/api/publishers/floors/sites

Response values

An array of objects is returned with the following properties:

Parameter Type Description
userID integer The ID of the user that can access the site.
siteID integer The ID of the site associated with the floor.
primaryCriteria integer/string Identifies the primary criteria. The primary criteria corresponds to the ID returned in the type parameter.
secondaryCriteria integer Only returned if the type parameter is 8. Identifies the secondary criteria.
type integer The ID of the associated floor type.
rate string The floor rate associated with the site. The format of the floor rate includes a decimal and two digits to the right of the decimal place regardless of the publisher’s set currency. The minimum value is 0.01 and the maximum value is 99999.99.
floorType string The status of the floor rate when multiple floor rates exist in a campaign. Possible values are H for hard and O for override. When all floor rates that apply to the campaign are O, the lowest override floor rate is selected for the bid. When one or more of the applicable floor rates is H, the highest hard floor rate is selected for the bid.

Create a site floor

Adds a site floor.

If the floor already exists, this request updates information about the site floor, such as rate and floor type.

Method

PUT

URL structure

https://api01.indexexchange.com/api/publishers/floors/sites

Example JSON request body

{
    "siteID": [
        163211
    ],
    "floorType": "O",
    "rate": "0.90",
    "type": 2,
    "primaryCriteria": 1
}

Request parameters

Parameter Type Required. Description
siteID array integer Required. An array indicating one or more sites you want to update. Any specified sites must be currently active and accessible to the user.
floorType string Required. Specifies the status of the floor rate when multiple floor rates exist in a campaign. Valid values are H for hard and O for override. When all floor rates that apply to the campaign are O, the lowest override floor rate is selected for the bid. When one or more of the applicable floor rates is H, the highest hard floor rate is selected for the bid.
rate string Required. Specifies the floor rate. The format of the floor rate includes a decimal and two decimal places regardless of the publisher’s set currency. The minimum value is 0.01 and the maximum value is 99999.99.
type integer Required. Specifies the ID of the floor type. For more information about floor types, see Get site floor types.
primaryCriteria integer/string Do not include this if the type parameter is 0. Required otherwise. Specifies the primary criteria. The primary criteria must correspond to the ID that has been specified for the type parameter. For more information about corresponding values, see Types and criteria.
secondaryCriteria integer Only required if the type parameter is 8. If the type is not 8, this parameter must not be specified. Specifies the secondary criteria. This value must correspond to the value specified for the primaryCriteria parameter. For more information about corresponding values, see Types and criteria.

Example JSON response body

{
    "data": {
        "userID": 183444,
        "siteID": [
            163211
        ],
        "type": 2,
        "primaryCriteria": 1
    },
    "responseCode": 200,
    "version": "e54d17a3d69c3dda"
}

Response values

Returns an array of objects with the following properties:

Parameter Type Description
userID integer The ID of the user that can access the tier information.
siteID array integer The ID(s) of the associated site(s).
type integer The ID of the associated floor type.
primaryCriteria integer/string The ID of the primary criteria. The primary criteria corresponds to the floor type ID that has been returned for the type parameter.
secondaryCriteria integer Only returned if the type parameter is 8. Specifies the secondary criteria.

Delete a site floor

Deletes a site floor.

Method

DELETE

URL structure

https://api01.indexexchange.com/api/publishers/floors/sites?siteID=[siteID]&type=[type]&primaryCriteria=[primaryCriteria]

Example request URL

https://api01.indexexchange.com/api/publishers/floors/sites?siteID=12238&type=2&primaryCriteria=1

Request parameters

Parameter Type Required? Description
siteID integer Required. Indicates the site floor you want to delete. The specified site must be currently active and accessible to the user.
type integer Required. Specifies the ID of the floor type. For more information about floor types, see Get site floor types.
primaryCriteria integer/string Do not include this if the type parameter is 0. Required otherwise. Specifies the primary criteria. The primary criteria must correspond to the ID that has been specified for the type parameter. For more information about corresponding values, see Types and criteria.
secondaryCriteria integer Only required if the type parameter is 8. If the type is not 8, this parameter must not be specified. Specifies the secondary criteria. This value must correspond to the value specified for the primaryCriteria parameter. For more information about corresponding values, see Types and criteria.

Example JSON response

{
    "data": {
        "userID": 183444,
        "floors": [
            {
                "type": 6,
                "siteID": 164144,
                "primaryCriteria": 6743
            }
        ]
    },
    "responseCode": 200,
    "version": "e54d17a3d69c3dda"
}

Response values

Returns an array of objects with the following properties:

Parameter Type Description
userID integer The ID of the user that can access the site information.
floors array object Lists information about each floor that was deleted:

Get placement floor types

Retrieves information about placement floor types.

Method

GET

URL structure

https://api01.indexexchange.com/api/publishers/floors/placements/types

Example JSON response

{
    "data": [
        {
            "id": 1,
            "name": "Ad Unit"
        },
        {
            "id": 2,
            "name": "Advertiser Brand"
        },
        {
            "id": 3,
            "name": "Audience Segment"
        },
        {
            "id": 5,
            "name": "Country"
        },
        {
            "id": 6,
            "name": "Creative Type"
        },
        {
            "id": 8,
            "name": "DSP by Buyer"
        },
        {
            "id": 9,
            "name": "Frequency"
        },
        {
            "id": 10,
            "name": "Industry"
        }
    ],
    "responseCode": 200,
    "version": "e54d17a3d69c3dda"
}

Response values

An array of placement floor types is returned with the following information:

Parameter Type Description
id integer The ID of the placement floor type.
name string The name of the placement floor type.

Get placement floors

Retrieves information about all placement floors.

Method

GET

URL structure

https://api01.indexexchange.com/api/publishers/floors/placements

Example JSON response

{
    "data": [
        {
            "userID": 183444,
            "placementID": 12238,
            "type": 1,
            "rate": "1.00",
            "floorType": "H",
            "primaryCriteria": 3
        },
        {
            "userID": 183444,
            "placementID": 12238,
            "secondaryCriteria": 41,
            "type": 8,
            "rate": "1.20",
            "floorType": "O",
            "primaryCriteria": 328
        }
    ],
    "responseCode": 200,
    "version": "e54d17a3d69c3dda"
}

Response values

An array of objects is returned with the following information:

Parameter Type Description
userID integer The ID of the user that can access the placement.
placementID integer The ID of the placement associated with the floor.
primaryCriteria integer/string Identifies the primary criteria. The primary criteria corresponds to the ID returned in the type parameter.
secondaryCriteria integer Only returned if the type parameter is 8. Specifies the secondary criteria.
type integer The ID of the associated floor type.
rate string The floor rate associated with the placement. The floor rate is in the publisher’s set currency. The format includes a decimal and two decimal places regardless of the publisher’s currency. For example: 1.99. The minimum value is 0.01 and the maximum value is 99999.99.
floorType string The status of the floor rate when multiple floor rates exist in a campaign. Valid values are H for hard and O for override. When all floor rates that apply to the campaign are O, the lowest override floor rate is selected for the bid. When one or more of the applicable floor rates is H, the highest hard floor rate is selected for the bid.

Create a placement floor

Adds a placement floor.

If the floor already exists, this request updates information about the placement floor, such as rate and floor type.

Method

PUT

URL structure

https://api01.indexexchange.com/api/publishers/floors/placements

Example JSON request body

{
    "placementID": [
        12238
    ],
    "floorType": "O",
    "rate": "1.00",
    "type": 2,
    "primaryCriteria": 1
}

Request parameters

Parameter Type Required? Description
placementID array integer Required. An array indicating one or more placements you want to update. Any specified placements must be currently active and accessible to the user.
floorType string Required. Specifies the status of the floor rate when multiple floor rates exist in a campaign. Valid values are H for hard and O for override. When all floor rates that apply to the campaign are O, the lowest override floor rate is selected for the bid. When one or more of the applicable floor rates is H, the highest hard floor rate is selected for the bid.
rate string Required. Specifies the floor rate. The format of the floor rate includes a decimal and two decimal places regardless of the publisher’s set currency. The minimum value is 0.01 and the maximum value is 99999.99.
type integer Required. Specifies the ID of the floor type. For more information about floor types, see Get placement floor types.
primaryCriteria integer/string Required. Specifies the primary criteria. The primary criteria must correspond to the ID that has been specified for the type parameter. For more information about corresponding values, see Types and criteria.
secondaryCriteria integer Only required if the type parameter is 8. If the type is not 8, this parameter must not be specified. Specifies the secondary criteria. This value must correspond to the value specified for the primaryCriteria parameter. For more information about corresponding values, see Types and criteria.

Example JSON response

{
    "data": {
        "userID": 183444,
        "placementID": [
            12238
        ],
        "type": 2,
        "primaryCriteria": 1
    },
    "responseCode": 200,
    "version": "e54d17a3d69c3dda"
}

Response values

Parameter Type Description
userID integer The ID of the user that can access the placement information.
placementID array integer The ID(s) of the associated placement(s).
type integer The ID of the associated floor type.
primaryCriteria integer The ID of the primary criteria. The primary criteria corresponds to the floor type ID that has been returned for the type parameter.
secondaryCriteria integer Only returned if the type parameter is 8. Specifies the secondary criteria.

Delete a placement floor

Deletes a placement floor.

Method

DELETE

URL structure

https://api01.indexexchange.com/api/publishers/floors/placements?placementID=[placementID]&type=[type]&primaryCriteria=[primaryCriteria]

Example request URL

https://api01.indexexchange.com/api/publishers/floors/placements?placementID=12238&type=2&primaryCriteria=1

Request parameters

Parameter Type Required? Description
placementID integer Required. Indicates the placement floor you want to delete. The specified placement must be currently active and accessible to the user.
type integer Required. Specifies the ID of the floor type. For more information about floor types, see Get placement floor types.
primaryCriteria integer/string Required. Specifies the primary criteria. The primary criteria must correspond to the ID that has been specified for the type parameter.
secondaryCriteria integer Only required if the type parameter is 8. If the type is not 8, this parameter must not be specified. Specifies the secondary criteria. This value must correspond to the value specified for the primaryCriteria parameter.

Example JSON response

{
    "data": {
        "userID": 183444,
        "floors": [
            {
                "type": 2,
                "placementID": 12238,
                "primaryCriteria": 1
            }
        ]
    },
    "responseCode": 200,
    "version": "e54d17a3d69c3dda"
}

Response values

Parameter Type Description
userID integer The ID of the user that can access the placement information.
floors array object Lists information about each floor that was deleted:

Get tier floor types

Retrieves information about tier floor types.

Method

GET

URL structure

https://api01.indexexchange.com/api/publishers/floors/placements/tiers/types

Example JSON response

{
    "data": [
        {
            "id": 0,
            "name": "Master"
        },
        {
            "id": 4,
            "name": "Audience Type"
        },
        {
            "id": 7,
            "name": "DSP"
        }
    ],
    "responseCode": 200,
    "version": "e54d17a3d69c3dda"
}

Response values

An array of tier floor types is returned with the following information:

Parameter Type Description
id integer The ID of the tier floor type.
name string The name of the tier floor type.

Get tier floors

Retrieves information about all tier floors.

Method

GET

URL structure

https://api01.indexexchange.com/api/publishers/floors/placements/tiers

Example JSON response

{
    "data": [
        {
            "userID": 183444,
            "tierID": 28318,
            "type": 4,
            "rate": "8.57",
            "floorType": "H",
            "primaryCriteria": 0
        },
        {
            "userID": 183444,
            "tierID": 28318,
            "type": 0,
            "rate": ["1.00", "2.00"],
            "floorType": "F"
        }
    ],
    "responseCode": 200,
    "version": "e54d17a3d69c3dda"
}

Response values

An array of objects is returned with the following information:

Parameter Type Description
userID integer The ID of the user that can access the tier.
tierID integer The ID of the tier associated with the floor.
type integer The ID of the associated floor type.
primaryCriteria integer Identifies the primary criteria. The primary criteria corresponds to the ID returned in the type parameter.
rate string or array string The floor rate associated with the tier. The format of the floor rate includes a decimal and two digits to the right of the decimal place regardless of the publisher’s set currency. The minimum value is 0.01 and the maximum value is 99999.99. When the floorType is H or O, a string is returned. When the floorType is F, an array string of flexible floor rates is returned.
floorType string The status of the floor rate when multiple floor rates exist in a campaign. Possible values are H for hard, O for override and F for flexible floor rates. When the floorType is F, the flexible floor rate below the highest bid is selected regardless of whether other floor rate types apply. When no flexible floors apply to the campaign and one or more floors is O, the lowest override floor rate is selected for the bid. When the only floor rate that applies to the campaign is H, the highest hard floor rate is selected for the bid.

Create a tier floor

Adds a tier floor.

If the floor already exists, this request updates information about the tier floor, such as rate and floor type.

Method

PUT

URL structure

https://api01.indexexchange.com/api/publishers/floors/placements/tiers

Example JSON request body

{
    "tierID": [
        28321
    ],
    "floorType": "F",
    "rate": ["1.00", "2.00"],
    "type": 0
}

Request parameters

Parameter Type Required? Description
tierID array integer Required. An array indicating one or more tiers you want to update. Any specified tiers must be currently active and accessible to the user.
floorType string Required. Specifies the status of the floor rate when multiple floor rates apply to a campaign. Valid values are H for hard, O for override and F for flexible. When one of the floor types that applies to the campaign is F, the rate below the highest bid is selected. When no floor rates that apply to the campaign are F and one or more is O, the lowest override floor rate is selected for the bid. When the only floor rate type that applies is H, the highest hard floor rate is selected for the bid. F can only be specified when the type is 0.
rate string or array string Required. Specifies the floor rate. The minimum value is 0.01 and the maximum value is 99999.99. When the floorType is H or O, a string is returned. When the floorType is F, an array string of flexible floor rates is returned.
type integer Required. Specifies the ID of the floor type. For more information about floor types, see Get tier floor types.
primaryCriteria integer Do not include this if the type parameter is 0. Required otherwise. Specifies the primary criteria. The primary criteria must correspond to the ID that has been specified for the type parameter. For more information about corresponding values, see Types and criteria.

Example JSON response

{
    "data": {
        "userID": 183444,
        "tierID": [
            28321
        ],
        "type": 4,
        "primaryCriteria": 0
    },
    "responseCode": 200,
    "version": "e54d17a3d69c3dda"
}

Response values

Parameter Type Description
userID integer The ID of the user that can access the tier information.
tierID array integer The ID(s) of the associated tier(s).
type integer The ID of the associated floor type.
primaryCriteria integer The ID of the primary criteria. The primary criteria corresponds to the floor type ID that has been returned for the type parameter.

Delete a tier floor

Deletes a tier floor.

Method

DELETE

URL structure

https://api01.indexexchange.com/api/publishers/floors/placements/tiers?tierID=[tierID]&type=[type]&floorType=[floorType]&primaryCriteria=[primaryCriteria]

Example request URL

https://api01.indexexchange.com/api/publishers/floors/placements/tiers?tierID=28327&type=4&floorType=O&primaryCriteria=1

Request parameters

Parameter Type Required? Description
tierID integer Required. Indicates the tier floor you want to delete. The specified tier must be currently active and accessible to the user.
type integer Required. Specifies the ID of the floor type. For more information about floor types, see Get tier floor types.
floorType string Only allowed if the ​type​ parameter is 0. Specifies the floor type to delete, which can only be F (flexible floor type). When this parameter is not specified, the default behavior deletes a hard or override floor.
primaryCriteria integer Do not include this if the type parameter is 0. Required otherwise. Specifies the primary criteria. The primary criteria must correspond to the ID that has been specified for the type parameter.

Example JSON response

{
    "data": {
        "userID": 183444,
        "floors": [
            {
                "type": 4,
                "tierID": 28327,
                "floorType": "O",
                "primaryCriteria": 1
            }
        ]
    },
    "responseCode": 200,
    "version": "e54d17a3d69c3dda"
}

Response values

Parameter Type Description
userID integer The ID of the user that can access the tier information.
floors array object Lists information about each floor that was deleted:
  • type (integer): The ID of the associated floor type.
  • tierID (integer): The ID of the associated tier.
  • primaryCriteria (integer): The ID of the primary criteria. The primary criteria corresponds to the floor type ID that has been returned for the type parameter.

Passbacks

Get passbacks

Returns information about all of the publisher’s passbacks.

Method

GET

URL structure

https://api01.indexexchange.com/api/publishers/passbacks

Example JSON response

{
    "data": [
        {
            "userID": 100017,
            "campaignID": 13,
            "siteID": [
                5
            ],
            "adUnitID": 2,
            "name": "default image",
            "clickURL": "https://system.indexexchange.com/publisher",
            "creativeURL": "https://system.indexexchange.com/publisher",
            "isDynamic": 0,
            "creativeType": "singleImage"
        },
        {
            "userID": 100017,
            "campaignID": 22,
            "adUnitID": 5,
            "name": "dfs",
            "passbackID": "fjdksl",
            "isExpandable": 0,
            "creativeHTML": "https://fdsjkl.com",
            "isDynamic": 1,
            "creativeType": "richMedia"
        }
    ],
    "responseCode": 200,
    "version": "6f45736b796e5734"
}

Response values

An array of passback objects, ordered by name, is returned with the following fields:

Parameter Type Description
name string The name of the passback.
userID integer The ID of the user account that has access to the passback.
campaignID integer The ID of the associated campaign.
siteID array integer The ID of the associated sites.
adUnitID integer The ID of the associated ad unit.
isDynamic integer Specifies if the passback is dynamic. The returned value is 0 when the passback is not dynamic and 1 when the passback is dynamic.
passbackID string The ID of the associated passback. A value is only returned when the passback has an ID.
creativeType string Specifies whether the creative type is singleImage or richMedia.
isExpandable integer A value is only returned if the creativeType is richMedia. Specifies whether the creative type is expandable. The returned value is 1 when the creative is expandable.
creativeHTML string A value is only returned if the creativeType is richMedia. Specifies the HTML associated with the creative.
creativeURL string A value is only returned if the creativeType is singleImage. Specifies the image URL associated with the creative.
clickURL string A value is only returned if the creativeType is singleImage. Specifies the click URL associated with the creative.

Create a passback

Creates a new passback.

Method

PUT

URL structure

https://api01.indexexchange.com/api/publishers/passbacks

Example JSON request body

{
    "name": "jLJShiyo",
    "isDynamic": 0,
    "siteID": [
        163211
    ],
    "adUnitID": 2,
    "creativeType": "richMedia",
    "isExpandable": 1,
    "creativeHTML": "<div><img src=example.gif></div>"
}

Request parameters

Parameter Type Required? Description
name string Required. Specifies the name of the passback. The specified value must be 1 to 100 characters in length. The string must not contain any new lines, HTML tags or HTML entities.
isDynamic integer Required. Specifies if the passback is dynamic. 0 indicates the passback is not dynamic and 1 indicates the passback is dynamic.
passbackID string Required if isDynamic is 1. This parameter must not be included if isDynamic is 0. The specified value must be 1 to 25 characters in length.
siteID array integer Only required if the isDynamic parameter is 0. Specifies the ID of the associated sites.
adUnitID integer Required. The ID of the associated ad unit.
creativeType string Required. Specifies whether the creative type is singleImage or richMedia. This parameter is case sensitive.
isExpandable integer Only required if the creativeType is richMedia. Must not be specified when the creativeType is singleImage. Specifies whether the creative type is expandable. 1 specifies the creative is expandable.
creativeHTML string Only required if the creativeType is richMedia. Must not be specified when the creativeType is singleImage. Specifies the HTML associated with the creative. The specified string must not contain any of the following HTML tags: <base>, <meta>, <html>, <body>, <title>, <head>.
creativeURL string Only required if the creativeType is singleImage. Must not be specified when the creativeType is richMedia. Specifies the image URL associated with the creative. The specified value can be 11 to 255 characters in length. The specified string must begin with http:// or https://.
clickURL string Only required if the creativeType is singleImage. Must not be specified when the creativeType is richMedia. Specifies the click URL associated with the creative. The specified value can be 11 to 255 characters in length. The specified string must begin with http:// or https://.

Example JSON response

{
    "data": {
        "userID": 100017,
        "campaignID": [
            32
        ]
    },
    "responseCode": 200,
    "version": "6f45736b796e5734"
}

Response values

Parameter Type Description
userID integer The ID of the user account that has access to the passback.
campaignID array integer An array with a single ID that is associated with the new campaign.

Update a passback

Updates an existing passback.

Method

PATCH

URL structure

https://api01.indexexchange.com/api/publishers/passbacks

Example JSON request body

{
    "campaignID": 605078,
    "passbackID":"DYN0232",
    "name": "New campaign default",
    "siteID": [160175],
    "isExpandable": 1,
    "creativeHTML": "<div><img src=example.gif></div>"
}

Request parameters

Parameter Type Required? Description
campaignID integer Required. Specifies the ID of the campaign you want to retrieve.
passbackID string Optional if the passback is dynamic. This parameter must not be included if the passback is non-dynamic. The specified value must be 1 to 25 characters in length.
name string Optional. Specifies the name of the passback. The specified value must be 1 to 100 characters in length. The string must not contain any new lines, HTML tags or HTML entities.
siteID array integer Optional. Specifies the ID of the associated site.
isExpandable integer Optional if the creativeType is richMedia. Must not be specified if the creativeType is singleImage. Specifies whether the creative type is expandable. 1 specifies the creative is expandable.
creativeHTML string Optional if the creativeType is richMedia. Must not be specified if the creativeType is singleImage. Specifies the HTML associated with the creative. The specified string must not contain any of the following HTML tags: <base>, <meta>, <html>, <body>, <title>, <head>.
creativeURL string Optional if the creativeType is singleImage. Must not be specified if the creativeType is richMedia. Specifies the image URL associated with the creative. The specified value can be 11 to 255 characters in length. The specified string must begin with http:// or https://.
clickURL string Optional if the creativeType is singleImage. Must not be specified if the creativeType is richMedia. Specifies the click URL associated with the creative. The specified value can be 11 to 255 characters in length. The specified string must begin with http:// or https://.

Example JSON response

{
    "data": {
        "userID": 100017,
        "campaignID": [
            605078
        ]
    },
    "responseCode": 200,
    "version": "6f45736b796e5734"
}

Response values

Parameter Type Description
userID integer The ID of the user account that has access to the passback.
campaignID array integer An array with a single ID that is associated with the campaign.

Delete a passback

Deletes a publisher’s passback.

Example request URL

https://api01.indexexchange.com/api/publishers/passbacks?campaignID=17

Example JSON response

{
    "data": {
        "userID": 100017,
        "passbacks": [
            {
                "campaignID": 17
            }
        ]
    },
    "responseCode": 200,
    "version": "6f45736b796e5734"
}

Method

DELETE

URL structure

https://api01.indexexchange.com/api/publishers/passbacks?campaignID=[campaignID]

Request parameters

Parameter Type Required? Description
campaignID integer Required. Specifies the ID of the campaign you want to delete.

Response values

Parameter Type Description
userID integer The ID of the user account that has access to the passback.
passbacks array object An array with a single object containing the following property:
  • campaignID (integer): The ID of the associated campaign.

Placements

Get placements

Returns information about active placements, such as name, status, percent and priority.

Method

POST

URL structure

https://api01.indexexchange.com/api/publishers/placements

Example JSON request body

{
    "placementID": [
        12238
    ]
}

Request parameters

Parameter Type Required? Description
placementID array integer Optional. An array indicating one or more placements you want to retrieve. Any specified placements must currently be active and accessible to the user. If placementID is not included in the request, all placements will be returned.

Example JSON response

{
    "data": [
        {
            "placementID": 12238,
            "userID": 183444,
            "name": "ocG TdsBzyEIL (HaypC)",
            "status": "A",
            "percent": 100,
            "entireSite": 1,
            "dynamicAdTag": 0,
            "isMasterPlacement": 0,
            "priority": 1,
            "siteID": [
                163211,
                164144
            ]
        }
    ],
    "responseCode": 200,
    "version": "e54d17a3d69c3dda"
}

Response values

An array of objects is returned with the following properties:

Parameter Type Description
placementID integer The ID of the placement.
userID integer The ID of the user associated with the placement.
name string The name of the placement.
status string The status of the placement, which can only be A (active).
percent integer The percent of coverage the placement has.
entireSite integer A binary that indicates whether the main domain must be matched (partially or in full) for the advertisement to serve. 0 indicates a full or partial URL match is required and 1 indicates a URL match is not required.
matches array object An array of match objects. The array should contain one or more values if the entireSite parameter is set to 0. Each object contains a URL and match type. The matchType parameter can contain a value of 1, which represents a full match type, or 2, which represents a partial match type.
dynamicAdTag integer Indicates whether a dynamic ad tag is enabled. 1 indicates a dynamic ad tag is enabled and 0 indicates a dynamic ad tag is not enabled.
isMasterPlacement integer Indicates whether the placement is the parent (0) or master (1) placement.
priority integer Displays the priority of the placement in the hierarchy of placements.
siteID array integer An array that displays sites associated with the placement.
frequencyRestrictions array integer Displays any frequency restrictions by ID.
audienceRestrictions array integer Displays any audience restrictions by ID.
countryRestrictions array string Displays any country restrictions by ID.
adUnitRestrictions array integer Displays any ad unit restrictions by ID.

Create a placement

Adds a new placement.

Method

PUT

URL structure

https://api01.indexexchange.com/api/publishers/placements

Example JSON request body

{
    "name": "dvfs",
    "entireSite": 0,
    "matches": [
        {
            "url": "http://cofdsf.uk",
            "matchType": 2
        }
    ],
    "dynamicAdTag": 0,
    "siteID": [
        5
    ],
    "percent": 2,
    "frequencyRestrictions": [
        1
    ],
    "adUnitRestrictions": [
        4,
        5,
        12
    ],
    "tiers": [
        {
            "name": "fdds",
            "transparency": "T",
            "access": "private",
            "timeout": 10
        }
    ]
}

Request parameters

Parameter Type Required? Description
name string Required. Specifies the name of the placement. The specified value must be 1 to 100 characters in length.
percent integer Required. Specifies the percent of coverage associated with the placement. The specified value must be a number from 1 to 100.
entireSite integer Required. Indicates whether the main domain must be matched (partially or fully) for the advertisement to serve. 0 indicates a full or partial URL match is required and 1 indicates a URL match is not required. If you specify 0, the matches parameter must also be specified.
matches array object Only required if the entireSite parameter is set to 0. Do not include this object in your request if entireSite is 1. Within the matches object, define a URL and match type as follows: {“matchType”: [matchType], “url”: “[url]”}. For the matchType parameter, 1 represents a full match type and 2 represents a partial match type.
siteID array integer Required. Defines the site ID associated with the placement.
dynamicAdTag integer Required. A binary that indicates whether a dynamic ad tag is enabled. 1 indicates a dynamic ad tag is enabled and 0 indicates a dynamic ad tag is not enabled.
frequencyRestrictions array integer Optional. Specifies frequency restrictions by ID.
audienceRestrictions array integer Optional. Specifies audience restrictions by ID.
countryRestrictions array string Optional. Specifies country restrictions by ID.
adUnitRestrictions array integer Optional. Specifies ad unit restrictions by ID.
tiers array object Required. Within tiers, you can specify one or more tiers to associate with the placement. Each tier must contain the following parameters:
  • name (string): Required. Specifies the name of the tier. The specified value must be 1 to 100 characters in length.
  • transparency (string): Required. Specifies whether the tier is transparent T or semi-transparent S. If you specify semi-transparency S, you must also specify the visible part of the URL within the rollupDomain parameter.
  • access (string): Required. Specifies whether the tier is public or private.
  • timeout (integer): Required. Specifies the connection timeout. The specified value is in milliseconds, must be a multiple of 10 (such as 10, 20, 30) and can be up to 250.
For more information about all parameters you can specify for tiers, see Create a tier.

Example JSON response

{
    "data": {
        "userID": 100017,
        "placementID": [525]
    },
    "responseCode": 200,
    "version": "cfb004f6d1b37ec1"
}

Response values

Parameter Type Description
userID integer The ID of the user associated with the placement.
placementID array integer The ID of the placement.

Update a placement

Updates an existing placement.

Method

PATCH

URL structure

https://api01.indexexchange.com/api/publishers/placements

Example JSON request body

{
  "placementID": 516,
  "name": "fdjskl"
}

Request parameters

Parameter Type Required? Description
placementID integer Required. Indicates the placement you want to update. The specified placement must be active and accessible to the user.
name string Optional. Specifies the name of the placement. The specified value must be 1 to 100 characters in length.
percent integer Optional. Specifies the percent of coverage associated with the placement. The specified value must be a number from 1 to 100.
entireSite integer Optional. Indicates whether the main domain must be matched (partially or fully) for the advertisement to serve. 0 indicates a full or partial URL match is required and 1 indicates a URL match is not required. If you specify 0, the matches parameter must also be specified.
matches array object Required if you are changing entireSite from 1 to 0. Do not include this object in your request if entireSite is 1. Within each matches object, define a URL and match type as follows: {“matchType”: [matchType], “url”: “[url]”}. For the matchType parameter, 1 represents a full match type and 2 represents a partial match type.
siteID array integer Optional. Defines the site IDs associated with the placement.
frequencyRestrictions array integer Optional. Specifies frequency restrictions by ID.
audienceRestrictions array integer Optional. Specifies audience restrictions by ID.
countryRestrictions array string Optional. Specifies country restrictions by ID.
adUnitRestrictions array integer Optional. Specifies ad unit restrictions by ID.

Example JSON response

{
    "data": {
        "userID": 100017,
        "placementID": [
            516
        ]
    },
    "responseCode": 200,
    "version": "cfb004f6d1b37ec1"
}

Response values

Parameter Type Description
userID integer The ID of the user associated with the placement.
placementID array integer The ID of the placement.

Delete a placement

Deletes an existing placement.

Method

DELETE

URL structure

https://api01.indexexchange.com/api/publishers/placements?placementID=[placementID]

Example request URL

https://api01.indexexchange.com/api/publishers/placements?placementID=719

Request parameters

Parameter Type Required? Description
placementID integer Required. Indicates the placement you want to delete. Any specified placement must be currently active. You cannot specify a master placement to delete in the request.

Example JSON response

{
    "data": {
        "tierID": [
            1746
        ],
        "userID": 100007,
        "placementID": [
            719
        ]
    },
    "responseCode": 200,
    "version": "6f45736b796e5734"
}

Response values

Parameter Type Description
userID integer The ID of the user associated with the placement.
placementID array integer The ID of the placement.
tierID array integer Indicates the ID of the tier.

Get placement information

Returns information about all placements, such as placement ID, name and status.

Method

GET

URL structure

https://api01.indexexchange.com/api/publishers/placements/info

Example JSON response

{
    "data": [
        {
            "placementID": 12238,
            "name": "ocG TdsBzyEIL (HaypC)",
            "status": "A"
        },
        {
            "placementID": 12239,
            "name": "QvG WInuQSlmp (gQ)",
            "status": "D"
        }
    ],
    "responseCode": 200,
    "version": "e54d17a3d69c3dda"
}

Response values

An array of objects is returned, ordered by placementID, with the following information:

Parameter Type Description
placementID integer The ID of the placement.
name string The name of the placement.
status string The status of the placement, which can be A (active), N (new) or D (deactive).

Get priorities

Returns information about placement priorities.

Method

POST

URL structure

https://api01.indexexchange.com/api/publishers/placements/priorities

Example JSON request body

{
    "placementID": [
        12238
    ]
}

Request parameters

Parameter Type Required? Description
placementID array integer Optional. Indicates one or more placements you want to retrieve. Any specified placements must be currently active and accessible to the user. If placementID is not specified, all active placements are returned.

Example JSON response

{
    "data": [
        {
            "placementID": 12238,
            "priority": 23
        }
    ],
    "responseCode": 200,
    "version": "cfb004f6d1b37ec1"
}

Response values

An array of objects is returned, ordered by priority, with the following information:

Parameter Type Description
placementID integer The ID of the placement.
priority integer Identifies the priority of the placement.

Update a priority

Updates one or more placement priorities.

Method

PATCH

URL structure

https://api01.indexexchange.com/api/publishers/placements/priorities

Example JSON request body

{
    "priorities": [
        {
            "placementID": 12238,
            "priority": 2
        },
        {
            "placementID": 12239,
            "priority": 1
        }
    ]
}

Request parameters

Parameter Type Required? Description
priorities array object Required. Indicates the priority of one or more placements within the hierarchy of placements. The maximum value for a priority is limited by the number of available placements. You can specify priorities for multiple placements in the request. Each priorities array member must be a tuple as follows: {placementID: [placementID], priority: [priorityID]}. Each array member must include the following:
  • placementID (integer): The ID of the placement.
  • priority (integer): The priority of the placement.

Example JSON response

{
    "data": [
        {
            "priority": 1,
            "placementID": 12239
        },
        {
            "priority": 2,
            "placementID": 12238
        },
        {
            "priority": 3,
            "placementID": 20999
        }
    ],
    "responseCode": 200,
    "version": "e54d17a3d69c3dda"
}

Response values

An array of all placement priority objects is returned, ordered by priority, with the following information:

Parameter Type Description
placementID integer The ID of the placement.
priority integer Identifies the priority of the placement.

Get tiers information

Returns information about all placement tiers, such as ID, name, associated placement ID and status.

Example JSON response

{
    "data": [
        {
            "tierID": 28318,
            "name": "Gwe XrCyNZhMq (fcXbL) - W1",
            "placementID": 12238,
            "status": "A"
        },
        {
            "tierID": 28319,
            "name": "Onh FcjheYRBs (NSYEa) - J2",
            "placementID": 12238,
            "status": "A"
        },
        {
            "tierID": 28320,
            "name": "gIx LeQuEiWKy (wXIbl) - F3",
            "placementID": 12238,
            "status": "A"
        },
        {
            "tierID": 28321,
            "name": "wuc QgYLEXUQJ (zPUYT) - J4",
            "placementID": 12238,
            "status": "A"
        },
        {
            "tierID": 28322,
            "name": "Vwp ciVzsftUx (cAcIu) - m5",
            "placementID": 12238,
            "status": "A"
        },
        {
            "tierID": 28323,
            "name": "YYz OAzRmSNGk (Fx) - a1",
            "placementID": 12239,
            "status": "A"
        },
        {
            "tierID": 28324,
            "name": "oTh COZMTbVnL (Ys) - s2",
            "placementID": 12239,
            "status": "A"
        },
        {
            "tierID": 45333,
            "name": "2",
            "placementID": 20999,
            "status": "A"
        },
        {
            "tierID": 45335,
            "name": "New Tier",
            "placementID": 20999,
            "status": "D"
        }
    ],
    "responseCode": 200,
    "version": "e54d17a3d69c3dda"
}

Method

GET

URL structure

https://api01.indexexchange.com/api/publishers/placements/tiers/info

Response values

An array of objects is returned with the following information:

Parameter Type Description
tierID integer The ID of the placement tier.
name string The name of the placement tier.
placementID integer The ID of the placement to which it is associated.
status string The status of the placement tier. Possible statuses include A (active), D (deactivated or deleted) and N (new).

Get tiers

Returns information about active placement tiers.

Method

POST

URL structure

https://api01.indexexchange.com/api/publishers/placements/tiers

Example JSON request body

{
    "placementID": [
        12238
    ]
}

Request parameters

Parameter Type Required? Description
placementID array integer Optional. Indicates one or more placements associated with tiers you want to retrieve. Any specified placements must be currently active and accessible to the user. If placementID is not included, all active tiers associated with all placements will be returned.
tierID array integer Optional. Specifies tiers you want to retrieve. In any request that specifies tiers, the associated placement(s) must also be specified.

Example JSON response

{
    "data": [
        {
            "tierID": 28318,
            "name": "Gwe XrCyNZhMq (fcXbL) - W1",
            "status": "A",
            "placementID": 12238,
            "userID": 183444,
            "timeout": 150,
            "access": "public",
            "transparency": "T",
            "rollupDomain": ""
        },
        {
            "tierID": 28319,
            "name": "Onh FcjheYRBs (NSYEa) - J2",
            "status": "A",
            "placementID": 12238,
            "userID": 183444,
            "timeout": 100,
            "access": "public",
            "transparency": "T",
            "rollupDomain": ""
        },
        {
            "tierID": 28320,
            "name": "gIx LeQuEiWKy (wXIbl) - F3",
            "status": "A",
            "placementID": 12238,
            "userID": 183444,
            "timeout": 100,
            "access": "public",
            "transparency": "T",
            "rollupDomain": ""
        },
        {
            "tierID": 28321,
            "name": "wuc QgYLEXUQJ (zPUYT) - J4",
            "status": "A",
            "placementID": 12238,
            "userID": 183444,
            "timeout": 100,
            "access": "public",
            "transparency": "T",
            "rollupDomain": ""
        },
        {
            "tierID": 28322,
            "name": "Vwp ciVzsftUx (cAcIu) - m5",
            "status": "A",
            "placementID": 12238,
            "userID": 183444,
            "timeout": 50,
            "access": "public",
            "transparency": "T",
            "rollupDomain": ""
        }
    ],
    "responseCode": 200,
    "version": "e54d17a3d69c3dda"
}

Response values

An array of tier objects is returned with the following information:

Parameter Type Description
tierID integer Indicates the ID of the tier.
name string Identifies the name of the tier.
status string Identifies the status of the tier.
placementID integer Identifies the ID of the placement.
userID integer Identifies the user account that can access the information.
timeout integer Identifies the timeout in milliseconds.
access string Identifies whether the tier is public or private.
transparency string Identifies whether the tier is transparent (T) or semi-transparent (S).
rollupDomain string Displays the URL you want to be visible to DSPs.
adUnit integer Only returned if the associated placement has dynamicAdTag set to 1. Identifies an ad unit ID.
accessOverride array integer Identifies any access override set to public for specific DSP IDs.
transparencyOverride array object Identifies any transparency overrides. Each array element contains the following parameters:
  • dspID (integer): Identifies the relevant DSP.
  • transparency (string): Specifies whether the tier is transparent (T) or semi-transparent (S).
  • rollupDomain (string): This is only returned if the transparency parameter is set to S (semi-transparent). The string specifies the URL you want to be visible to DSPs.

Create a tier

Adds a tier to a placement.

Method

PUT

URL structure

https://api01.indexexchange.com/api/publishers/placements/tiers

Example JSON request body

{
    "placementID": 20999,
    "name": "New Tier",
    "timeout": 10,  
    "access": "private",
    "transparency": "T"
}

Request parameters

Parameter Type Required? Description
placementID integer Required. Specifies the placement to which you want to add the tier. Any specified placement must be currently active and accessible to the user.
name string Required. Specifies the name of the tier. The specified value must be 1 to 100 characters in length.
timeout integer Required. Specifies the connection timeout. The specified value is in milliseconds, must be a multiple of 10 (such as 10, 20, 30) and can be up to 250.
access string Required. Specifies whether the tier is public or private.
transparency string Required. Specifies whether the tier is transparent (T) or semi-transparent (S). If you specify semi-transparency (S), you must also specify the visible part of the URL within the rollupDomain parameter.
rollupDomain string Only required if the transparency parameter is set to S (semi-transparent). Specifies the URL you want to be visible to DSPs.
adUnit integer Only required if the dynamicAdTag parameter of the associated placement is enabled (set to 1). This parameter should not be specified if the dynamicAdTag is not enabled (that is, it is set to 0). Specifies an ad unit ID.
accessOverride array integer Optional if the access parameter is private. Do not include this parameter otherwise. Specifies active DSP IDs with access overridden to be public.
transparencyOverride array object Optional. Indicates a transparency override. Any specified array object must contain the following parameters:
  • dspID (integer): Specifies the ID of an active DSP.
  • transparency (string): Specifies whether the tier is transparent (T) or semi-transparent (S).
  • rollupDomain (string): This is only required if the transparency parameter is set to S (semi-transparent). The string specifies the URL you want to be visible to DSPs.

Example JSON response

{
    "data": {
        "userID": 183444,
        "placementID": [
            20999
        ],
        "tierID": [
            45335
        ]
    },
    "responseCode": 200,
    "version": "e54d17a3d69c3dda"
}

Response values

Parameter Type Description
userID integer Identifies the user account that can access the information.
placementID array integer Identifies the ID of the placement.
tierID array integer Indicates the ID of the tier.

Update a tier

Updates a placement tier.

Method

PATCH

URL structure

https://api01.indexexchange.com/api/publishers/placements/tiers

Example JSON request body

{
    "placementID": 20999,
    "tierID": 45335,
    "timeout": 30
}

Request parameters

Parameter Type Required? Description
placementID integer Required. Indicates the placement associated with the tier you want to update. The specified placement must be accessible to the user and currently active.
tierID integer Required. Indicates the tier you want to update. The user must be able to access the specified tier.
name string Optional. Specifies the name of the tier. The specified value must be 1 to 100 characters in length.
timeout integer Optional. Specifies the connection timeout. The specified value is in milliseconds, must be a multiple of 10 (such as 10, 20, 30) and can be up to 250.
access string Optional. Specifies whether the tier is public or private.
transparency string Optional. Specifies whether the tier is transparent (T) or semi-transparent (S). If you specify semi-transparency (S), you must also specify the visible part of the URL within the rollupDomain parameter.
rollupDomain string Only required if the transparency parameter is set to S (semi-transparent). Specifies the URL you want to be visible to DSPs.
adUnit integer Optional if the dynamicAdTag parameter of the associated placement is enabled (set to 1). This parameter should not be specified if the dynamicAdTag is not enabled (that is, it is set to 0). Specifies an ad unit ID.
accessOverride array integer Optional if the access parameter is private. Do not include this parameter otherwise. Specifies active DSP IDs.
transparencyOverride array object Optional. Indicates a transparency override. Any specified array object must contain the following parameters:
  • dspID (integer): Specifies the ID of an active DSP.
  • transparency (string): Specifies whether the tier is transparent (T) or semi-transparent (S).
  • rollupDomain (string): This is only required if the transparency parameter is set to S (semi-transparent). The string specifies the URL you want to be visible to DSPs.

Example JSON response

{
    "data": {
        "userID": 183444,
        "placementID": [
            20999
        ],
        "tierID": [
            45335
        ]
    },
    "responseCode": 200,
    "version": "e54d17a3d69c3dda"
}

Response values

Parameter Type Description
userID integer Identifies the user account that can access the information.
placementID array integer Identifies the ID of the placement.
tierID array integer Indicates the ID of the tier.

Delete a tier

Deletes a tier from a placement.

Method

DELETE

URL structure

https://api01.indexexchange.com/api/publishers/placements/tiers?tierID=[tierID]&placementID=[placementID]

Example request URL

https://api01.indexexchange.com/api/publishers/placements/tiers?tierID=45335&placementID=20999

Request parameters

Parameter Type Required? Description
placementID integer Required. Indicates the placement containing the tier you want to delete. Any specified placement must be currently active.
tierID integer Required. Indicates the tier you want to delete. The user must be able to access the specified tier. The specified tier must not be the only remaining tier associated with the specified placement.

Example JSON response

{
    "data": {
        "userID": 183444,
        "placementID": [
            20999
        ],
        "tierID": [
            45335
        ]
    },
    "responseCode": 200,
    "version": "e54d17a3d69c3dda"
}

Response values

Parameter Type Description
userID integer Identifies the user account that can access the information.
placementID array integer Identifies the ID of the placement.
tierID array integer Indicates the ID of the tier.

Site tags

Get site tags

Returns information about the publisher’s site tags, including the name, status and root domain.

Method

POST

URL structure

https://api01.indexexchange.com/api/publishers/sites

Example JSON request body

{
    "siteID": [
      163211,
      164144
    ]
}

Request parameters

Parameter Type Required? Description
siteID array integer Optional. Specifies one or more sites you want to retrieve. Any specified sites must be currently active and accessible to the user. When this parameter is not included, information is returned for all active sites.

Example JSON response

{
   "data": [
      {
         "siteID": 163211,
         "userID": 183444,
         "status": "A",
         "name": "rMs WWDmTTxZT - IDZ",
         "mainDomain": "http://BiOluhgqKGOf.com",
         "autoApproval": 1,
         "prmPause": 0,
         "description": "Upgrade to Flex by Oz Gegre",
         "rollupDomain": "",
         "rtbTransparent": 1,
         "dynamicAdTag": 0,
         "siteTagCategory": 157,
         "brandSafeContent": [ ],
         "siteTypeID": 0
      },
      {
         "siteID": 164144,
         "userID": 183444,
         "status": "A",
         "name": "wsh fUoVeLjyO - yfV",
         "mainDomain": "http://ADwuCFBLrgKF.com",
         "autoApproval": 1,
         "prmPause": 0,
         "description": "Upgrade to Flex by Oz Gegre",
         "rollupDomain": "",
         "rtbTransparent": 1,
         "dynamicAdTag": 0,
         "siteTagCategory": 157,
         "brandSafeContent": [ ],
         "siteTypeID": 0
      }
   ],
   "responseCode": 200,
   "version": "e54d17a3d69c3dda"
}

Response values

An array of site tag objects is returned with the following fields.

Parameter Type Description
siteID integer The ID of the site.
userID integer The ID of the user who can access the site information.
status string Provides the status of the site. Possible statuses include A (active), D (deactivated or deleted) and N (new).
name string Identifies the site name.
mainDomain string Identifies the root domain.
autoApproval integer Indicates whether automatic approval is enabled. 1 indicates automatic approval is enabled and 0 indicates automatic approval is not enabled.
prmPause integer Identifies if the site is paused by the publisher relations manager. 1 indicates the site is paused and 0 indicates the site is not paused.
description string Provides a description of the site.
rollupDomain string Only returned if the rtbTransparent parameter is set to 0 (semi-transparent). Identifies the URL that is visible to DSPs.
rtbTransparent integer Identifies whether the site is transparent to bidders. 1 indicates the site is transparent and 0 indicates the site is semi-transparent. If 0 is returned, the rollupDomain parameter is also returned.
dynamicAdTag integer Indicates whether a dynamic ad tag is enabled. 1 indicates a dynamic ad tag is enabled and 0 indicates a dynamic ad tag is not enabled.
siteTagCategory integer Identifies the category associated with the site.
brandSafeContent array integer Identifies brand-safe content. Returns array of site tag IDs associated with brand-safe content.
siteTypeID integer The ID that corresponds with the site type and/or the publisher type.

Get site information

Returns information about the publisher’s sites.

Method

GET

URL structure

https://api01.indexexchange.com/api/publishers/sites/info

Example request URL

https://api01.indexexchange.com/api/publishers/sites/info?status=["A","D"]

Request parameters

Parameter Type Required? Description
status array string Optional. Specifies one or more site statuses you want to retrieve. Possible statuses include A (active), D (deactivated or deleted) and N (new). If you do not specify status, only sites with a status of A are returned by default.

Example JSON response

{
   "data": [{
       "siteID": 18,
       "name": "GMB",
       "status": "A"
   }, {
       "siteID": 16,
       "name": "GMR",
       "status": "A"
   }, {
       "siteID": 26,
       "name": "www.xgO7MdbDYg3Mws5FdgYpCdkXCc2NG7RNDW.com",
       "status": "A"
   }, {
       "siteID": 21,
       "name": "www.xQKA6DwWfHbW4QzISZdzOLdeld15JnFPvK.com",
       "status": "D"
   }],
   "responseCode": 200,
   "version": "98d777e24a0f0a12"
}

Response values

An array of objects is returned and each object contains the following parameters:

Parameter Type Description
siteID integer The ID of the site.
status string Provides the status of the site. Possible statuses include A (active), D (deactivated or deleted) and N (new).
name string Identifies the site name.

Create a site tag

Adds a new site tag.

Method

PUT

URL structure

https://api01.indexexchange.com/api/publishers/sites

Example JSON request body

{
    "name": "New site",
    "mainDomain": "http://url.com",
    "brandSafeContent": [
        4
    ],
    "siteTagCategory": 157,
    "autoApproval": 0,
    "rtbTransparent": 1
}

Request parameters

Parameter Type Required? Description
name string Required. Specifies the site name. Cannot contain any HTML entities and cannot contain new line characters.
mainDomain string Required. Specifies a root domain that requires validation. You can specify http:// if no root domain validation is required. HTML entities, tags and white spaces cannot be included.
description string Optional. Specifies a description of the site. The specified string cannot contain any HTML entities or tags.
brandSafeContent array integer Optional. Specifies brand-safe content. You can specify one or more site tags associated with brand-safe content.
dynamicAdTag integer Optional. Specifies whether a dynamic ad tag is enabled. 1 indicates a dynamic ad tag is enabled and 0 indicates a dynamic ad tag is not enabled.
siteTagCategory integer Required. Specifies the category associated with the site. The specified category must be active.
autoApproval integer Required. Specifies whether automatic approval is enabled. 1 specifies automatic approval is enabled and 0 specifies automatic approval is not enabled.
rtbTransparent integer Optional. Only non-publishers can specify this parameter. Specifies whether the site is transparent to bidders. 1 specifies the site is transparent and 0 specifies the site is semi-transparent. If 0 is specified, the rollupDomain parameter must also be specified.
rollupDomain string Only required if the rtbTransparent parameter is set to 0 (semi-transparent). Only non-publishers can specify this parameter. Specifies the URL you want to be visible to DSPs.
siteTypeID integer Optional. Specifies the ID that corresponds with the site type and/or the publisher type. 2 indicates a proxy publisher. 1 indicates a header tag site associated with an ajax publisher. 0 indicates a static ad tag or dynamic ad tag site, which can be associated with a standard publisher or an ajax publisher.
tiers array object Only required if the dynamicAdTag parameter is set to 1. Defines one or more tier(s). The following parameters are required:
  • name (string): Required. Specifies the name of the tier. The specified value must be 1 to 50 characters in length.
  • timeout (integer): Required. Specifies the connection timeout. The specified value is in seconds, must be a multiple of 10 (such as 10, 20, 30) and can be up to 250.
  • access (string): Required. Specifies whether the tier is public or private.
  • transparency (string): Required. Specifies whether the tier is transparent (T) or semi-transparent (S). If you specify semi-transparency (S), you must also specify the visible part of the URL within the rollupDomain parameter.
  • rollupDomain (string): Only required if the transparency parameter is set to S (semi-transparent). Specifies the URL you want to be visible to DSPs.
  • adUnit (integer): Only required if the placement if the dynamicAdTag parameter is enabled (set to 1). Specifies an ad unit ID. This parameter should not be specified if dynamicAdTag is not enabled (that is, it is set to 0).
  • accessOverride (array integer): Optional. Specifies active DSP IDs. An array string should only be specified if the access parameter is private.
  • transparencyOverride (array object): Optional. Indicates a transparency override. Any specified array object must contain the following parameters:
    • dspID (integer): Specifies the ID of an active DSP.
    • transparency (string): Specifies whether the tier is transparent (T) or semi-transparent (S).
    • rollupDomain (string): This is only required if the transparency parameter is set to S (semi-transparent). The string specifies the URL you want to be visible to DSPs.

Example JSON response

{
   "data": {
      "userID": 183444,
      "siteID": [
         168657
      ]
   },
   "responseCode": 200,
   "version": "e54d17a3d69c3dda"
}

Response values

Parameter Type Description
userID integer The ID of the user who can access the site information.
siteID array integer The ID(s) of the associate site(s).

Update a site tag

Updates a publisher’s site tag.

Method

PATCH

URL structure

https://api01.indexexchange.com/api/publishers/sites

Example JSON request body

{
    "siteID": 164144,
    "description": "Upgrade to newest version"
}

Request parameters

Parameter Type Required? Description
siteID integer Required. Indicates the site you want to update. The specified site must be currently active and accessible to the user.
name string Optional. Specifies the site name. The specified string cannot contain HTML tags and cannot have any new line characters.
description string Optional. Specifies a description of the site. The specified string cannot contain any HTML entities or tags.
brandSafeContent array integer Optional. Specifies brand-safe content. You can specify one or more site tags associated with brand-safe content.
siteTagCategory integer Optional. Specifies the category associated with the site. The specified category must be active.
rtbTransparent integer Optional. Specifies whether the site is transparent to bidders. 1 specifies the site is transparent and 0 specifies the site is semi-transparent. If 0 is specified, the rollupDomain parameter must also be specified.
rollupDomain string Only required if the rtbTransparent parameter is set to 0 (semi-transparent). Specifies the URL you want to be visible to DSPs.

Example JSON response

{
   "data": {
      "userID": 183444,
      "siteID": [
         164144
      ]
   },
   "responseCode": 200,
   "version": "e54d17a3d69c3dda"
}

Response values

Parameter Type Description
userID integer The ID of the user who can access the site information.
siteID array integer The ID(s) of associated site(s).

Delete a site tag

Deletes a publisher’s site tag.

Method

DELETE

URL structure

https://api01.indexexchange.com/api/publishers/sites?siteID=[siteID]

Example request URL

https://api01.indexexchange.com/api/publishers/sites?siteID=52533

Request parameters

Parameter Type Required? Description
siteID integer Required. Indicates the site you want to delete. The specified site must be currently active and accessible to the user.

Example JSON response

{
    "result": "queued",
    "rqid": "2dbd5a877997e355af05659d700ec461",
    "responseCode": 202,
    "version": "cfb004f6d1b37ec1"
}

Response values

Parameter Type Description
result string Indicates whether the action has been queued.
rqid string The ID for the task that has been queued.

Get aliases

Returns information about site aliases.

Method

POST

URL structure

https://api01.indexexchange.com/api/publishers/sites/aliases

Example JSON request body

{
    "siteID": [
        163211,
        164144
    ]
}

Request parameters

Parameter Type Required? Description
siteID array integer Optional. You can specify one or more sites associated with the aliases you want to retrieve. Any specified sites must be currently active and accessible to the user. If siteID is not included in the request, all site aliases associated with the account are returned.

Example JSON response

{
   "data": [
      {
         "siteID": 163211,
         "alias": "http://qhswvqgvtoap.com",
         "status": "A"
      },
      {
         "siteID": 164144,
         "alias": "http://eucioybjpjlo.com",
         "status": "A"
      }
   ],
   "responseCode": 200,
   "version": "e54d17a3d69c3dda"
}

Response values

An array of site alias objects is returned with the following fields.

Parameter Type Description
siteID integer The ID of the site that has the alias.
alias string The URL of the site alias.
status string The status of the site alias. Possible values include: A (active), D (deactivated or deleted) and N (new).

Create an alias

Adds a site alias.

Method

PUT

URL structure

https://api01.indexexchange.com/api/publishers/sites/aliases

Example JSON request body

{
    "siteID": 163211,
    "aliases": [
        "http://ScceQML.com",
        "http://3fB633ML.com"
    ]
}

Request parameters

Parameter Type Required? Description
siteID integer Required. Indicates the site associated with the alias you want to add. The specified site must be currently active and accessible to the user.
aliases array string Required. Specifies one or more site aliases you want to add.

Example JSON response

{
   "data": {
      "siteID": 163211,
      "aliasesAdded": [
         "http://scceqml.com",
         "http://3fb633ml.com"
      ]
   },
   "responseCode": 200,
   "version": "e54d17a3d69c3dda"
}

Response values

Parameter Type Description
siteID integer The ID of the site that has the alias.
aliasesAdded array string An array of the site alias URLs that have been added is returned.

Delete an alias

Deletes a site alias.

Method

DELETE

URL structure

https://api01.indexexchange.com/api/publishers/sites/aliases

Example JSON request body

{
    "siteID": 163211,
    "aliases": [
        "http://ScceQML.com",
        "http://3fB633ML.com"
    ]
}

Request parameters

Parameter Type Required? Description
siteID integer Required. Indicates the site associated with the alias you want to delete. The specified site must be currently active and accessible to the user.
aliases array string Required. Specifies the site alias URLs you want to delete.

Example JSON response

{
   "data": {
      "siteID": 163211,
      "aliasesDeleted": [
         "http://3fb633ml.com",
         "http://scceqml.com"
      ]
   },
   "responseCode": 200,
   "version": "e54d17a3d69c3dda"
}

Response values

Parameter Type Description
siteID integer The ID of the site that has been deleted.
aliasesDeleted array string An array of the site alias URLs that have been deleted is returned.

Get site categories

Returns a list of site categories.

Example JSON response


{
   "data": [
      {
         "categoryID": 2,
         "name": "Tech News",
         "parentName": "Tech & Gaming"
      },
      {
         "categoryID": 4,
         "name": "Fine Arts & Photography",
         "parentName": "Education & Careers"
      },
      {
         "categoryID": 163,
         "name": "Facts & Trivia",
         "parentName": "Education & Careers"
      },
      {
         "categoryID": 164,
         "name": "Comic Strips",
         "parentName": "News & Portals"
      },
      {
         "categoryID": 168,
         "name": "Social Networking",
         "parentName": "Community & Culture"
      }
   ],
   "responseCode": 200,
   "version": "e54d17a3d69c3dda"
}

Method

GET

URL structure

https://api01.indexexchange.com/api/categories/websites

Response values

An array of site category objects is returned with the following fields.

Parameter Type Description
categoryID integer The category ID.
name string The name of the category.
parentName string The name of the parent category.

Users

Get user profile

Returns the account user’s profile information.

Method

GET

URL structure

https://api01.indexexchange.com/api/users/profile

Example JSON Response

{
    "data": {
        "emailAddress": "fatima@emailAccounts.com",
        "firstName": "Fatima",
        "lastName": "Ali",
        "companyName": "Example Company",
        "address1": "4723 Cherry Street",
        "address2": "",
        "zipCode": "42524",
        "city": "Philadelphia",
        "state": "Pennslyvania",
        "country": "US",
        "phone": "(424) 433-7572",
        "fax": "",
        "locale": "en-us",
        "currencyID": "PLN",
        "timeZone": "Indian/Christmas"
    },
    "responseCode": 200,
    "version": "e54d17a3d69c3dda"
}

Response values

Returns a user profile object with the following properties:

Parameter Type Description
emailAddress string The email address of the user.
firstName string The user’s first name.
lastName string The user’s last name.
companyName string The name of the company associated with the user.
address1 string The user’s address.
address2 string The second line of the user’s address.
city string The user’s city.
state string The user’s state.
zipCode string The user’s zip code.
country string The user’s country.
phone string The user’s phone number.
fax string The user’s fax number.
locale string The user’s locale code. For example: “en-us”.
currencyID string The ID associated with the user’s currency.
timezone string The user’s timezone.
Copyright © 2016 Index Exchange