Retrieving List of PMP-enabled Buyers

Document created by pubmatic-archivist on Mar 27, 2017Last modified by catherine.racette on Jun 15, 2017
Version 3Show Document
  • View in full screen mode

Overview

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

Request

         

URI
http://{domainName}/common/buyer?pageSize=20&pageNumber=1&pmpEnabled=1
HTTP Method
GET

Request Headers

           

Header Name
Required
PubToken
yes

Request Query Parameters

                           

Parameter Name
Type
Required
Description
pageNumber
Integer
optional
Page number to be fetched in case of multiple pages. Its default value is 1.
pageSize
Integer
optional
Maimum number of rows to be included in the system. Its default value is 100.
pmpEnabled
Integer
Mandatory
PMP-enabled buyers to be fetched in the system. By default, it will be Off.

Response

Response Headers

           

Response Header Name
Type
Content-type
application-json

Response Body

                            

Response Body Parameter
Type
Description
metaData
Object
id
Integer
Unique ID of the advertiser category
name
String
Name of the advertiser category
uri
String
URI 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"
        }
    ]
}

Attachments

    Outcomes