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 buyers present in the PubMatic system.

Request

         

URIhttp://{domainName}/common/buyer?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.
pageSizeIntegeroptionalMaimum number of rows to be included in the system. Its default value is 100.
pmpEnabledIntegerMandatoryPMP-enabled buyers 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 the advertiser category
nameStringName of the advertiser category
uriStringURI path to get details of the advertising entity

Sample JSON Response


{
    "metaData": {
        "startIndex": 1,
        "totalRecords": 6020,
        "endIndex": 3
    },
    "items": [
        {
            "id": 2,
            "name": "Didit",
            "uri": "http://localhost:8080/buyer/2"
        },
        {
            "id": 4,
            "name": "NextAction",
            "uri": "http://localhost:8080/buyer/4"
        },
        {
            "id": 5,
            "name": "Neo@Ogilvy",
            "uri": "http://localhost:8080/buyer/5"
        }
    ]
}‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