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

Request

         

URIhttp://{domainName}/common/advertiser?pageSize=20&pageNumber=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.
iabCategoryIdStringoptionalget all advertiser by IAB category ID.

Response

Response Headers

           

Response Header NameType
Content-typeapplication-json

Response Body

                            

Response Body ParameterTypeDescription
metaDataObjectPagination details
idIntegerUnique ID of advertiser
nameStringName of advertiser
creationTimeStringCreation time of advertiser

Retrieving details of all advertisers without any filter

Sample URL

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

Sample Response JSON


{

    "metaData": {

        "startIndex": 1,

        "request": {

            "pageSize": 100,

            "pageNumber": 1,

            "useAllDimensions": true

        },

        "totalRecords": 71082,

        "endIndex": 100

    },

    "items": [

        {

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

            "id": 13,

            "name": "Direct"

        }

    ]

}

Get all advertisers on IAB category filter

Sample URL

  

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

Sample JSON


{

    "metaData": {

        "startIndex": 1,

        "request": {

             "pageSize": 20,

             "pageNumber": 1

        },

        "totalRecords": 4,

        "endIndex": 4

     },

     "items": [

      {

          "creationTime": "2011-04-14 09:56:09",

          "id": 2436,

          "name": "mini",

          "domainIABCategories": []

       },

       {

          "creationTime": "2011-04-14 09:56:12",

          "id": 3686,

          "name": "Citigroup Inc",

          "domainIABCategories": []

        },

        {

            "creationTime": "2011-06-16 12:49:19",

            "id": 6753,

             "name": "Zulily",

             "domainIABCategories": []

        },

        {

             "creationTime": "2012-10-22 13:39:33",

            "id": 24082,

            "name": "Gazelle",

            "domainIABCategories": []

        }

    ]

}