Retrieving List of Advertiser Categories

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

Overview

This API allows you to retrieve the list of all the advertiser categories present in the PubMatic system.

Request

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

Request Headers

               
Header Name
Type
Required
Description
PubToken
 
yes

 

Request Query Parameters

                     
Parameter Name
Type
Required
Description
pageNumber
Integer
optional
default value is 1
pageSize
Integer
optional
default value is 100

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

Sample JSON Response:



{

    "metaData": {

        "startIndex": 1,

        "request": {

            "pageSize": 3,

            "pageNumber": 1,

            "useAllDimensions": false

        },

        "totalRecords": 42,

        "endIndex": 3

    },

    "items": [

        {

            "id": 1,

            "name": "Alcohol"

        },

        {

            "id": 2,

            "name": "Auto"

        },

        {

            "id": 3,

            "name": "Consumer Products & Goods"

        }

    ]

}

Attachments

    Outcomes