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

Get list of partners

Request

Security
oauth2
curl -i -X GET \
  https://developers.ascendxnow.com/_mock/asx-docs/asx-api/api/external/v1/partner \
  -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 partner details

Request

Security
oauth2
Query
dataobjectrequired

JSON string containing the partner data to update

Examples:

PartnerUpdate

data={"id":"asxPartnerID","name":"AscendX Partner 1","url":"https://ascendxnow.com"}
Bodymultipart/form-data
filestring(binary)

Optional logo image file for the partner

curl -i -X PUT \
  'https://developers.ascendxnow.com/_mock/asx-docs/asx-api/api/external/v1/partner?data={%22id%22%3A%22asxPartnerID%22%2C%22name%22%3A%22AscendX+Partner+1%22%2C%22url%22%3A%22https%3A%2F%2Fascendxnow.com%22}' \
  -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 partner billing address

Request

Security
oauth2
Bodyapplication/jsonrequired
address1string
address2string
citystring
countrystring
idstring
postalCodestring
statestring
stateCodestring
curl -i -X PUT \
  https://developers.ascendxnow.com/_mock/asx-docs/asx-api/api/external/v1/partner/billing_address \
  -H 'Authorization: Bearer <YOUR_TOKEN_HERE>' \
  -H 'Content-Type: application/json' \
  -d '{
    "address1": "string",
    "address2": "string",
    "city": "string",
    "country": "string",
    "id": "string",
    "postalCode": "string",
    "state": "string",
    "stateCode": "string"
  }'

Responses

OK

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

Update partner billing contact

Request

Security
oauth2
Bodyapplication/jsonrequired
companystring
emailstring
idstring
namestring
sendEmailboolean
curl -i -X PUT \
  https://developers.ascendxnow.com/_mock/asx-docs/asx-api/api/external/v1/partner/billing_contact \
  -H 'Authorization: Bearer <YOUR_TOKEN_HERE>' \
  -H 'Content-Type: application/json' \
  -d '{
    "company": "string",
    "email": "string",
    "id": "string",
    "name": "string",
    "sendEmail": true
  }'

Responses

OK

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

Get partner info by ID

Request

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

Responses

OK

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

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