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

Adunit API

APIs related to adunits

Operations

Get list of adunits

Request

Security
oauth2
Query
accountstringrequired
searchstring
appendPlacementIdsboolean
Default false
activeboolean
adunitTypestring

For app adunits, please use banner, interstitial and rewarded. For site adunits, please use DISPLAY, VIDEO and NATIVE.

Enum"banner""interstitial""rewarded""DISPLAY""VIDEO""NATIVE"
inventoryTypestring
Enum"inapp""website"
pageinteger(int32)
Default 0
sizeinteger(int32)
Default 10
sortFieldstring
Default "name"
sortDirectionstring
Default "DESC"
Enum"ASC""DESC"
curl -i -X GET \
  'https://developers.ascendxnow.com/_mock/asx-docs/asx-api/api/external/v1/adunit?account=string&search=string&appendPlacementIds=false&active=true&adunitType=banner&inventoryType=inapp&page=0&size=10&sortField=name&sortDirection=ASC' \
  -H 'Authorization: Bearer <YOUR_TOKEN_HERE>'

Responses

OK

Body
contentArray of objects(Adunit)
emptyboolean
firstboolean
lastboolean
numberinteger(int32)
numberOfElementsinteger(int32)
pageableobject(PageableObject)
sizeinteger(int32)
sortobject(SortObject)
totalElementsinteger(int64)
totalPagesinteger(int32)
Response
{
  "content": [
    { … }
  ],
  "empty": true,
  "first": true,
  "last": true,
  "number": 0,
  "numberOfElements": 0,
  "pageable": {
    "offset": 0,
    "pageNumber": 0,
    "pageSize": 0,
    "paged": true,
    "sort": { … },
    "unpaged": true
  },
  "size": 0,
  "sort": {
    "empty": true,
    "sorted": true,
    "unsorted": true
  },
  "totalElements": 0,
  "totalPages": 0
}

Create adunit under app/site

Request

Security
oauth2
Bodyapplication/jsonrequired

Create adunit

accountIdstring
adunitNetworkLinksArray of objects(AdunitNetworkLink)
bidSettingsobject(BidSettings)
excludedBrandsArray of objects(Brand)
includedBrandsArray of objects(Brand)
inventoryTypestring
Enum"inapp""website"
maxVideoDurationinteger(int32)
minVideoDurationinteger(int32)
namestring
placementIdsArray of strings
priceConfigurationsArray of objects(FloorPriceConfiguration)
sizeobject(AdunitSize)
typestring

For app adunits, please use banner, interstitial and rewarded. For site adunits, please use DISPLAY, VIDEO and NATIVE.

Enum"banner""interstitial""rewarded""DISPLAY""VIDEO""NATIVE"
curl -i -X POST \
  https://developers.ascendxnow.com/_mock/asx-docs/asx-api/api/external/v1/adunit \
  -H 'Authorization: Bearer <YOUR_TOKEN_HERE>' \
  -H 'Content-Type: application/json' \
  -d '{
    "accountId": "knx000001",
    "adunitNetworkLinks": [],
    "bidSettings": {
      "biddingType": "normal",
      "frequencyCapping": {
        "duration": 0,
        "enabled": true,
        "impressions": 0,
        "timeUnit": "minute"
      },
      "pricingType": "kai"
    },
    "excludedBrands": [],
    "includedBrands": [],
    "inventoryType": "website",
    "name": "Test ad unit",
    "priceConfigurations": [],
    "size": {
      "height": 160,
      "width": 100
    },
    "type": "DISPLAY"
  }'

Responses

OK

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

Update adunit bid settings

Request

Security
oauth2
Bodyapplication/jsonrequired
biddingTypestring
Enum"normal""waterfall"
codeinteger(int64)
defaultFloorPricenumber(double)
frequencyCappingobject(FrequencyCapping)
pricingTypestring
Enum"kai""manual"
curl -i -X PUT \
  https://developers.ascendxnow.com/_mock/asx-docs/asx-api/api/external/v1/adunit/bid_settings \
  -H 'Authorization: Bearer <YOUR_TOKEN_HERE>' \
  -H 'Content-Type: application/json' \
  -d '{
    "biddingType": "normal",
    "code": 0,
    "defaultFloorPrice": 0.1,
    "frequencyCapping": {
      "duration": 0,
      "enabled": true,
      "impressions": 0,
      "timeUnit": "minute"
    },
    "pricingType": "kai"
  }'

Responses

OK

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

Update adunit advertiser exclusions

