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

Create/add site account

Request

Security
oauth2
Query
siteToCreateobjectrequired

JSON string containing the site data to create

Examples:

SiteCreate

siteToCreate={"accountType":"SITE","category":["Retail","Ecommerce"],"domainURL":"https://site1.example","name":"AscendX Site 1","partnerId":"asxPartnerID"}
userEmailstringrequired

Email address of the user creating the site

Bodymultipart/form-data
filestring(binary)

Optional logo image file for the site

curl -i -X POST \
  'https://developers.ascendxnow.com/_mock/asx-docs/asx-api/api/external/v1/site?siteToCreate={%22accountType%22%3A%22SITE%22%2C%22category%22%3A%5B%22Retail%22%2C%22Ecommerce%22%5D%2C%22domainURL%22%3A%22https%3A%2F%2Fsite1.example%22%2C%22name%22%3A%22AscendX+Site+1%22%2C%22partnerId%22%3A%22asxPartnerID%22}&userEmail=string' \
  -H 'Authorization: Bearer <YOUR_TOKEN_HERE>' \
  -H 'Content-Type: multipart/form-data' \
  -F file=string

Responses

OK

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

Update site info

Request

Security
oauth2
Query
siteToUpdateobjectrequired

JSON string containing the site data to update. Only site name/url/logo/category can be updated.

Examples:

SiteUpdate

siteToUpdate={"accountType":"SITE","category":["Retail"],"domainURL":"https://site1-new.example","id":"knx000001","name":"AscendX Site 1 - New"}
userEmailstringrequired

Email address of the user updating the site

Bodymultipart/form-data
filestring(binary)

Optional logo image file for the site

curl -i -X PUT \
  'https://developers.ascendxnow.com/_mock/asx-docs/asx-api/api/external/v1/site?siteToUpdate={%22accountType%22%3A%22SITE%22%2C%22category%22%3A%5B%22Retail%22%5D%2C%22domainURL%22%3A%22https%3A%2F%2Fsite1-new.example%22%2C%22id%22%3A%22knx000001%22%2C%22name%22%3A%22AscendX+Site+1+-+New%22}&userEmail=string' \
  -H 'Authorization: Bearer <YOUR_TOKEN_HERE>' \
  -H 'Content-Type: multipart/form-data' \
  -F file=string

Responses

OK

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

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