Inventory Marketplace API — Migration Guide

Greta
Greta
  • Updated

API Name (Version)

Deprecation Date

Sunset Date

Inventory API

June 27, 2025

January 30, 2026

Inventories Search API

June 27, 2025

January 30, 2026

With the new read-only Inventory Marketplace API you can retrieve available inventories, deals, domains, and apps to support line item creation and updates. This API provides access to inventory data from the bid stream data, which includes channels, ad sizes, and ad types. In comparison, the old Inventory API and Inventories Search API provided static information (creative settings) that was set on Inventory profile.

If you have been using any Inventory API or Inventories Search API endpoints, follow this guide to migrate to Inventory Marketplace API before the sunset date (December 31, 2025). For more information about using Inventory Marketplace API to set up inventory targeting for programmatic line item, see Set Up Inventory With API.

Understand Affected API Endpoints

Inventories API

Endpoints

Use Cases and Comments

Deprecated: GET /dsp/v1/creativesettings

 

Use case: No usage

Creative settings are static information, set in Inventory settings, and aren't based on actual bid requests.

Users can now get actual information from bid stream data by using Inventory Marketplace API - Ad types, Channels and Ad sizes can be retrieved together with Inventory Sources, Deals, Apps and Domains data.

Deprecated: GET /dsp/v1/creativesettings/classificator/{type}

Use case: No usage

Creative settings are static information, set in Inventory settings, and aren't based on actual bid requests.

Users can now get actual information from bid stream data by using Inventory Marketplace API - Ad types, Channels and Ad sizes can be retrieved together with Inventory Sources, Deals, Apps and Domains data.

Deprecated: GET /dsp/v1/deals/{parentSourceId}/{sourceType}/{sourceId}/advertiser-ids

Use case: Get a list of advertisers that are allowed to see the specified deal.

At the moment, access to deal advertisers is only available through Deal Management UI.

Deprecated: PUT /dsp/v1/deals/{parentSourceId}/{sourceType}/{sourceId}/advertiser-ids

Use case: Update a list of advertisers that are allowed to see the specified deal.

At the moment, modification of deal advertisers is only available through Deal Management UI.

Deprecated: GET /dsp/v1/deals/inventorySources

Introduced: POST /v1/buyer/marketplace/inventories/inventorysources/list

Use case: Retrieve a list of available inventory sources.

mustHaveDeals and mustSupportManualDeals filters were deprecated.

Deprecated: GET /dsp/v1/deals

Introduced: POST /v1/buyer/marketplace/inventories/deals/list

Use case: Retrieve a list of available deals.

  • Supports filtering only by a single inventorySourceId instead of multiple.

  • Supports filtering only by a single advertiserId instead of multiple.

  • The search filter was replaced with an option to filter by individual deal properties.

  • The dealState filter was removed, because only accepted deals are available in the Inventory Marketplace.

Deprecated: POST /dsp/v1/deals

Use case: Create a manual deal.

At the moment, the creation of manual deals is available through Deal Management UI.

Deprecated: GET /dsp/v1/deals/{parentSourceId}/{sourceType}/{sourceId}

Introduced: GET /v1/buyer/marketplace/inventories/deals/{dealId}/{inventorySourceId}

Use case: Get details of the single deal.

Deal sourceType is no longer needed to identify a single deal.

Deprecated: PUT /dsp/v1/deals/{parentSourceId}/{sourceType}/{sourceId}

Deprecated: PATCH dsp/v1/deals/{parentSourceId}/{sourceType}/{sourceId}

Use case: Update deal state.

At the moment, changing deal state is available through Deal Management UI.

Deprecated: GET /dsp/v1/inventoriesoverview/available

Introduced: POST /v1/buyer/marketplace/inventories/inventorysources/list

Introduced: POST /v1/buyer/marketplace/inventories/deals/list

Use case: Retrieve lists of available inventory sources and deals.

  • activityId and campaignId filters deprecated and replaced with advertiserId filter. When Line Item ID or Campaign ID is known, Advertiser ID can be retrieved from a campaign by calling Campaigns Management API.

  • supportedBy filter is replaced with environmentcpmvEnabled filter is deprecated.

Deprecated: GET /dsp/v1/inventoriesoverview/{parentSourceId}/{sourceType}/{sourceId}

Introduced: /v1/buyer/marketplace/inventories/inventorysources/{inventorySourceId}

Use case: Get details of the single inventory source.

Deprecated: GET /dsp/v1/inventoriesoverview

Deprecated: POST /dsp/v1/inventoriesoverview/bulk

Introduced: POST /v1/buyer/marketplace/inventories/inventorysources/list

Introduced: POST /v1/buyer/marketplace/inventories/deals/list

Use case: Retrieve lists of available inventory sources and deals.

  • activityId and campaignId filters deprecated and replaced with advertiserId filter. When Line Item ID or Campaign ID is known, Advertiser ID can be retrieved from a campaign by calling Campaigns Managemegnt API.

  • parentSourceId filter replaced with inventorySourceId when requesting available deals.

  • bannerType filter replaced with dspAdTypes.

  • richMediaSubtype filter deprecated.

  • country filter replaced with countryIds. Supported list of country IDs can be retrieved from Classifiers API.

  • size filter replaced with adSizes.

  • iabCategory filter replaced with iabCategoryIds. Supported list of IAB Category IDs can be retrieved from Classifiers API.

  • inventoryType filter is deprecated and replaced with different endpoints.

  • Package inventory is deprecated.

  • search filter is deprecated.

  • orderBy and orderDirection options are deprecated. Inventory Marketplace API returns lists ordered internally by entity ID.

  • supportedBy filter is replaced with environment.

  • cpmvEnabled filter is deprecated.

  • viewThumbnails option is deprecated.

  • inventoryIds filter replaced with inventorySourceId, but limited to a single inventory source only.

  • packageIds filter is deprecated.

  • Impressions response properties deprecated.