Request

Security
oauth2
Bodyapplication/jsonrequired
brandListArray of objects(Brand)
codeinteger(int64)
curl -i -X POST \
  https://developers.ascendxnow.com/_mock/asx-docs/asx-api/api/external/v1/adunit/brand/exclude \
  -H 'Authorization: Bearer <YOUR_TOKEN_HERE>' \
  -H 'Content-Type: application/json' \
  -d '{
    "brandList": [
      {
        "name": "string",
        "url": "string"
      }
    ],
    "code": 0
  }'

Responses

OK

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

Update adunit advertiser inclusions

Request

Security
oauth2
Bodyapplication/jsonrequired
brandListArray of objects(Brand)
codeinteger(int64)
curl -i -X POST \
  https://developers.ascendxnow.com/_mock/asx-docs/asx-api/api/external/v1/adunit/brand/include \
  -H 'Authorization: Bearer <YOUR_TOKEN_HERE>' \
  -H 'Content-Type: application/json' \
  -d '{
    "brandList": [
      {
        "name": "string",
        "url": "string"
      }
    ],
    "code": 0
  }'

Responses

OK

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

Deactivate adunit

Request

Security
oauth2
Query
codeinteger(int64)required
curl -i -X PUT \
  'https://developers.ascendxnow.com/_mock/asx-docs/asx-api/api/external/v1/adunit/disable?code=0' \
  -H 'Authorization: Bearer <YOUR_TOKEN_HERE>'

Responses

OK

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

Activate adunit

Request

Security
oauth2
Query
codeinteger(int64)required
curl -i -X PUT \
  'https://developers.ascendxnow.com/_mock/asx-docs/asx-api/api/external/v1/adunit/enable?code=0' \
  -H 'Authorization: Bearer <YOUR_TOKEN_HERE>'

Responses

OK

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

Update adunit info

Request

Security
oauth2
Bodyapplication/jsonrequired
codeinteger(int64)required
maxVideoDurationinteger(int32)
minVideoDurationinteger(int32)
namestring
curl -i -X PUT \
  https://developers.ascendxnow.com/_mock/asx-docs/asx-api/api/external/v1/adunit/info \
  -H 'Authorization: Bearer <YOUR_TOKEN_HERE>' \
  -H 'Content-Type: application/json' \
  -d '{
    "code": 0,
    "maxVideoDuration": 0,
    "minVideoDuration": 0,
    "name": "string"
  }'

Responses

OK

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

Link/unlink placements to adunit

Request

Updates the placements (identified by placementId) linked to the given ad unit (identified by code). Pass an empty placementId array to unlink all placements.

Security
oauth2
Bodyapplication/jsonrequired
codeinteger(int64)
placementIdsArray of strings
curl -i -X PUT \
  https://developers.ascendxnow.com/_mock/asx-docs/asx-api/api/external/v1/adunit/placements \
  -H 'Authorization: Bearer <YOUR_TOKEN_HERE>' \
  -H 'Content-Type: application/json' \
  -d '{
    "code": 0,
    "placementIds": [
      "string"
    ]
  }'

Responses

OK

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

Update adunit floor price configuration

Request

Security
oauth2
Bodyapplication/jsonrequired
codeinteger(int64)
priceConfigurationsArray of objects(FloorPriceConfiguration)
curl -i -X POST \
  https://developers.ascendxnow.com/_mock/asx-docs/asx-api/api/external/v1/adunit/price_configuration \
  -H 'Authorization: Bearer <YOUR_TOKEN_HERE>' \
  -H 'Content-Type: application/json' \
  -d '{
    "code": 0,
    "priceConfigurations": [
      {
        "condition": "time",
        "endTime": 1675209600,
        "price": 0.1,
        "startTime": 1672531200
      }
    ]
  }'

Responses

OK

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

Get adunit summary by accounts

Request

Security
oauth2
Query
account_idsArray of stringsrequired

Comma separated list of account IDs. E.g. account_ids=ACC-1,ACC-2

curl -i -X GET \
  'https://developers.ascendxnow.com/_mock/asx-docs/asx-api/api/external/v1/adunit/summary?account_ids=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
}

Get adunit information by adunit code

Request

Security
oauth2
Path
codeinteger(int64)required
curl -i -X GET \
  'https://developers.ascendxnow.com/_mock/asx-docs/asx-api/api/external/v1/adunit/{code}' \
  -H 'Authorization: Bearer <YOUR_TOKEN_HERE>'

Responses

OK

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