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

Request

         

URIhttp://{domainName}/common/pixel?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.

Response

Response Headers

           

Response Header NameType
Content-typeapplication-json

Response Body

                       

Response Body ParameterTypeDescription
metaDataObjectPagination details
idIntegerUnique identifier of the pixel type
nameStringName of the pixel type

Sample Response JSON


{

    "metaData": {

        "startIndex": 1,

        "request": {

            "pageSize": 3,

            "pageNumber": 1

        },

        "totalRecords": 2,

        "endIndex": 2

    },

    "items": [

        {

            "id": 3,

            "name": "TestPixel"

        },

        {

            "id": 4,

            "name": "TestPixcelUnActive"

        }

    ]

}


Error Codes


               

Error CodeError Description
CC03_0001No records found
CC03_0004Resource not found

⇧ Top