Deprecated: GET /dsp/v1/inventoriesoverview/logos

Use case: No usage

Inventories Search API

Endpoints to Deprecate

New Endpoints

Use Case

POST /v1/buyer/inventories/deals/search

POST /v1/buyer/marketplace/inventories/deals/list

Retrieve a list of available deals.

POST /v1/buyer/inventories/deals/facets/{dealFacetType}

No usage

POST /v1/buyer/inventories/inventorysources/search

POST /v1/buyer/marketplace/inventories/inventorysources/list

Retrieve a list of available inventory sources.

POST /v1/buyer/inventories/inventorysources/facets/{inventorySourceFacetType}

No usage

New Endpoints in Inventory Marketplace API

New Endpoints

Use Case

POST /v1/buyer/marketplace/inventories/adexchanges/list

Retrieve a list of available ad exchanges.

POST /v1/buyer/marketplace/inventories/domains/list

Retrieve a list of available domains.

GET /v1/buyer/marketplace/inventories/domains/{domain}

Get domain details by domain name.

POST /v1/buyer/marketplace/inventories/apps/list

Retrieve a list of available apps.

GET /v1/buyer/marketplace/inventories/apps/{storeId}/{id}

Get app details by app ID and store ID

Retrieval of KPIs for Inventory Sources, Deals, Domains, and Apps

Endpoints to Deprecate

New Endpoints

Use Case

Comments

GET /dsp/v1/inventoriesoverview

POST /dsp/v1/inventoriesoverview/bulk

POST /v2/market/stats/reports

GET /v2/market/stats/operations

GET /v2/market/stats/operations/{id}

GET /v2/market/stats/reports/{id}

Retrieve performance KPIs of inventory sources, deals, domains, subdomains, apps.

eCPM, eCPC, CTR metrics are deprecated. Performance KPIs for wanted inventory sources, deals, apps and domains can be retrieved from Inventory Marketplace Stats API.

To retrieve KPIs for inventory, you can follow a similar workflow described in Guide to Generating Advertiser Reports With API.

POST /v1/buyer/inventories/inventorysources/search

POST /v1/buyer/inventories/deals/search

New Features Introduced With Inventory Marketplace API

  • Inventory information can be accessed through two types of endpoints:

    • POST endpoints allow users to retrieve lists of available ad exchanges, inventory sources, deals, domains, and apps, along with parameters derived from bid-stream data such as channels, ad types, and environments. Furthermore, users have the ability to filter on most of the inventory properties and have flexible control of the response model.

    • GET endpoints provide more detailed information about specific inventory items. These include additional parameters like ad sizes, countries, and IAB categories, which are also based on bid-stream data.

  • Users can retrieve a list of available ad exchanges.

  • New deal identity: InventorySourceId+DealId. Deals are no longer recognized with SourceType+IntegerDealId+InventorySourceId identification.

Breaking Changes

See the new authorization scopes as well as request samples and field parameters that change when migrating from Inventory API and Inventories Search API to Inventory Marketplace API.

Note

Existing API users have already been assigned the new scopes for Inventory Marketplace API. New users need to request the new scope from Adform Support (technical@adform.com).

Authorization

To make API requests to the Inventory Marketplace API, you need a valid bearer token with the appropriate scopes:

Previous Scopes

New Scopes

api.adform.com/scope/marketplace.inventory.search.api: Grants full access to the Inventories Search API.

api.adform.com/scope/buyer.marketplace.inventories.readonly: Grants read-only access to the Inventory Marketplace API

https://api.adform.com/scope/market.stats: Grants access to the Inventory Marketplace Stats API.

Tip

For more information about authorizing with Adform APIs, see the Authorization Guide.

Retrieve Available Inventory Sources list

Inventory API endpoints (GET /dsp/v1/inventoriesoverview/available, GET /dsp/v1/inventoriesoverview, POST /dsp/v1/inventoriesoverview/bulk), and Inventories Search API endpoint (POST /v1/buyer/inventories/inventorysources/search) are replaced by Inventory Marketplace API endpoint (POST /v1/buyer/marketplace/inventories/inventorysources/list).

Use the new endpoint to retrieve a list of available inventory sources.

See the changes in the response body and the new or changed parameters described below.

Response Body Example and Parameters

Inventory API GET /dsp/v1/inventoriesoverview/available response body example:

