Skip to content

AscendX API (v1.19)

Download OpenAPI description
asx-api.json
asx-api.yaml
Languages
Servers
Mock server
https://developers.ascendxnow.com/_mock/asx-docs/asx-api
Generated server url
https://console-qa.ascendxnow.com

Location API

APIs to query countries, states, etc

Operations

Placement API

APIs related to placement

Operations

Analytics API

APIs to get performance metrics

Operations

Partner API

APIs related to partners

Operations

Site API

APIs related to sites.

Operations

Account API

APIs related to account

Operations

Mobile App API

APIs to query mobile app details

Operations

Order API

PLEASE NOTE: For all fields labelled micros (eg budgetMicros), one currency = 1000000 micros. Please pass 1000000 in order to set the field as $1.00 USD.

Operations

App API

APIs related to apps

Operations

Deal API

PLEASE NOTE: For all fields labelled micros (eg fixedPriceMicros, floorPriceMicros), one currency = 1000000 micros. Please pass 1000000 in order to set the field as $1.00 USD.

Operations

Bidder Network API

APIs related to bidder networks.

The following are the parameter requirements for network activation:

networkId: appnexus

  • accountRequirements:
  • adunitRequirements: placementId
  • partnerRequirements:

networkId: audienceNetwork

  • accountRequirements: appId,appSecret
  • adunitRequirements: placementId
  • partnerRequirements:

networkId: bluesea

  • accountRequirements:
  • adunitRequirements:
  • partnerRequirements:

networkId: criteo

  • accountRequirements:
  • adunitRequirements:
  • partnerRequirements: networkId

networkId: inmobi

  • accountRequirements:
  • adunitRequirements: placementId
  • partnerRequirements: publisherId

networkId: knorex

  • accountRequirements:
  • adunitRequirements:
  • partnerRequirements:

networkId: limelightDigital

  • accountRequirements:
  • adunitRequirements:
  • partnerRequirements:

networkId: pangle

  • accountRequirements: appId,accessToken
  • adunitRequirements: placementId
  • partnerRequirements:

networkId: pubmatic

  • accountRequirements:
  • adunitRequirements:
  • partnerRequirements: publisherId

networkId: pubnative

  • accountRequirements:
  • adunitRequirements:
  • partnerRequirements: appAuthToken

networkId: smaato

  • accountRequirements:
  • adunitRequirements:
  • partnerRequirements:

networkId: taboola

  • accountRequirements:
  • adunitRequirements:
  • partnerRequirements: publisherId

networkId: teads

  • accountRequirements:
  • adunitRequirements: placementId
  • partnerRequirements:

networkId: thetradedesk

  • accountRequirements:
  • adunitRequirements:
  • partnerRequirements: supplyId,publisherId

networkId: tradplus

  • accountRequirements:
  • adunitRequirements:
  • partnerRequirements:

networkId: vungle

  • accountRequirements: appStoreId
  • adunitRequirements: placementId
  • partnerRequirements:

networkId: yahooAds

  • accountRequirements:
  • adunitRequirements: placementId,siteId
  • partnerRequirements:

networkId: yandex

  • accountRequirements:
  • adunitRequirements: placementId
  • partnerRequirements:

networkId: zmaticoo

  • accountRequirements:
  • adunitRequirements:
  • partnerRequirements:
Operations

Get bidder networks

Request

Security
oauth2
Query
partnerstringrequired
accountstring
curl -i -X GET \
  'https://developers.ascendxnow.com/_mock/asx-docs/asx-api/api/external/v1/network?partner=string&account=string' \
  -H 'Authorization: Bearer <YOUR_TOKEN_HERE>'

Responses

Get bidder network details by partner and account

Bodyapplication/json
Response
application/json
{
  "data": [
    { … }
  ],
  "success": true
}

Activate bidder network at account level

Request

Security
oauth2
Bodyapplication/jsonrequired
accountIdstring
activeboolean
configurationobject
networkIdstring
partnerIdstring
curl -i -X POST \
  https://developers.ascendxnow.com/_mock/asx-docs/asx-api/api/external/v1/network/account/activate \
  -H 'Authorization: Bearer <YOUR_TOKEN_HERE>' \
  -H 'Content-Type: application/json' \
  -d '{
    "accountId": "string",
    "active": true,
    "configuration": {
      "property1": "string",
      "property2": "string"
    },
    "networkId": "string",
    "partnerId": "string"
  }'

Responses

OK

Bodyapplication/json
Response
application/json
{
  "success": true
}

Deactivate bidder network at account level

Request

