Skip to content

AscendX API (v1.9)

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-stg.ascendxnow.com/

Bidder Network API

APIs related to bidder networks

Operations

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

App API

APIs related to apps

Operations

Adunit API

APIs related to adunits

Operations

Get list of adunits

Request

Security
oauth2
Query
accountstringrequired
searchstring
appendPlacementIdsboolean
Default false
activeboolean
adunitTypestring
Enum"banner""interstitial""rewarded""DISPLAY""VIDEO""NATIVE"
inventoryTypestring
Enum"inapp""website"
pageinteger(int32)
Default 0
sizeinteger(int32)
Default 10
sortFieldstring
Default "name"
Enum"name""active""inventory_type"
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

Request

Security
oauth2
Bodyapplication/jsonrequired
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
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": "string",
    "adunitNetworkLinks": [
      {
        "active": true,
        "networkConfiguration": {
          "property1": "string",
          "property2": "string"
        },
        "networkId": "string",
        "priority": 0,
        "updatedAt": 0
      }
    ],
    "bidSettings": {
      "biddingType": "normal",
      "defaultFloorPrice": 0.1,
      "frequencyCapping": {
        "duration": 0,
        "enabled": true,
        "impressions": 0,
        "timeUnit": "minute"
      },
      "pricingType": "kai"
    },
    "excludedBrands": [
      {
        "name": "string",
        "url": "string"
      }
    ],
    "includedBrands": [
      {
        "name": "string",
        "url": "string"
      }
    ],
    "inventoryType": "inapp",
    "maxVideoDuration": 0,
    "minVideoDuration": 0,
    "name": "string",
    "placementIds": [
      "string"
    ],
    "priceConfigurations": [
      {
        "condition": "time",
        "endTime": 0,
        "price": 0.1,
        "startTime": 0
      }
    ],
    "size": {
      "height": 0,
      "width": 0
    },
    "type": "banner"
  }'

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 brand 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 brand 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)
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
}

Update the adunit's linked placements

Request

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": 0,
        "price": 0.1,
        "startTime": 0
      }
    ]
  }'

Responses

OK

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

Get adunit by id

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
}