Get deal details by deal ID

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

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

Delete deal

Request

Security

oauth2

Query

partnerIdstringrequired

dealIdstringrequired

curl -i -X DELETE \
  'https://developers.ascendxnow.com/_mock/asx-docs/asx-api/api/external/v1/deal?partnerId=string&dealId=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 deal 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/deal?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 deal

Request

Security

oauth2

Bodyapplication/jsonrequired

buyerNetworkIdstring

contractIdstring

dealTypestring

Enum"GUARANTEED""NON_GUARANTEED"

descriptionstring

endDatestring

End date in YYYY-MM-DD format

Example: "2025-02-01"

externalDealIdstring

fixedPriceMicrosinteger(int64)

floorPriceMicrosinteger(int64)

impressionCommitmentinteger(int64)

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]}

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

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/deal \
  -H 'Authorization: Bearer <YOUR_TOKEN_HERE>' \
  -H 'Content-Type: application/json' \
  -d '{
    "buyerNetworkId": "string",
    "contractId": "string",
    "dealType": "GUARANTEED",
    "description": "string",
    "endDate": "2025-02-01",
    "externalDealId": "string",
    "fixedPriceMicros": 0,
    "floorPriceMicros": 0,
    "impressionCommitment": 0,
    "linkedAppAdunits": {
      "knx00111": [
        1001,
        1002
      ],
      "knx00333": [
        1003
      ]
    },
    "linkedSitePlacements": {
      "knx00222": [
        "956ef415200a491b",
        "9f491f2239e74e36"
      ],
      "knx00333": [
        "c80604a283fa4250"
      ]
    },
    "name": "string",
    "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 a deal's mutable fields, by partner and deal ID

Request

Security

oauth2

Bodyapplication/jsonrequired

contractIdstring

dealIdstring

descriptionstring

endDatestring

End date in YYYY-MM-DD format

Example: "2025-02-01"

externalDealIdstring

floorPriceMicrosinteger(int64)

impressionCommitmentinteger(int64)

namestring

partnerIdstring

pausedboolean

startDatestring

Start date in YYYY-MM-DD format

Example: "2025-01-01"

curl -i -X PUT \
  https://developers.ascendxnow.com/_mock/asx-docs/asx-api/api/external/v1/deal \
  -H 'Authorization: Bearer <YOUR_TOKEN_HERE>' \
  -H 'Content-Type: application/json' \
  -d '{
    "contractId": "string",
    "dealId": "string",
    "description": "string",
    "endDate": "2025-02-01",
    "externalDealId": "string",
    "floorPriceMicros": 0,
    "impressionCommitment": 0,
    "name": "string",
    "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
}

Query deals by partner ID and other options

Request

Security

oauth2

Query

partnerIdstringrequired

namestring

statusstring

reportStartDatestring

Default "1970-01-01"

reportEndDatestring

Default "2037-12-31"

pageinteger(int32)

Default 0

sizeinteger(int32)

Default 10

sortFieldstring

Available sort fields: impressions, revenue, name, status, startDate, dealType, createdTs

Default "createdTs"

sortDirectionstring

Default "DESC"

Enum"ASC""DESC"

curl -i -X GET \
  'https://developers.ascendxnow.com/_mock/asx-docs/asx-api/api/external/v1/deal/page?partnerId=string&name=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
}