Retrieving List of PMP-enabled DSPs

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

Overview

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

Request

         

URI
http://{domainName}/common/advertisingEntity?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
Maximum number of rows to be included in the response. Its default value is 100.
pmpEnabled
Integer
Mandatory
PMP-enabled DSPs 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 advertiser's category
name
String
Name of advertiser's category
uri
String
URI 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": 20,
            "pageNumber": 1,
            "useAllDimensions": true
        },
        "totalRecords": 1,
        "endIndex": 1
    },
    "items": [
        {
            "id": 80,
            "name": "DoubleClickBidManager",
            "uri": "http://localhost:8080/advertisingEntity/80"
        }
    ]
}

Attachments

    Outcomes