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 details of a specific Geo from the PubMatic system.

Request

         

URIhttp://{domainName}/common/geo/{id}
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 Path Parameters

               

Parameter NameTypeRequiredDescription
idintegeryesID of the geo.


Response

Response Headers

           

Response Header NameType
Content-type application-json


Response Body

                                 

Response Body ParameterTypeDescription
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


{

    "geoId": 5,

    "name": "Afghanistan",

    "countryCode": "AF",

    "dmaCode": 0,

    "geoLevel": "COUNTRY"

}‍‍‍‍‍‍‍‍‍‍‍‍‍


Error Codes

Error codes specific to this API method.

           

Error CodeError Description
CC03_004Resource not found