Browse the help center

DSP Partners API endpoints

Endpoint reference for the DSP Partners tag (3 endpoints): Administrators only: the network's OpenRTB demand partners and their settings. Needs the DSP Partners console permission, or the account-side grant of the same name

Reference network manager admin

Administrators only: the network’s OpenRTB demand partners and their settings. Needs the DSP Partners console permission, or the account-side grant of the same name. 3 endpoints, generated from the OpenAPI spec. Authentication, the response envelope, pagination and error codes are shared by all endpoints — see REST API overview. Parameters marked form go in an application/x-www-form-urlencoded request body.

GET /rest-api/dsp-partners.do

Request examples

List the network’s DSP partners.

ParameterInTypeRequiredDescription
namequerystringnoOnly partners whose name contains this, ignoring case
activequerybooleannotrue for the partners that are switched on, false for the retired ones; left out, both
startqueryintegernoSkip this many partners (zero-based position in the name-ordered list). Default 0
limitqueryintegernoHow many partners to return, 1-500. Default 50

Responses: 200 — {success, editable, partners:[{id, name, active, url, …}], returned, total, more}. Errors follow the shared conventions.

GET /rest-api/dsp-partners/{id}.do

Request examples

Read one DSP partner.

ParameterInTypeRequiredDescription
idpathintegeryesThe partner’s id

Responses: 200 — {success, editable, partner:{id, name, active, url, parameters, analyticsSync, …}} · 404 — No partner with this id. Errors follow the shared conventions.

POST /rest-api/dsp-partners/{id}.do

Request examples

Change one DSP partner’s settings.

ParameterInTypeRequiredDescription
idpathintegeryesThe partner’s id
nameformstringnoThe partner’s name, as the console and the reports show it
activeformbooleannoWhether the partner is asked for bids at all; a switched-off partner keeps the creatives that name it
urlformstringnoThe bid endpoint this partner is asked at
timeoutformintegernoMilliseconds the bid may take, 0-30000; it is also the tmax the request carries
nurlTimeoutformintegernoMilliseconds a win or loss notice may take, 0-60000; empty for the platform default of 5000
maxQueriesPerSecondformintegernoMost bid requests a second this partner is sent; 0 blocks it, empty is unlimited
pricingModelformstringnoWhat the partner is billed on: CPM, CPC or CPI. A model that does not match how it reports books zero Values: CPM, CPC, CPI.
protocolVersionformstringnoThe OpenRTB version the bid request is written in Values: V_2_2, V_2_3_1, V_2_4, V_2_5, V_2_6.
nativeProtocolVersionformstringnoThe OpenRTB Native version a native bid request is written in Values: V_1_0, V_1_1, V_1_2.
encryptionTypeformstringnoHow the macros this partner is sent are encrypted: NO_ENCRYPTION, BASE64 or BLOWFISH Values: NO_ENCRYPTION, BASE64, BLOWFISH.
secondPriceOnlyformbooleannoSettle a win at the runner-up’s price rather than the bid
headerBiddingEnabledformbooleannoAsk this partner on header-bidding requests as well
gzipBidRequestformbooleannoSend the bid request gzipped
wrapClickThroughformbooleannoCount the click here before sending the visitor on to the partner’s landing page
nativeRequestWrapformbooleannoWrap the native bid request in its OpenRTB envelope
nativeResponseWrapformbooleannoExpect the native bid response in its OpenRTB envelope
creativeScanProviderformstringnoWhich provider scans this partner’s creatives: MEDIA_TRUST, GEO_EDGE, or NONE to trust them unscanned. A provider the network has no account for is refused

Responses: 200 — {success, id, changed:[…]} · 404 — No partner with this id. Errors follow the shared conventions.

Related pages

Please disable Adblock
Are you using adblock? Disable it and reload the page to proceed to the destination page.

A registration has already been submitted from this page. Please try again in 10 minutes.