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

Get placements by site ID

Request

Security
oauth2
Query
siteIdstringrequired
curl -i -X GET \
  'https://developers.ascendxnow.com/_mock/asx-docs/asx-api/api/external/v1/placement?siteId=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
}

Create placement

Request

Please note that placements only support DISPLAY, NATIVE and VIDEO adunit types (supportedAdFormats).

Security
oauth2
Bodyapplication/jsonrequired

Create placement

adunitIdsArray of integers(int64)
descriptionstring
namestring
placementIdstring
siteIdstring
supportedAdFormatsArray of strings
Items Enum"banner""interstitial""rewarded""DISPLAY""VIDEO""NATIVE"
supportedSizesArray of objects(AdunitSize)
curl -i -X POST \
  https://developers.ascendxnow.com/_mock/asx-docs/asx-api/api/external/v1/placement \
  -H 'Authorization: Bearer <YOUR_TOKEN_HERE>' \
  -H 'Content-Type: application/json' \
  -d '{
    "adunitIds": [
      1001
    ],
    "description": "My Test Placement",
    "name": "Test Placement",
    "siteId": "knx00001",
    "supportedAdFormats": [
      "VIDEO",
      "NATIVE"
    ],
    "supportedSizes": [
      {
        "height": 250,
        "width": 300
      }
    ]
  }'

Responses

OK

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

Deactivate placement

Request

Security
oauth2
Query
placementIdstringrequired
curl -i -X PUT \
  'https://developers.ascendxnow.com/_mock/asx-docs/asx-api/api/external/v1/placement/deactivate?placementId=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
}

Update placement info

Request

Security
oauth2
Bodyapplication/jsonrequired
descriptionstring
namestring
placementIdstring
curl -i -X PUT \
  https://developers.ascendxnow.com/_mock/asx-docs/asx-api/api/external/v1/placement/info \
  -H 'Authorization: Bearer <YOUR_TOKEN_HERE>' \
  -H 'Content-Type: application/json' \
  -d '{
    "description": "string",
    "name": "string",
    "placementId": "string"
  }'

Responses

OK

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

Reactivate placement

Request

Security
oauth2
Query
placementIdstringrequired
curl -i -X PUT \
  'https://developers.ascendxnow.com/_mock/asx-docs/asx-api/api/external/v1/placement/reactivate?placementId=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 placement summaries by site IDs

Request

Security
oauth2
Query
site_idsArray of stringsrequired

Comma separated list of site IDs. E.g. site_ids=SITE-1,SITE-2

curl -i -X GET \
  'https://developers.ascendxnow.com/_mock/asx-docs/asx-api/api/external/v1/placement/summary?site_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 placement by placement ID

Request

Security
oauth2
Path
placementIdstringrequired
curl -i -X GET \
  'https://developers.ascendxnow.com/_mock/asx-docs/asx-api/api/external/v1/placement/{placementId}' \
  -H 'Authorization: Bearer <YOUR_TOKEN_HERE>'

Responses

OK

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

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