Page tree


Before using PubMatic APIs, first generate the API Token. For more information, refer to  Getting Started with PubMatic APIs

Overview

This API allows you to retrieve the list of all the PMP-enabled DSPs present in the PubMatic system.

Request

         

URIhttp://{domainName}/common/advertisingEntity?pageSize=20&pageNumber=1&pmpEnabled=1
HTTP MethodGET

Request Headers

           

Header NameRequired
PubTokenyes

Request Query Parameters

                           

Parameter NameTypeRequiredDescription
pageNumberIntegeroptionalPage number to be fetched in case of multiple pages. Its default value is 1.
pageSizeIntegeroptionalMaximum number of rows to be included in the response. Its default value is 100.
pmpEnabledIntegerMandatoryPMP-enabled DSPs to be fetched in the system. By default, it will be Off.

Response

Response Headers

           

Response Header NameType
Content-typeapplication-json

Response Body

                            

Response Body ParameterTypeDescription
metaDataObjectPagination Details
idIntegerUnique ID of advertiser's category
nameStringName of advertiser's category
uriStringURI path to get details of advertising entity

Sample JSON Response

{
    "metaData": {
        "startIndex": 1,
        "request": {
            "pageSize": 3,
            "pageNumber": 1,
            "useAllDimensions": true
        },
        "totalRecords": 76,
        "endIndex": 20
    },
    "items": [
        {
            "id": 6,
            "name": "Test Demand Parner",
            "uri": "http://localhost:8080/advertisingEntity/6"
        },
        {
            "id": 27,
            "name": "Media Math",
            "uri": "http://localhost:8080/advertisingEntity/27"
        },
        {
            "id": 22,
            "name": "Turn",
            "uri": "http://localhost:8080/advertisingEntity/22"
        }
    ]
}‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍

Retrieving the list of DSP mapped to a particular buyer

Sample Request

http://{domainName}/common/advertisingEntity?pageNumber=1&pageSize=20&pmpEnabled=1&atdId=51


Note: The above request will give DSP mapped to ATD/Buyer 51.

Sample Response

{
    "metaData": {
        "startIndex": 1,
        "request": {
            "pageSize": 3,
            "pageNumber": 1,
            "useAllDimensions": true
        },
        "totalRecords": 76,
        "endIndex": 20
    },
    "items": [
        {
            "id": 6,
            "name": "Test Demand Parner",
            "uri": "http://localhost:8080/advertisingEntity/6"
        },
        {
            "id": 27,
            "name": "Media Math",
            "uri": "http://localhost:8080/advertisingEntity/27"
        },
        {
            "id": 22,
            "name": "Turn",
            "uri": "http://localhost:8080/advertisingEntity/22"
        }
    ]
}‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