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

Get performance breakdown by time/geo/network

Request

Security
oauth2
Path
typestringrequired
Bodyapplication/jsonrequired
accountstring
accountsArray of strings
countriesArray of strings
endDatestring
networksArray of strings
partnerstring
sortBystring

Please note: Sort by impressions/revenue is only available for geo or network reports. Sort by date is only available for time reports (/analytics/performance/breakdown/time).

Enum"revenue""impressions""date"
startDatestring
curl -i -X POST \
  'https://developers.ascendxnow.com/_mock/asx-docs/asx-api/api/external/v1/analytics/performance/breakdown/{type}' \
  -H 'Authorization: Bearer <YOUR_TOKEN_HERE>' \
  -H 'Content-Type: application/json' \
  -d '{
    "account": "string",
    "accounts": [
      "string"
    ],
    "countries": [
      "string"
    ],
    "endDate": "string",
    "networks": [
      "string"
    ],
    "partner": "string",
    "sortBy": "revenue",
    "startDate": "string"
  }'

Responses

OK

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

Get deal performance breakdown

Request

Security
oauth2
Bodyapplication/jsonrequired

Deal analytics request

accountstring
accountsArray of strings
countriesArray of strings
endDatestring
networksArray of strings
partnerstring
sortBystring

Please note: Sort by impressions/revenue is only available for geo or network reports. Sort by date is only available for time reports (/analytics/performance/breakdown/time).

Enum"revenue""impressions""date"
startDatestring
curl -i -X POST \
  https://developers.ascendxnow.com/_mock/asx-docs/asx-api/api/external/v1/analytics/performance/deal \
  -H 'Authorization: Bearer <YOUR_TOKEN_HERE>' \
  -H 'Content-Type: application/json' \
  -d '{
    "endDate": "2026-01-02",
    "partner": "asxPartner0001",
    "startDate": "2026-01-01"
  }'

Responses

OK

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

Get overall performance between a start and end date

Request

Security
oauth2
Bodyapplication/jsonrequired
accountstring
accountsArray of strings
countriesArray of strings
endDatestring
networksArray of strings
partnerstring
sortBystring

Please note: Sort by impressions/revenue is only available for geo or network reports. Sort by date is only available for time reports (/analytics/performance/breakdown/time).

Enum"revenue""impressions""date"
startDatestring
curl -i -X POST \
  https://developers.ascendxnow.com/_mock/asx-docs/asx-api/api/external/v1/analytics/performance/overall \
  -H 'Authorization: Bearer <YOUR_TOKEN_HERE>' \
  -H 'Content-Type: application/json' \
  -d '{
    "account": "string",
    "accounts": [
      "string"
    ],
    "countries": [
      "string"
    ],
    "endDate": "string",
    "networks": [
      "string"
    ],
    "partner": "string",
    "sortBy": "revenue",
    "startDate": "string"
  }'

Responses

OK

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

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