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

Request

         

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

Request Headers

               

Header NameTypeRequiredDescription
PubTokenYesYes 

Request Query Parameters

                                       

Parameter NameTypeRequiredDescription
pageSizeIntegeroptionalMaximum number of rows to be included in the response. Its default value is 100.
pageNumberIntegeroptionalPage number to be fetched incase of multiple pages. Its default value is 1.
advertiserIdIntegeroptionalRetrieving details of all domains associated with this advertiser ID.
categoryIdStringoptionalRetrieving details of all domains associated with this advertiser's category ID.
iabCategoryIdStringoptionalRetrieving details of all domains of this IAB advertiser category ID.

Sample Request JSON

Response

Response Headers

           

Response Header NameType
Content-type  application/json

Response Body

                            

Response Body ParameterTypeDescription
metaDataObjectPagination details
idIntegerID of domain
domainStringdomain
nameIntegername of domain

 

Sample Response JSON

Retrieving details of all available advertiser domains

Request

http://{domainName}/common/advertiserDomain?pageSize=20&pageNumber=1

Response


{

    "metaData": {

        "startIndex": 1,

        "request": {

            "pageSize": 5,

            "pageNumber": 1,

            "useAllDimensions": true

        },

        "totalRecords": 1211408,

        "endIndex": 20

    },

    "items": [

        {

            "id": 2,

            "domain": "formulaire.ingdirect.fr",

            "creationTime": "2011-04-14 08:48:33",

            "name": "formulaire.ingdirect.fr"

        },

        {

            "id": 4,

            "domain": "www.directv.com",

            "creationTime": "2011-04-14 08:48:33",

            "name": "www.directv.com"

        },

        {

            "id": 6,

            "domain": "banned.com",

            "creationTime": "2011-04-14 08:48:33",

            "name": "banned.com"

        },

        {

            "id": 7,

            "domain": "macys.com",

            "creationTime": "2011-04-14 08:48:33",

            "name": "macys.com"

        },

        {

            "id": 8,

            "domain": "trysensa.com",

            "creationTime": "2011-04-14 08:48:33",

            "name": "trysensa.com"

        }

    ]

}

Retrieving details of all advertiser domains by advertiserId

Request                                              

http://{domainName}/common/advertiserDomain?advertiserId=100&pageSize=20&pageNumber=1

Response 


{

    "metaData": {

        "startIndex": 1,

        "request": {

            "pageSize": 3,

            "pageNumber": 1

        },

        "totalRecords": 18,

        "endIndex": 3

    },

    "items": [

        {

            "id": 2,

            "domain": "formulaire.ingdirect.fr",

            "creationTime": "2011-04-14 08:48:33",

            "name": "formulaire.ingdirect.fr"

        },

        {

            "id": 4,

            "domain": "www.directv.com",

            "creationTime": "2011-04-14 08:48:33",

            "name": "www.directv.com"

        },

        {

            "id": 6,

            "domain": "banned.com",

            "creationTime": "2011-04-14 08:48:33",

            "name": "banned.com"

        }

    ]

}

Retrieving details of all advertiser domains by categoryId

Request

  

http://{domainName}/common/advertiserDomain?categoryId=1&pageSize=20&pageNumber=1

Response


{

    "metaData": {

        "startIndex": 1,

        "request": {

            "pageSize": 3,

            "pageNumber": 1

        },

        "totalRecords": 18,

        "endIndex": 3

    },

    "items": [

        {

            "id": 2,

            "domain": "formulaire.ingdirect.fr",

            "creationTime": "2011-04-14 08:48:33",

            "name": "formulaire.ingdirect.fr"

        },

        {

            "id": 4,

            "domain": "www.directv.com",

            "creationTime": "2011-04-14 08:48:33",

            "name": "www.directv.com"

        }

    ]

}

Retrieving details of all advertiser domains by advertiser, advertiser's category and advertiser's sub-category

Request 



http://{domainName}/common/advertiserDomains?advertiserId=172&categoryId=1&pageSize=20&pageNumber=1


Note: This call will return all domains of advertierId=172 and categoryId = 1

 Response 


{

    "metaData": {

        "startIndex": 1,

        "request": {

            "pageSize": 20,

            "pageNumber": 1,

            "useAllDimensions": true

        },

        "totalRecords": 1,

        "endIndex": 1

    },

    "items": [

        {

            "id": 4542,

            "domain": "www.flemingssteakhouse.com",

            "creationTime": "2011-04-14 08:48:33",

            "name": "www.flemingssteakhouse.com"

        }

    ]

}

 

Retrieving details of all advertiser domains by iabCategoryId

  Request

  

http://{domainName}/common/advertiserDomain?iabCategoryId=IAB17&pageSize=20&pageNumber=1

  Response


{

"metaData": {

"startIndex": 1,

"request": {

"pageSize": 20,

"pageNumber": 1

},

"totalRecords": 4,

"endIndex": 4

},

"items": [

{

"id": 189201,

"domain": "online.citibanks.com",

"creationTime": "2012-07-18 12:11:14",

"name": "online.citibanks.com"

},

{

"id": 255758,

"domain": "minicoyoteplus.com",

"creationTime": "2012-10-03 05:40:05",

"name": "minicoyoteplus.com"

},

{

"id": 301773,

"domain": "gazelle.co",

"creationTime": "2012-10-12 22:20:14",

"name": "gazelle.co"

},

{

"id": 350622,

"domain": "zulily.cown",

"creationTime": "2012-10-12 22:30:24",

"name": "zulily.cown"

}

]

}

Retrieving details of all advertiser domains by advertiser and IAB category (include sub category data also).

 Request

  

http://{domainName}/common/advertiserDomains?advertiserId=172&iabCategoryId=IAB17&pageSize=20&pageNumber=1
Note: This call will return all domains of advertierId=172 and IAB category id = IAB17 

  Response


{

"metaData": {

"startIndex": 1,

"request": {

"pageSize": 20,

"pageNumber": 1

},

"totalRecords": 1,

"endIndex": 1

},

"items": [

{

"id": 189201,

"domain": "online.citibanks.com",

"creationTime": "2012-07-18 12:11:14",

"name": "online.citibanks.com"

}

]