Retrieve publisher ID and company name

Before using PubMatic APIs, first generate the API Token. For more information, refer to  Getting Started with PubMatic APIs

Overview

This API lets you to retrieve publisher ID and company name in the PubMatic platform.

Request

Endpoint: api.pubmatic.com/v1/common/publisher

Method: GET

Header name

Type

Value

Required

Description

Authorization

String

Bearer ${access_token}

Yes

Need 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.

Parameter nameRequired?Description
filtersno

Possible values for filter: id and companyName

For example:

filters=id%20eq%20123456

filters=companyName%20like%20*ACME*

If filter is not used the PubMatic system will return all relevant data.

sortno

Possible methods of sorting:

If you use '-' the results will be in descending order. For example:

-id: 222222, 111111, etc.

-companyName: acme4, acme3, etc.

The results are in ascending order. For example:

id: 111111, 222222, etc.

companyName: acme1, acme2, etc.

pageSizeno

Maximum number of rows to be included in the response.

The default value is 100

pageNumberno

Page number to be fetched in case of multiple pages.

The default value is 1

Response

FilterFormatDescription
companyNamestring

Name of company in the PubMatic platform.

idinteger

Publisher ID in the PubMatic platform.

Examples

Sample request

curl -X GET \
 'http://api.pubmatic.com/v1/common/publisher?filters=companyName%20like%20*ACME*' \
  -H "Authorization: Bearer <KEY>"

Sample response 

{
    "metaData": {
        "request": {
            "pageSize": 100,
            "pageNumber": 1,
            "metrics": null,
            "dimensions": null,
            "sort": "-id",
            "filters": ["companyName like *ACME*"],
            "fromDate": null,
            "toDate": null,
            "tz": null,
            "useAllDimensions": true,
            "originalQuery": "pageSize=100&pageNumber=0&&filters=companyName like *ACME*"
        },
        "startIndex": 1,
        "totalRecords": 4,
        "endIndex": 10
    },
    "items": [{
            "companyName": "ACME1",
            "id": 111111
        },
        {
            "companyName": "ACME2",
            "id": 222222
        },
        {
            "companyName": "ACME3",
            "id": 333333
        },
        {
            "companyName": "ACME4",
            "id": 444444
        }
    ]
}

Sample request

curl -X GET \
 'http://api.pubmatic.com/v1/common/publisher?filters=id%20eq%20123456' \
  -H "Authorization: Bearer <KEY>"

Sample response 

{
    "metaData": {
        "request": {
            "pageSize": 100,
            "pageNumber": 1,
            "metrics": null,
            "dimensions": null,
            "sort": null,
            "filters": ["id eq 123456"],
            "fromDate": null,
            "toDate": null,
            "tz": null,
            "originalQuery": "pageSize=100&pageNumber=0&&filters=id eq 123456"
        },
        "startIndex": 1,
        "totalRecords": 1,
        "endIndex": 1
    },
    "items": [{
        "companyName": "ACME Advertising Inc",
        "id": 123456
    }]
}



⇧ Top

Do you have feedback on this document? Let us know: email us.