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

Request

         

URIhttp://{domainName}/common/mobileCarrier?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-typeapplication-json


Response Body

                            

Response Body ParameterTypeDescription
metaDataObjectPagination details
idIntegerUnique identifier of the mobile carrier.
carrierValueStringCarrier's name of the mobile carrier group.
groupNameStringName of the mobile carrier group.


Sample Response JSON


{

    "metaData": {

        "startIndex": 1,

        "request": {

            "pageSize": 3,

            "pageNumber": 1

        },

        "totalRecords": 380,

        "endIndex": 3

    },

    "items": [

        {

            "id": 1,

            "carrierValue": "UnDefined",

            "groupName": "UnDefined"

        },

        {

            "id": 2,

            "carrierValue": "2degrees Mobile",

            "groupName": "2degrees Mobile"

        },

        {

            "id": 3,

            "carrierValue": "Aether",

            "groupName": "Aether"

        }

    ]

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

Error Codes

Error codes specific to this API method.

               

Error CodeError Description
CC03_0001No records found
CC03_0004Resource not found