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 rich media vendors present in the PubMatic system.

Request

         

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


Request Headers

                 

Header NameTypeValueRequiredDescription
AuthorizationStringBearer ${access_token}Yes

Publisher Token to authenticate and authorize the user calling the Unified Ad Server API. Send the access token generated for authentication at the place of ${access_token} in the request.


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 rich media vendor.
nameStringName of the rich media vendor.


Sample Response JSON


{
    "metaData": {
        "startIndex": 1,
        "request": {
            "pageSize": 3,
            "pageNumber": 1
        },
        "totalRecords": 13,
        "endIndex": 3
    },
    "items": [
        {
            "id": 13,
            "name": "Adcentric"
        },
        {
            "id": 12,
            "name": "Adinterax"
        },
        {
            "id": 11,
            "name": "Atlas"
        }
    ]
}‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍


Error Codes

Error codes specific to this API method.

               

Error CodeError Description
CC03_0001No records found
CC03_0004Resource not found


⇧ Top