Retrieving List of Pixels

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

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

         

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

Request Headers

           

Header Name
Required
PubToken
yes

Request Query Parameters

                     

Parameter Name
Type
Required
Description
pageNumber
Integer
optional
Page number to be fetched in case of multiple pages. Its default value is 1.
pageSize
Integer
optional
Maximum number of rows to be included in the response. Its 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 identifier of the pixel type
name
String
Name 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 Code
Error Description
CC03_0001
No records found
CC03_0004
Resource not found

Attachments

    Outcomes