Security
oauth2
Bodyapplication/jsonrequired
accountIdstring
activeboolean
configurationobject
networkIdstring
partnerIdstring
curl -i -X POST \
  https://developers.ascendxnow.com/_mock/asx-docs/asx-api/api/external/v1/network/account/deactivate \
  -H 'Authorization: Bearer <YOUR_TOKEN_HERE>' \
  -H 'Content-Type: application/json' \
  -d '{
    "accountId": "string",
    "active": true,
    "configuration": {
      "property1": "string",
      "property2": "string"
    },
    "networkId": "string",
    "partnerId": "string"
  }'

Responses

OK

Bodyapplication/json
Response
application/json
{
  "success": true
}

Activate bidder network at adunit level

Request

Security
oauth2
Bodyapplication/jsonrequired
accountIdstring
adunitIdinteger(int64)
configurationobject
networkIdstring
priorityinteger(int32)
curl -i -X POST \
  https://developers.ascendxnow.com/_mock/asx-docs/asx-api/api/external/v1/network/adunit/activate \
  -H 'Authorization: Bearer <YOUR_TOKEN_HERE>' \
  -H 'Content-Type: application/json' \
  -d '{
    "accountId": "string",
    "adunitId": 0,
    "configuration": {
      "property1": "string",
      "property2": "string"
    },
    "networkId": "string",
    "priority": 0
  }'

Responses

OK

Body*/*
emptyboolean
partialObjectboolean
property name*anyadditional property

Deactivate bidder network at adunit level

Request

Security
oauth2
Bodyapplication/jsonrequired
accountIdstring
adunitIdinteger(int64)
configurationobject
networkIdstring
priorityinteger(int32)
curl -i -X POST \
  https://developers.ascendxnow.com/_mock/asx-docs/asx-api/api/external/v1/network/adunit/deactivate \
  -H 'Authorization: Bearer <YOUR_TOKEN_HERE>' \
  -H 'Content-Type: application/json' \
  -d '{
    "accountId": "string",
    "adunitId": 0,
    "configuration": {
      "property1": "string",
      "property2": "string"
    },
    "networkId": "string",
    "priority": 0
  }'

Responses

OK

Bodyapplication/json
Response
application/json
{
  "success": true
}

Connect bidder network at partner level

Request

Security
oauth2
Bodyapplication/jsonrequired
accountRequirementsArray of strings
activeboolean
adunitRequirementsArray of strings
configurationobject
connectedboolean
idstring
networkIdstring
partnerIdstring
updatedAtinteger(int64)
curl -i -X POST \
  https://developers.ascendxnow.com/_mock/asx-docs/asx-api/api/external/v1/network/partner/connect \
  -H 'Authorization: Bearer <YOUR_TOKEN_HERE>' \
  -H 'Content-Type: application/json' \
  -d '{
    "accountRequirements": [
      "string"
    ],
    "active": true,
    "adunitRequirements": [
      "string"
    ],
    "configuration": {
      "property1": "string",
      "property2": "string"
    },
    "connected": true,
    "id": "string",
    "networkId": "string",
    "partnerId": "string",
    "updatedAt": 0
  }'

Responses

OK

Bodyapplication/json
Response
application/json
{
  "data": {
    "accountRequirements": [ … ],
    "active": true,
    "adunitRequirements": [ … ],
    "configuration": {},
    "connected": true,
    "id": "68f0554b83c0a3a0ebed7be5",
    "networkId": "audienceNetwork",
    "partnerId": "Zmpfk6dgewj7",
    "updatedAt": 1760683531
  },
  "success": true
}

Disable bidder network at partner level

Request

Security
oauth2
Query
partnerstringrequired
networkstringrequired
curl -i -X PUT \
  'https://developers.ascendxnow.com/_mock/asx-docs/asx-api/api/external/v1/network/partner/disable?partner=string&network=string' \
  -H 'Authorization: Bearer <YOUR_TOKEN_HERE>'

Responses

OK

Body
emptyboolean
partialObjectboolean
property name*anyadditional property
Response
{
  "empty": true,
  "partialObject": true,
  "property1": null,
  "property2": null
}

Enable bidder network at partner level

Request

Security
oauth2
Query
partnerstringrequired
networkstringrequired
curl -i -X PUT \
  'https://developers.ascendxnow.com/_mock/asx-docs/asx-api/api/external/v1/network/partner/enable?partner=string&network=string' \
  -H 'Authorization: Bearer <YOUR_TOKEN_HERE>'

Responses

OK

Bodyapplication/json
Response
application/json
{
  "data": {
    "accountRequirements": [ … ],
    "active": true,
    "adunitRequirements": [ … ],
    "configuration": {},
    "connected": true,
    "id": "68f0554b83c0a3a0ebed7be5",
    "networkId": "audienceNetwork",
    "partnerId": "Zmpfk6dgewj7",
    "updatedAt": 1760680144
  },
  "success": true
}

Adunit API

APIs related to adunits

Operations