{
  "SourceType": "InventorySource",
  "InventorySourceId": 0,
  "InventorySourceName": "string",
  "SourceId": 0,
  "SourceName": "string",
  "PartyId": 0,
  "DealId": "string",
  "SupportsDeals": true,
  "SupportedBy": "Display"

Inventory API GET /dsp/v1/inventoriesoverview response body example:

[
  {
    "ParentSourceId": 0,
    "ParentSourceName": "string",
    "SourceId": 0,
    "SourceType": "InventorySource",
    "SourceName": "string",
    "ManualDealId": "string",
    "PartyId": 0,
    "ActivityId": 0,
    "DealCount": 0,
    "PackageCount": 0,
    "Impressions": 0,
    "Cpm": 0,
    "Cpc": 0,
    "Ctr": 0
  }
]

Inventory API POST /dsp/v1/inventoriesoverview/bulk response body example:

[
  {
    "ParentSourceId": 0,
    "ParentSourceName": "string",
    "SourceId": 0,
    "SourceType": "InventorySource",
    "SourceName": "string",
    "ManualDealId": "string",
    "PartyId": 0,
    "ActivityId": 0,
    "DealCount": 0,
    "PackageCount": 0,
    "Impressions": 0,
    "Cpm": 0,
    "Cpc": 0,
    "Ctr": 0
  }

Inventories Search API POST /v1/buyer/inventories/inventorysources/search response body example:

[
  {
    "id": 44,
    "name": "Inventory Source 1",
    "country": {
      "id": 23,
      "name": "USA"
    },
    "party": {
      "id": 4,
      "name": "Party name"
    },
    "logo": "base64-content-here",
    "logoContentType": "image/png",
    "channels": [
      {
        "id": 1,
        "name": "Channel 1"
      },
      {
        "id": 2,
        "name": "Channel 2"
      }
    ],
    "bannerTypes": [
      {
        "id": 1,
        "name": "Banner Type Video",
        "subTypes": [
          {
            "id": 3,
            "name": "Short video"
          },
          {
            "id": 4,
            "name": "Long video"
          }
        ]
      },
      {
        "id": 2,
        "name": "Banner type 2"
      }
    ],
    "sizes": [
      {
        "width": 20,
        "height": 100
      },
      {
        "width": 50,
        "height": 50
      }
    ],
    "iabCategories": [
      {
        "id": 4,
        "name": "Humor"
      },
      {
        "id": 5,
        "name": "Movies"
      }
    ],
    "ecpm": 1.34,
    "ecpc": 2.32,
    "ctr": 32.21,
    "currencyCode": "EUR",
    "statisticCurrencyCode": "USD",
    "statisticLastUpdated": "2025-04-22T05:31:25.6135992+00:00",
    "campaignCurrencyCode": "UER",
    "availableDealsCount": 32,
    "highlight": {
      "name": "best"
    }
  }
]

Inventory Marketplace API POST /v1/buyer/marketplace/inventories/inventorysources/list response body example:

[
  {
    "id": 1,
    "name": "InventorySource-1",
    "adExchangeId": 7,
    "channels": [
      "audio",
      "native"
    ],
    "dspAdTypes": [
      "image",
      "link",
      "keyword"
    ],
    "environments": [
      "web",
      "app"
    ]
  }
]

Inventory Marketplace API Retrieve Inventory Sources list Parameters:

Name

Required or Optional

Description

Example Value

Type

advertiserId

Optional

When advertiserId isn't provided, inventory sources available to the whole agency are returned

ID of the advertiser that has access to inventories

"advertiserId": 1,

Integer

inventorySourceIds

Optional

IDs of inventory sources the user wants to retrieve

 
"inventorySourceIds": [
    1,
    2,
    3
  ],

Array of integers

adExchangeIds

Optional

IDs of ad exchanges the user wants to retrieve

 
"adExchangeIds": [
    10,
    20,
    30
  ],

Array of integers

channels

Optional

Filter inventories by channel

 
"channels": [
    "audio"
  ],

Array of enums

countryIds

Optional

Country IDs, of the retrieved inventory sources

 
"countryIds": [
    77,
    78
  ],

Array of integers

dspAdTypes

Optional

Ad types of the retrieved inventory sources

 
"dspAdTypes": [
    "image",
    "link",
    "keyword"
  ],

Array of enums

adSizes

Optional

Ad sizes of the retrieved inventory sources

 
"adSizes": [
    {
      "width": 200,
      "height": 400
    }
  ],"

Array of objects

iabCategoryIds

Optional

IAB category IDs of the retrieved inventory sources

 
 "iabCategoryIds": [
    99
  ],

Array of integers

environments

Optional

Environments of the retrieved inventory sources

 
"environments": [
    "app",
    "web"
  ]

Array of enums

Retrieve Inventory source details

Inventory API endpoint GET /dsp/v1/inventoriesoverview/{parentSourceId}/{sourceType}/{sourceId} is replaced by Inventory Marketplace API endpoint GET /v1/buyer/marketplace/inventories/inventorysources/{inventorySourceId}.

Use the new endpoint to retrieve details of the needed inventory source. See the changes in the response body and the new or changed parameters described below.

Response Body Examples and Parameters

Inventory API GET /dsp/v1/inventoriesoverview/{parentSourceId}/{sourceType}/{sourceId} response body example:

[
  {
    "ParentSourceId": 0,
    "ParentSourceName": "string",
    "SourceId": 0,
    "PartyId": 0,
    "SourceType": "InventorySource",
    "SourceName": "string",
    "ManualDealId": "string",
    "Description": "string",
    "TermsAndConditions": "string",
    "SupportedBy": "Display",
    "Impressions": 0,
    "Cpm": 0,
    "Cpc": 0,
    "Ctr": 0,
    "BannerSizes": [
      {
        "Width": 0,
        "Height": 0,
        "Id": 0,
        "IsNew": true
      }
    ],
    "BannerTypes": [
      {
        "Category": "BannerType",
        "Id": 0,
        "Ids": [
          0
        ],
        "Name": "string",
        "BannerPreviewLink": "string"
      }
    ]
  }
]

Inventory Marketplace API GET /v1/buyer/marketplace/inventories/inventorysources/{inventorySourceId} response body example:

{
  "id": 1,
  "name": "InventorySource-1",
  "adExchangeId": 100,
  "channels": [
    "audio",
    "native"
  ],
  "dspAdTypes": [
    "image",
    "link",
    "keyword"
  ],
  "environments": [
    "web",
    "app"
  ],
  "countryIds": [
    1,
    2,
    3
  ],
  "adSizes": [
    {
      "width": 200,
      "height": 100
    }
  ],
  "iabCategoryIds": [
    1,
    2,
    3
  ]
}

Inventory Marketplace API Retrieve Inventory Source details parameters:

Name

Required or Optional

Description

Example Value

Type

inventorySourceId

Required

To specify which inventory source details are needed

7

Integer

Retrieve the available deals list

Inventory API endpoints GET /dsp/v1/deals and Inventories Search API endpoint POST /v1/buyer/inventories/deals/search is replaced by Inventory Marketplace API endpoint POST /v1/buyer/marketplace/inventories/deals/list.

Use the new endpoint to retrieve a list of available deals. See the changes in the response body and the new or changed parameters described below.

Response Body Examples and Parameters

Inventory API GET /dsp/v1/deals response body example:

[
  {
    "InventorySourceName": "string",
    "EstimatedImpressions": 0,
    "EstimatedImpressionsType": "Daily",
    "BannerSizes": [
      {
        "Width": 0,
        "Height": 0,
        "Id": 0,
        "IsNew": true
      }
    ],
    "BannerTypes": [
      {
        "Category": "BannerType",
        "Id": 0,
        "Ids": [
          0
        ],
        "Name": "string",
        "BannerPreviewLink": "string"
      }
    ],
    "Id": 0,
    "DealState": "New",
    "Name": "string",
    "DealId": "string",
    "InventorySourceId": 0,
    "Price": 0,
    "Currency": {
      "Id": 0,
      "Code": "string"
    },
    "ValidFrom": "2025-04-24T08:25:42.262Z",
    "ValidTo": "2025-04-24T08:25:42.262Z",
    "DealType": "Private",
    "PricingType": "Private",
    "SourceType": "InventorySource",
    "Description": "string",
    "TermsAndConditions": "string"
  }
]

Inventories Search API POST /v1/buyer/inventories/deals/search response body example:

[
  {
    "id": "42",
    "name": "The Best deal for you",
    "alias": "Deal alias",
    "source": 0,
    "sourceDealId": 0,
    "dealId": "DEAL-02313",
    "pricingType": "preferred",
    "status": "accepted",
    "price": 4.49,
    "currencyCode": "EUR",
    "party": {
      "id": 4,
      "name": "Party name"
    },
    "inventorySource": {
      "id": 32,
      "name": "Inventory Source 1",
      "bannerTypes": [
        {
          "id": 1,
          "name": "Banner Type Video",
          "subTypes": [
            {
              "id": 3,
              "name": "Short video"
            },
            {
              "id": 4,
              "name": "Long video"
            }
          ]
        },
        {
          "id": 2,
          "name": "Banner type 2"
        }
      ]
    },
    "channels": [
      {
        "id": 1,
        "name": "Channel 1"
      },
      {
        "id": 2,
        "name": "Channel 2"
      }
    ],
    "bannerTypes": [
      {
        "id": 1,
        "name": "Banner Type Video",
        "subTypes": [
          {
            "id": 3,
            "name": "Short video"
          },
          {
            "id": 4,
            "name": "Long video"
          }
        ]
      },
      {
        "id": 2,
        "name": "Banner type 2"
      }
    ],
    "sizes": [
      {
        "width": 20,
        "height": 100
      },
      {
        "width": 50,
        "height": 50
      }
    ],
    "iabCategories": [
      {
        "id": 4,
        "name": "Humor"
      },
      {
        "id": 5,
        "name": "Movies"
      }
    ],
    "ecpm": 1.34,
    "ecpc": 2.32,
    "ctr": 32.21,
    "statisticCurrencyCode": "USD",
    "statisticLastUpdated": "2025-04-24T08:26:31.7998587+00:00",
    "campaignCurrencyCode": "EUR",
    "dealLastUpdated": "2025-04-23T08:26:31.7998588+00:00",
    "highlight": {
      "name": "best"
    }
  }
]

Inventory Marketplace API POST /v1/buyer/marketplace/inventories/inventorysources/list response body example:

[
  {
    "inventorySourceId": 1,
    "dealId": "100",
    "name": "Deal-1",
    "price": 50,
    "currency": "EUR",
    "type": "preferred",
    "updatedAt": "2025-04-24T07:24:56.8633993+00:00",
    "dspAdTypes": [
      "image",
      "link",
      "keyword"
    ],
    "channels": [
      "audio",
      "native"
    ],
    "environments": [
      "web",
      "app"
    ]
  }
]

Inventory Marketplace API Retrieve Inventory Sources list parameters:

Name

Required or Optional

Description

Example Value

Type

advertiserId

Optional

When advertiserId isn't provided, inventory sources available to the whole agency are returned

ID of the advertiser that has access to inventories

"advertiserId": 1,

Integer

inventorySourceIds

Optional

IDs of inventory sources the user wants to retrieve

 
"inventorySourceIds": [
    1,
    2,
    3
  ],

Array of integers

adExchangeIds

Optional

IDs of ad exchanges the user wants to retrieve

 
"adExchangeIds": [
    10,
    20,
    30
  ],

Array of integers

channels

Optional

Filter inventories by channel

 
"channels": [
    "audio"
  ],

Array of enums

countryIds

Optional

Country IDs, of the retrieved inventory sources

 
"countryIds": [
    77,
    78
  ],

Array of integers

dspAdTypes

Optional

Ad types of the retrieved inventory sources

 
"dspAdTypes": [
    "image",
    "link",
    "keyword"
  ],

Array of enums

adSizes

Optional

Ad sizes of the retrieved inventory sources

 
"adSizes": [
    {
      "width": 200,
      "height": 400
    }
  ],"

Array of objects

iabCategoryIds

Optional

IAB category IDs of the retrieved inventory sources

 
 "iabCategoryIds": [
    99
  ],

Array of integers

environments

Optional

Environments of the retrieved inventory sources

 
"environments": [
    "app",
    "web"
  ]

Array of enums

Retrieve the available deals list

Inventory API endpoints GET /dsp/v1/deals and Inventories Search API endpoint POST /v1/buyer/inventories/deals/search is replaced by Inventory Marketplace API endpoint POST /v1/buyer/marketplace/inventories/deals/list.

Use the new endpoint to retrieve a list of available deals. See the changes in the response body and the new or changed parameters described below.

Response body examples and parameters

Inventory API GET /dsp/v1/deals response body example:

[
  {
    "InventorySourceName": "string",
    "EstimatedImpressions": 0,
    "EstimatedImpressionsType": "Daily",
    "BannerSizes": [
      {
        "Width": 0,
        "Height": 0,
        "Id": 0,
        "IsNew": true
      }
    ],
    "BannerTypes": [
      {
        "Category": "BannerType",
        "Id": 0,
        "Ids": [
          0
        ],
        "Name": "string",
        "BannerPreviewLink": "string"
      }
    ],
    "Id": 0,
    "DealState": "New",
    "Name": "string",
    "DealId": "string",
    "InventorySourceId": 0,
    "Price": 0,
    "Currency": {
      "Id": 0,
      "Code": "string"
    },
    "ValidFrom": "2025-04-24T08:25:42.262Z",
    "ValidTo": "2025-04-24T08:25:42.262Z",
    "DealType": "Private",
    "PricingType": "Private",
    "SourceType": "InventorySource",
    "Description": "string",
    "TermsAndConditions": "string"
  }
]

Inventories Search API POST /v1/buyer/inventories/deals/search response body example:

[
  {
    "id": "42",
    "name": "The Best deal for you",
    "alias": "Deal alias",
    "source": 0,
    "sourceDealId": 0,
    "dealId": "DEAL-02313",
    "pricingType": "preferred",
    "status": "accepted",
    "price": 4.49,
    "currencyCode": "EUR",
    "party": {
      "id": 4,
      "name": "Party name"
    },
    "inventorySource": {
      "id": 32,
      "name": "Inventory Source 1",
      "bannerTypes": [
        {
          "id": 1,
          "name": "Banner Type Video",
          "subTypes": [
            {
              "id": 3,
              "name": "Short video"
            },
            {
              "id": 4,
              "name": "Long video"
            }
          ]
        },
        {
          "id": 2,
          "name": "Banner type 2"
        }
      ]
    },
    "channels": [
      {
        "id": 1,
        "name": "Channel 1"
      },
      {
        "id": 2,
        "name": "Channel 2"
      }
    ],
    "bannerTypes": [
      {
        "id": 1,
        "name": "Banner Type Video",
        "subTypes": [
          {
            "id": 3,
            "name": "Short video"
          },
          {
            "id": 4,
            "name": "Long video"
          }
        ]
      },
      {
        "id": 2,
        "name": "Banner type 2"
      }
    ],
    "sizes": [
      {
        "width": 20,
        "height": 100
      },
      {
        "width": 50,
        "height": 50
      }
    ],
    "iabCategories": [
      {
        "id": 4,
        "name": "Humor"
      },
      {
        "id": 5,
        "name": "Movies"
      }
    ],
    "ecpm": 1.34,
    "ecpc": 2.32,
    "ctr": 32.21,
    "statisticCurrencyCode": "USD",
    "statisticLastUpdated": "2025-04-24T08:26:31.7998587+00:00",
    "campaignCurrencyCode": "EUR",
    "dealLastUpdated": "2025-04-23T08:26:31.7998588+00:00",
    "highlight": {
      "name": "best"
    }
  }
]

Inventory Marketplace API POST /v1/buyer/marketplace/inventories/inventorysources/list response body example:

[
  {
    "inventorySourceId": 1,
    "dealId": "100",
    "name": "Deal-1",
    "price": 50,
    "currency": "EUR",
    "type": "preferred",
    "updatedAt": "2025-04-24T07:24:56.8633993+00:00",
    "dspAdTypes": [
      "image",
      "link",
      "keyword"
    ],
    "channels": [
      "audio",
      "native"
    ],
    "environments": [
      "web",
      "app"
    ]
  }
]

Inventory Marketplace API Retrieve Inventory Sources list parameters:

Name

Required or Optional

Description

Example Value

Type

advertiserId

Optional

When advertiserId isn't provided, inventory sources available to the whole agency are returned

ID of the advertiser that has access to inventories

"advertiserId": 1,

Integer

inventorySourceIds

Optional

IDs of inventory sources the user wants to retrieve

 
"inventorySourceIds": [
    1,
    2,
    3
  ],

Array of integers

adExchangeIds

Optional

IDs of ad exchanges the user wants to retrieve

 
"adExchangeIds": [
    10,
    20,
    30
  ],

Array of integers

channels

Optional

Filter inventories by channel

 
"channels": [
    "audio"
  ],

Array of enums

countryIds

Optional

Country IDs, of the retrieved inventory sources

 
"countryIds": [
    77,
    78
  ],

Array of integers

dspAdTypes

Optional

Ad types of the retrieved inventory sources

 
"dspAdTypes": [
    "image",
    "link",
    "keyword"
  ],

Array of enums

adSizes

Optional

Ad sizes of the retrieved inventory sources

 
"adSizes": [
    {
      "width": 200,
      "height": 400
    }
  ],"

Array of objects

iabCategoryIds

Optional

IAB category IDs of the retrieved inventory sources

 
 "iabCategoryIds": [
    99
  ],

Array of integers

environments

Optional

Environments of the retrieved inventory sources

 
"environments": [
    "app",
    "web"
  ]

Array of enums

Retrieve deal details

Inventory API endpoint GET /dsp/v1/deals/{parentSourceId}/{sourceType}/{sourceId} is replaced by Inventory Marketplace API endpoint GET /v1/buyer/marketplace/inventories/deals/{dealId}/{inventorySourceId}.

Use the new endpoint to retrieve details of the needed deal. See the changes in the response body and the new or changed parameters described below.

Response body examples and parameters

Inventory API GET /dsp/v1/deals/{parentSourceId}/{sourceType}/{sourceId} response body example:

{
  "InventorySourceName": "InventorySource-1",
  "EstimatedImpressions": null,
  "EstimatedImpressionsType": null,
  "BannerSizes": [
    {
      "Width": 100,
      "Height": 150,
      "Id": 0,
      "IsNew": true
    },
    {
      "Width": 160,
      "Height": 600,
      "Id": 0,
      "IsNew": true
    }
  ],
  "BannerTypes": [
    {
      "Category": 2,
      "Id": 37,
      "Ids": [],
      "Name": "Adhesion: Ad Tile",
      "BannerPreviewLink": "http://www.adform.com/"
    },
    {
      "Category": 2,
      "Id": -1,
      "Ids": [
        39,
        40
      ],
      "Name": "Adhesion: Floor Ad",
      "BannerPreviewLink": null
    }
  ],
  "Id": 78954,
  "DealState": 2,
  "Name": "Deal-100",
  "DealId": "deal-100",
  "InventorySourceId": 1,
  "Price": 21.43,
  "Currency": {
    "Id": null,
    "Code": "EUR"
  },
  "ValidFrom": "2024-12-15T22:08:44",
  "ValidTo": null,
  "DealType": 1,
  "PricingType": 1,
  "SourceType": 5,
  "Description": null,
  "TermsAndConditions": "I confirm that banners of this campaign do not have any sensitive information from these categories: sex & sexuality, racism, religion, politics, gambling, tobacco & alcohol products"
}

Inventory Marketplace API GET /v1/buyer/marketplace/inventories/deals/{dealId}/{inventorySourceId} response body example:

{
  "inventorySourceId": 1,
  "dealId": "deal-100",
  "name": "Deal-100",
  "price": 21.43,
  "currency": "EUR",
  "type": "preferred",
  "updatedAt": "2025-04-24T07:24:56.8710698+00:00",
  "countryIds": [
    1,
    2,
    3
  ],
  "dspAdTypes": [
    "image",
    "link",
    "keyword"
  ],
  "adSizes": [
    {
      "width": 100,
      "height": 150
    },
    {
      "width": 160,
      "height": 600
    }
  ],
  "iabCategoryIds": [
    10,
    20
  ],
  "channels": [
    "audio",
    "native"
  ],
  "environments": [
    "web",
    "app"
  ]
}

Inventory Marketplace API Retrieve Deal details parameters:

Name

Required or Optional

Description

Example Value

Type

dealId

Required

To specify which deal information is needed

deal-100

String

inventorySourceId

Required

To specify which inventory source details are needed

1

Integer

Retrieve available ad exchanges list

New Inventory Marketplace API endpoint POST /v1/buyer/marketplace/inventories/adexchanges/list is introduced. Use the new endpoint to retrieve a list of available ad exchanges (inventory sources).

See the response body and the parameters described below.

Response body examples and parameters

Inventory Marketplace API POST /v1/buyer/marketplace/inventories/adexchanges/list response body example:

[
  {
    "id": 10,
    "name": "AdExchange-1"
  },
  {
    "id": 11,
    "name": "AdExchange-2"
  }

Inventory Marketplace API Retrieve Ad Exchanges list parameters:

Name

Required or Optional

Description

Example Value

Type

advertiserId

Optional

ID of advertiser of the retrieved ad exchanges

"advertiserId": 1,

Integer

Retrieve available domain list

New Inventory Marketplace API endpoint POST /v1/buyer/marketplace/inventories/domains/list is introduced.

Use the new endpoint to retrieve a list of domains. See the response body and the parameters described below.

Response body examples and parameters

[
  {
    "domain": "adform.com",
    "channels": [
      "audio",
      "native"
    ],
    "dspAdTypes": [
      "image",
      "link",
      "keyword"
    ]
  }
]

Inventory Marketplace API Retrieve Inventory Sources list parameters:

Name

Required or Optional

Description

Example Value

Type

domain

Optional

Domains to retrieve

 
"domains": [
    "Domain-1",
    "Domain-2"
  ]

Array of strings

channels

Optional

Filter inventories by channel

 
"channels": [
    "audio"
  ],

Array of enums

countryIds

Optional

Country IDs, of the retrieved inventory sources

 
"countryIds": [
    77,
    78
  ],

Array of integers

dspAdTypes

Optional

Ad types of the retrieved inventory sources

 
"dspAdTypes": [
    "image",
    "link",
    "keyword"
  ],

Array of enums

adSizes

Optional

Ad sizes of the retrieved inventory sources

 
"adSizes": [
    {
      "width": 200,
      "height": 400
    }
  ],"

Array of objects

iabCategoryIds

Optional

IAB category IDs of the retrieved inventory sources

 
 "iabCategoryIds": [
    99
  ],

Array of integers

Retrieve domain details

New Inventory Marketplace API endpoint GET /v1/buyer/marketplace/inventories/domains/{domain}.

Use the new endpoint to retrieve details of the needed domain. See the response body and the parameters described below.

Response body examples and parameters

Inventory Marketplace API GET v1/buyer/marketplace/inventories/domains/{domain} response body example:

{
  "domain": "adform.com",
  "channels": [
    "audio",
    "native"
  ],
  "dspAdTypes": [
    "image",
    "link",
    "keyword"
  ],
  "countryIds": [
    1,
    2,
    3
  ],
  "adSizes": [
    {
      "width": 200,
      "height": 100
    }
  ],
  "iabCategoryIds": [
    1,
    2,
    3
  ]
}

Inventory Marketplace API Retrieve Domain details parameters:

Name

Required or Optional

Description

Example Value

Type

domains

Required

Domain to retrieve

adform.com

String

Retrieve available apps list

New Inventory Marketplace API endpoint POST /v1/buyer/marketplace/inventories/apps/list is introduced.

Use the new endpoint to retrieve a list of apps. See the response body and the parameters described below.

Response body examples and parameters

Inventory Marketplace API POST /v1/buyer/marketplace/inventories/apps/list response body example:

[
  {
    "appId": "App-1",
    "name": "App name",
    "storeId": 1,
    "channels": [
      "audio",
      "native"
    ],
    "dspAdTypes": [
      "image",
      "link",
      "keyword"
    ]
  }
]

Inventory Marketplace API Retrieve Inventory Sources list parameters:

Name

Required or Optional

Description

Example Value

Type

appIds

Optional

Apps to retrieve

 
"appIds": [
    "App-1",
    "App-2"
  ]

Array of strings

storeIds

Option

Stores of retrieved apps

 
"storeIds": [
    1,
    2,
    3
  ]

Array of integers

channels

Optional

Filter inventories by channel

 
"channels": [
    "audio"
  ],

Array of enums

countryIds

Optional

Country IDs, of the retrieved inventory sources

 
"countryIds": [
    77,
    78
  ],

Array of integers

dspAdTypes

Optional

Ad types of the retrieved inventory sources

 
"dspAdTypes": [
    "image",
    "link",
    "keyword"
  ],

Array of enums

adSizes

Optional

Ad sizes of the retrieved inventory sources

 
"adSizes": [
    {
      "width": 200,
      "height": 400
    }
  ],"

Array of objects

iabCategoryIds

Optional

IAB category IDs of the retrieved inventory sources

 
 "iabCategoryIds": [
    99
  ],

Array of integers

Retrieve app details

New Inventory Marketplace API endpoint GET /v1/buyer/marketplace/inventories/apps/{storeId}/{id}.

Use the new endpoint to retrieve details of the needed app. See the response body and the parameters described below.

Response body examples and parameters

Inventory Marketplace API GET /v1/buyer/marketplace/inventories/apps/{storeId}/{appId} response body example:

{
  "appId": "App-1",
  "name": "App name",
  "storeId": 1,
  "channels": [
    "audio",
    "native"
  ],
  "dspAdTypes": [
    "image",
    "link",
    "keyword"
  ],
  "countryIds": [
    1,
    2,
    3
  ],
  "adSizes": [
    {
      "width": 200,
      "height": 100
    }
  ],
  "iabCategoryIds": [
    1,
    2,
    3
  ]
}

Inventory Marketplace API Retrieve Inventory Source details parameters:

Name

Required or Optional

Description

Example Value

Type

Id

Required

Apps to retrieve

App-1

String

storeId

Required

Store of the retrieved app

1

Integer

Work With Inventory Marketplace Stats API for Retrieval of KPIs

With Inventory Marketplace Stats API, you can retrieve performance KPIs of the selected inventory sources and deals.

To see the dimensions and metrics that can be used in Inventory Marketplace Stats API, use Metadata endpoints. For more information, see Guide to Generating Advertiser Reports With API.

After creating a report operation, you should check report operation status via GET /v2/market/stats/operations/{id} in Inventory Marketplace Stats API. Once the report is ready, you can retrieve it via GET /v2/market/stats/reports/{id}.

Tip

You can follow a similar workflow described in Guide to Generating Advertiser Reports With API.

Retrieve KPIs for Inventory sources

New Inventory Marketplace Stats API endpoints POST /v2/market/stats/reports, GET /v2/market/stats/operations/{id}, GET /v2/market/stats/reports/{id}. Use the new endpoints to retrieve information about inventory source performance KPIs. See the request body, response body and the parameters described below.

Request and Response Body Examples and Parameters

Inventory Marketplace Stats API POST /v2/market/stats/reports Request Body Example

{
  "dimensions": [
    "rtbInventorySourceID"
  ],
  "metrics": [
    {
      "metric": "dspEcpmDkk"
    },
    {
      "metric": "dspEcpcDkk"
    },
    {
      "metric": "dspCtr"
    },
    {
      "metric": "dspEcpmvDkk"
    },
    {
      "metric": "dspViewImpressionsPercentIAB"
    },
    {
      "metric": "dspVideoCompletionRate"
    }
  ],
  "filter": {
    "date": {
      "from": "2025-06-08",
      "to": "2025-06-12"
    },
    "rtbInventorySource": {
      "id": [
        1,
        2,
        3,
        4,
      ]
    }
  },
  "sort": [
    {
      "metric": "dspCtr",
      "direction": "asc"
    }
  ]
}

Inventory Marketplace Stats API GET /v2/market/stats/reports/{id} Response Body Example

{
  "reportData": {
    "columnHeaders": [
      "rtbInventorySourceID",
      "dspEcpmDkk",
      "dspEcpcDkk",
      "dspCtr",
      "dspEcpmvDkk",
      "dspViewImpressionsPercentIAB",
      "dspVideoCompletionRate"
    ],
    "columns": [
      {
        "key": "rtbInventorySourceID"
      },
      {
        "key": "dspEcpmDkk"
      },
      {
        "key": "dspEcpcDkk"
      },
      {
        "key": "dspCtr"
      },
      {
        "key": "dspEcpmvDkk"
      },
      {
        "key": "dspViewImpressionsPercentIAB"
      },
      {
        "key": "dspVideoCompletionRate"
      }
    ],
    "rows": [
      [
        1,
        94.208,
        0,
        0,
        94.208,
        1,
        1
      ],
      [
        2,
        13.577475618572956,
        49.72683514084507,
        0.000273041217686918,
        33.62705413694246,
        0.4277014200633855,
        0.547752808988764
      ],
      [
        3,
        38.49676339653751,
        23.348287,
        0.001648804616652927,
        60.40953945666235,
        0.659556313993174,
        0
      ],
      [
        4,
        144.43126086956522,
        3.321919,
        0.043478260869565216,
        415.239875,
        0.36363636363636365,
        1
      ]
    ]
  }
}

Inventory Marketplace Stats API: Retrieve Inventory Performance KPI Parameters

Parameter Type

Name

Required or Optional

Description

Example Value

Type

dimension

rtbInventorySourceId - Inventory Source dimension

Optional

To specify what entity information is needed. You can report based on inventory sources, deals, domains and apps.

 
"dimensions": [
    "rtbInventorySourceID"
  ]

String

inventoryDealId - deal dimension

 
"dimensions": [
    "inventoryDealID"
  ]

String

rtbDomain - domain dimension

 
"dimensions": [
    "rtbDomain"
  ]

String

rtbSubDomain - subdomain dimension

 
"dimensions": [
    "rtbSubDomain"
  ]

String

appStoreAppId and appName - app dimension

For all dimensions available in Adform reports, see Reporting Dimensions in Advertiser Reports

 
"dimensions": [
    "appStoreAppId",
    "appName"
  ]

String

metric

For all metrics available in Adform reports, see Reporting Metrics in Advertiser Reports

Required

To specify needed KPIs for reporting.

In Inventory Marketplace Flow UI these metrics are displayed:

  • eCPM

  • eCPC

  • CTR

  • eCPMV

  • Viewable Rate

  • Video Completion Rate

 
  "metrics": [
    {
      "metric": "dspEcpmDkk"
    },

    {
      "metric": "dspEcpcDkk"
    },
    {
      "metric": "dspCtr"
    },
    {
      "metric": "dspEcpmvDkk"
    },
    {
      "metric": "dspViewImpressionsPercentIAB"
    },
    {
      "metric": "dspVideoCompletionRate"
    }
  ],

String

filter

date

Required

To specify reporting period. Inventory Marketplace Flow UI displays past 7 days data.

 
"filter": {
    "date": {
      "from": "2025-06-08",
      "to": "2025-06-12"
    },

String

filter

See specific endpoint for all available filters.

Optional

To specify how reports should be filtered by. IDs of inventory sources, retrieved from Inventory Marketplace API, should be used via filter.

 
  "filter": {
    "rtbInventorySource": {
      "id": [
        2848,
        1746,
      ]
    }
  }

Depends on the filter

Retrieve KPIs for Deals With Specific Filtering

New Inventory Marketplace Stats API endpoints POST /v2/market/stats/reports, GET /v2/market/stats/operations/{id}, GET /v2/market/stats/reports/{id}. Use the new endpoints to retrieve information about deals performance KPIs according to specific filters. See the request body, response body and the parameters described below.

Request and Response Body Example and Parameters

Inventory Marketplace Stats API POST /v2/market/stats/reports Request Body Example

{
  "dimensions": [
    "inventoryDealID"
  ],
  "metrics": [
    {
      "metric": "dspEcpmDkk"
    },
    {
      "metric": "dspEcpcDkk"
    },
    {
      "metric": "dspCtr"
    },
    {
      "metric": "dspEcpmvDkk"
    },
    {
      "metric": "dspViewImpressionsPercentIAB"
    },
    {
      "metric": "dspVideoCompletionRate"
    }
  ],
  "filter": {
    "date": {
      "from": "2025-06-08",
      "to": "2025-06-12"
    },
    "rtbDeal": {
      "inventoryDealId": [
        "3002_DID-3002-12345",
        "34_DID-34-12345"
      ]
    },
    "country": {
      "id": [
        208
      ]
    },
    "channel": {
      "id": [
        1
      ]
    }
  },
  "sort": [
    {
      "metric": "dspCtr",
      "direction": "asc"
    }
  ]
}

Inventory Marketplace Stats API GET /v2/market/stats/reports/{id} Response Body Example

{
  "reportData": {
    "columnHeaders": [
      "inventoryDealID",
      "dspEcpmDkk",
      "dspEcpcDkk",
      "dspCtr",
      "dspEcpmvDkk",
      "dspViewImpressionsPercentIAB",
      "dspVideoCompletionRate"
    ],
    "columns": [
      {
        "key": "inventoryDealID"
      },
      {
        "key": "dspEcpmDkk"
      },
      {
        "key": "dspEcpcDkk"
      },
      {
        "key": "dspCtr"
      },
      {
        "key": "dspEcpmvDkk"
      },
      {
        "key": "dspViewImpressionsPercentIAB"
      },
      {
        "key": "dspVideoCompletionRate"
      }
    ],
    "rows": [
      [
        "3002_DID-3002-12345",
        13.577475618572956,
        49.72683514084507,
        0.000273041217686918,
        33.62705413694246,
        0.4277014200633855,
        0.547752808988764
      ],
      [
        "34_DID-34-12345",
        38.49676339653751,
        23.348287,
        0.001648804616652927,
        60.40953945666235,
        0.659556313993174,
        0
      ]
    ]
  }
}

Inventory Marketplace Stats API Retrieve deals KPIs Parameters with specific filters

Name

Required or Optional

Description

Example Value

Type

dimensions

inventoryDealID

Optional

To specify that deal information is needed.

 
"dimensions": [
    "inventoryDealID"
  ]

String

filter

date

Required

To specify reporting period. Inventory Marketplace Flow UI displays past 7 days data.

 
"filter": {
    "date": {
      "from": "2025-06-08",
      "to": "2025-06-12"
    },

String

filter

country → id

Optional

To filter KPIs according to country.

 
"filter": {
   "country": {
      "id": [
        208
      ]
    }
  }

Integer

filter

channel → id

Optional

To filter KPIs according to channel.

 
"filter": {
    "channel": {
      "id": [
        1
      ]
    }
  }

Integer

Was this article helpful?

/
How we can make it better?

Thank you for your feedback!