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

Delete order

Request

Security
oauth2
Query
partnerIdstringrequired
orderIdstringrequired
curl -i -X DELETE \
  'https://developers.ascendxnow.com/_mock/asx-docs/asx-api/api/external/v1/order?partnerId=string&orderId=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 order list by partner ID

Request

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

Request

Security
oauth2
Bodyapplication/jsonrequired
budgetMicrosinteger(int64)
descriptionstring
endDatestring

End date in YYYY-MM-DD format

Example: "2025-02-01"
frequencyCappingobject(OrderFrequencyCapping)

Frequency capping for orders

linkedAppAdunitsobject

Map of linked app-adunits. The key is the app ID, value is an array of adunit codes

Example: {"knx00111":[1001,1002],"knx00333":[1003]}
linkedDealIdstring
linkedSitePlacementsobject

Map of linked site-placements. The key is the site ID, value is an array of placement IDs

Example: {"knx00222":["956ef415200a491b","9f491f2239e74e36"],"knx00333":["c80604a283fa4250"]}
namestring
pacingTypestring
Enum"EVEN""ASAP"
partnerIdstring
pausedboolean
startDatestring

Start date in YYYY-MM-DD format

Example: "2025-01-01"
curl -i -X POST \
  https://developers.ascendxnow.com/_mock/asx-docs/asx-api/api/external/v1/order \
  -H 'Authorization: Bearer <YOUR_TOKEN_HERE>' \
  -H 'Content-Type: application/json' \
  -d '{
    "budgetMicros": 0,
    "description": "string",
    "endDate": "2025-02-01",
    "frequencyCapping": {
      "impressionsPerUser": 0,
      "numTimeIntervals": 0,
      "timeInterval": "MINUTE"
    },
    "linkedAppAdunits": {
      "knx00111": [
        1001,
        1002
      ],
      "knx00333": [
        1003
      ]
    },
    "linkedDealId": "string",
    "linkedSitePlacements": {
      "knx00222": [
        "956ef415200a491b",
        "9f491f2239e74e36"
      ],
      "knx00333": [
        "c80604a283fa4250"
      ]
    },
    "name": "string",
    "pacingType": "EVEN",
    "partnerId": "string",
    "paused": true,
    "startDate": "2025-01-01"
  }'

Responses

OK

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

Update an order's mutable fields, by partner and order ID

Request

Security
oauth2
Bodyapplication/jsonrequired
budgetMicrosinteger(int64)
descriptionstring
endDatestring

End date in YYYY-MM-DD format

Example: "2025-02-01"
frequencyCappingobject(OrderFrequencyCapping)

Frequency capping for orders

namestring
orderIdstring
pacingTypestring
Enum"EVEN""ASAP"
partnerIdstring
pausedboolean
startDatestring
curl -i -X PUT \
  https://developers.ascendxnow.com/_mock/asx-docs/asx-api/api/external/v1/order \
  -H 'Authorization: Bearer <YOUR_TOKEN_HERE>' \
  -H 'Content-Type: application/json' \
  -d '{
    "budgetMicros": 0,
    "description": "string",
    "endDate": "2025-02-01",
    "frequencyCapping": {
      "impressionsPerUser": 0,
      "numTimeIntervals": 0,
      "timeInterval": "MINUTE"
    },
    "name": "string",
    "orderId": "string",
    "pacingType": "EVEN",
    "partnerId": "string",
    "paused": true,
    "startDate": "string"
  }'

Responses

OK

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

Query orders by partner ID and other options

Request

Security
oauth2
Query
partnerIdstringrequired
namestring
Default ""
statusstring
reportStartDatestring
Default "1970-01-01"
reportEndDatestring
Default "2037-12-31"
pageinteger(int32)
Default 0
sizeinteger(int32)
Default 10
sortFieldstring
Default "createdTs"
sortDirectionstring
Default "DESC"
Enum"ASC""DESC"
curl -i -X GET \
  'https://developers.ascendxnow.com/_mock/asx-docs/asx-api/api/external/v1/order/page?partnerId=string&status=string&reportStartDate=1970-01-01&reportEndDate=2037-12-31&page=0&size=10&sortField=createdTs&sortDirection=ASC' \
  -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 order details by order ID

Request

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

Responses

OK

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

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