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

Request

         

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


Request Headers

                 

Header NameTypeValueRequiredDescription
AuthorizationStringBearer ${access_token}YesNeed to send the access token generating for authentication at the place of ${access_token}.
For more information about access tokens, refer to Getting Started with PubMatic APIs.


Request Query Parameters

                     

Parameter NameTypeRequiredDescription
pageNumberIntegerOptional

Page number to be fetched in case of multiple pages.
Its default value is 1.

pageSizeIntegerOptional

Maximum number of rows to be included in the response.
Its default value is 100.

Response

Response Headers

           

Response Header NameType
Content-type application/json


Response Body

                                      

Response Body ParameterTypeDescription
metaDataObjectPagination details
geoIdIntegerUnique identifier for the geo.
nameStringName of the geo.
countryCodeStringCountry code for the geo.
dmaCodeIntegerDMA code for the geo.
geoLevelStringLevel of the geo. Possible values are CITY and COUNTRY.


Sample Response JSON


{

    "metaData": {

        "startIndex": 1,

        "request": {

            "pageSize": 3,

            "pageNumber": 1

        },

        "totalRecords": 162910,

        "endIndex": 3

    },

    "items": [

        {

            "geoId": 0,

            "name": "Rest Of The World",

            "countryCode": "",

            "dmaCode": 0,

            "geoLevel": "COUNTRY"

        },

        {

            "geoId": 1,

            "name": "Anonymous Proxy",

            "countryCode": "A1",

            "dmaCode": 0,

            "geoLevel": "COUNTRY"

        },

        {

            "geoId": 2,

            "name": "Satellite Provider",

            "countryCode": "A2",

            "dmaCode": 0,

            "geoLevel": "COUNTRY"

        }

    ]

}