Page tree


Versions Compared

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.

Anchor
top
top
Table of Contents
indent20px
stylenone


The PubMatic Analytics API lets you view and interact with data insights to improve ad performance. You can easily integrate PubMatic APIs using simple HTTP GET requests to the PubMatic Analytics API Server. Mandatory and optional parameters in the query string such as dimensions, metrics, and filters let you control the scope of the JSON results PubMatic returns. The API provides methods that lets you query bulk-data in four categories:

  1. Publisher : use to constrain queries to a specific publisher's data.
  2. Buyer: use to constrain queries to a specific buyer's data.
  3. DSP: use to constrain queries to a specific DSP's data.


Warning
titleBefore Using PubMatic APIs…

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

Get the Bulk-Data Details for a Publisher

This API provides information about how to access bulk data details for a specific publisher. 

Request

URIhttp://{domainName}//data/publisher/{publisherId}
HTTP MethodGET


Request Headers

Header NameTypeValueRequiredDescription
Authorizationstring  Bearer
${access_token}
Yes

Send your generated access token in place of ${access_token} for authentication. Example:

curl "http://api.pubmatic.com/v1/analytics/data/publisher/xxxxx?dateUnit=date&dimensions=siteId&filters=&fromDate=2015-01-01T00:00&metrics=revenue,paidImpressions,ecpm=1&pageSize=10&sort=-revenue&toDate=2015-01-31T23:59" -H "Authorization: Bearer BDxxxx9d"

Request Path Parameters

Parameter NameTypeRequiredValidationsDescription
publisherIdIntegerYesPublishers can only query their own data.Indicates the publisher ID.

Request Query Parameters

Excerpt Include
EX:API Data Pull - Request Query Parameters Excerpt
EX:API Data Pull - Request Query Parameters Excerpt
nopaneltrue

Response

Response Header

Response Header NameTypeDescription
Content-Typeapplication/jsonJSON response

Response Body Parameters

The following table lists parameters returned in API responses.

Excerpt Include
EX:API Data Pull - Response Body Parameters Excerpt
EX:API Data Pull - Response Body Parameters Excerpt
nopaneltrue

Sample Response

Code Block
languagejs
titleJSON
linenumberstrue
collapsetrue
{
  "columns": [
    "date",
    "paidImpressions",
    "revenue"
  ],
  "rows": [
    [
      "2016-06-01",
      25249100,
      42000.554432
    ],
    [
      "2016-06-02",
      28841014,
      51154.094958
    ],
    [
      "2016-06-03",
      25200705,
      63640.230188
    ],
    [
      "2016-06-04",
      35254500,
      71632.23456
    ],
    [
      "2016-06-05",
      237219940,
      87654.32123
    ]
  ],
  "displayValue": {
    "date": {
      "2016-06-02": "2016-06-02",
      "2016-06-01": "2016-06-01",
      "2016-06-05": "2016-06-05",
      "2016-06-03": "2016-06-03",
      "2016-06-04": "2016-06-04"
    }
  },
  "currency": "USD",
  "alert": null,
  "dataFreshness": {
    "dataFreshnessHour": "2016-06-16T05",
    "timeZone": "PST"
  }
}‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍

HTTP Status Codes

The table below lists common HTTP status codes sent in REST API responses from the PubMatic API platform.

StatusMessageTypeDescription
200OKsuccessThe request has been successfully processed; check contents of body.
400Bad Requestclient-side errorThere is some validation failure; check the response body for error details.
401Unauthorized There is an authentication or authorization failure; check the response body for specific details.
403Forbidden You are not subscribed to this feature of the Platform.
404Not Found The server does not have this resource.
413Request Entity Too Large The request content exceeds the size limit.  This may be the number of records or the actual content size.
500Internal Server ErrorAPI-side errorThere is problem in the PubMatic API Platform. Please contact the PubMatic API support team.

Available Dimensions

Dimensions are attributes, such as Country, Platform, and Site, available in the PubMatic system. The following tables provide information about dimension grouping.

Dimensions for Historic Data

Dimension IDData TypeDescription
adFormatId numericType of Ad associated with the impression (e.g., video display)
adNetworkGroupId  numericName of the parent Ad Network that monetized the impression.
adNetworkVariantId numericName of the parent Ad Network's campaign that monetized the impression.
pbReasonnumericReason for Passback.
tldEntitynumericTop level domain Entity. Applicable in the case of mobile impressions.
tldIdnumericTop level domain.
adSizeIdnumericSize of the ad associated with the impression (e.g., 200 x 800)
adTagIdnumericName of the ad tag used when an impression was requested.
advertiserCategoryIdnumericCategory of the advertiser.
advertiserId numericName of the advertiser associated with the ad.
atdIdnumericName of the agency, ATD or buyer associated with the DSP that won the impression.
campaignIdnumericCampaign of the advertiser associated with the ad.
categoryIdnumericCategory of the site from which an impression was requested.  
channelIdnumericSales channel through which the impression was won (e.g., RTB, PMP).
cookied booleanIndicates whether or not the DSP's cookies were dropped when an impression was requested.
countryId numericCountry from which an impression was requested. (Refer to How Countries are Reported in Analytics Reports for more information)
creativeIdnumericThe creative id delivered in the ad response. This applies to video ads ONLY.
datestringDate (YYYY-MM-DD format) on which an impression was requested.
dealMetaIdnumericName of the Marketplace Deal that won the impression.
domainId  numericDomain name (web addresses) of the advertiser. The domains are identified by the landing page of the impression displayed.
dspIdnumericName of the DSP that won the impression.
foldPositionId numericFold placement associated with the ad tag used when an impression was requested.
hourstringTime (YYY-MM-DD'T'HH format) at which an impression was received.
mobDeviceIdFlagbooleanIndicates whether the visitor's Device ID is present in the impression requests.
mobDeviceIdTypeIdbooleanType of Device ID used by the visitor to generate an impression request. 
mobDeviceTypeId booleanType of Device used by the visitor to generate an impression request. 
mobGeoSourceFlagbooleanSource that provided the visitor's geographical location.
mobLatLongFlagbooleanIndicates whether the visitor's latitude/longitude details were included in the impression request.
mobMakeModelIdnumericMobile Make/Model Id.
mobOsId  numericMobile Operating System Id.
monthstringMonth (YYYY-MM format) at which an impression was  received .
platformId numericPlatform through which an impression was requested (e.g., Web, Mobile Web)
publisherDealId numericThe Publisher Deal Id.
sectionIdnumericSection of the site from which an impression was requested.
secureStatusbooleanIndicates whether the inventory is secure.
siteIdnumericURL of the site from which an impression was requested.
videoClientIdnumericThis will be present when a video tracker (e.g. event, impression, error) is fired by the PubMatic VPAID component. This ID will represent whether it is a Flash VPAID component (1) or HTML/JS VPAID component (2), otherwise if not present (NULL) it means the PubMatic VPAID component was not present.
videoErrorId numericVideo Error Code. Includes the IAB VAST error codes along with PubMatic custom video error codes that provide more granularity for debugging.
videoEventIdnumericEvent id represents the type of video tracker event that was fired by the video player. Events can include start event, click event, 25%, 50%, completion, etc.
weekstringWeek (YYY'W'ww format) at which an impression was  received .


Info
titlePlease note…
Not all dimensions and metrics are supported together. For more information and verification, login to PubMatic Analytics UI.

Dimensions for Rule Data (RTB Rules Report in MBC Analytics)

Dimension IDData TypeDescription
campaignId numericCampaign of the advertiser associated with the ad.
datestringDate (YYYY-MM-DD format) on which an impression was requested.
pubIdintegerPublisher associated with the impression requests.
ruleIdnumericWinning Rule ID and Ad Server logs.
ruleMetaIdnumericRule Meta ID for PMPF rule type.
siteIdnumericURL of the site from which an impression was requested.

Available Metrics

The following tables list metric available for publisher bulk-data.

Metrics for Historic Data

Metric IDData TypeDescription
averageBidEcpmAdvnumericAverage CPM of the bid responses associated with an advertiser.  
averageBidEcpmAtdnumericAverage CPM of the bid responses associated with a buyer.  
averageBidEcpmDsp numericAverage CPM of the bid responses received from a DSP. 
pbImpressionsnumericNumber of impressions sent back to the publisher's passback networks because they were not monetized by the ad networks configured in the PubMatic system.
bidPercentageDspnumericNumber of bids responded as % of bid request sent. Formula : bidPercentageDsp = ( nonZeroBidResponses / totalBidsRequests ) * 100   
bidWinRateAdvnumericRate of won bids expressed as a percentage of total bids for advertiser. Formula : bidWinRateAdv = paidImpressions * 100 / nonZeroBidReceived
bidWinRateAtd numericA buyer's paid impressions divided by non-zero bids received, expressed as a percentage. Formula :(Paid Impressions * 100) / Non-Zero Bids Received
bidWinRateDspnumericA DSP's paid impressions divided by non-zero bid responses, expressed as a percentage.Formula: (Paid Impressions * 100) / Non-Zero Bid Responses
clicksnumericNumber of paid impressions clicked by users.   
ctrnumericEffectiveness of an ad based on the number of clicks it receives compared to the number of times it is displayed. Formula :clicks / paidImpressions *100
defaultsnumericNumber of impressions not served (defaulted) by an ad network configured in the PubMatic system. 
ecpmnumericAverage CPM (cost per thousand) for the impressions.
fillRate numericPercentage of times an ad is displayed to the visitor. Higher rates are better.
gEcpmnumericGross Ecpm
lostBidsAmountByAuctionnumericAmount of the bid responses that lost to the winning bid response in the auction.
lostBidsAmountByBlockList numericAmount of the bid responses that lost to the winning bid response in the Brand Control blocklist.
lostBidsAmountByCBLK numericLost Bid Amount (Creative Block)
lostBidsAmountByDWLFnumericAmount of the bid responses that lost because the advertiser's associated category/name/domain was not included in the Marketplace deals.
lostBidsAmountByFloornumericAmount of the bid responses that lost because their value was below the floor set in the Marketplace Rule Manager. 
lostBidsByAuctionnumericNumber of bid responses that did not win the impression (lost to other bid responses from DSPs and ad networks).  
lostBidsByBlockListnumericNumber of bid responses that did not win the impression because the attributes were either included in the publisher\u2019s blocklist or not included in the publisher\u2019s whitelist. 
lostBidsByCBLK  numericLost Bid Count (Creative Block)
lostBidsByDWLFnumericNumber of bid responses that did not win the impression because the associated Marketplace deal's whitelist did (DWLF) not include the advertiser.
lostBidsByFloor numericNumber of bid responses that did not win the impression because the demand partner's bid value was below the floor set in the Marketplace Rule Manager.     
lostBidsEcpmAdvnumericAverage CPM of the bid responses associated with an advertiser.  
lostBidsEcpmAtd numericAverage CPM of the bid responses associated with a buyer.
lostBidsEcpmByAuctionnumericeCPM of the bid responses that lost to the winning bid response in the auction. 
lostBidsEcpmByBlockListnumericeCPM of the bid responses that lost because the advertiser's associated category/name/domain was added in the Brand Control blocklist. 
lostBidsEcpmByDWLFnumericeCPM of the bid responses that lost because the advertiser'sassociated category/name/domain was not included in the Marketplace deals' whitelist. 
lostBidsEcpmByFloornumericeCPM of the bid responses which lost because their value was below the floor set in the Marketplace Rule Manager.
lostBidsEcpmDsp numericeCPM of the bid responses associated with a DSP that lost the impressions.  
lostBidsTotalAmount numericTotal amount of the bid responses that lost due to a reason other than that described in the Lost Bids Amount (Auction) metric. 
measuredImpressionsnumericNumber of impressions measured by IAS 
nonZeroBidReceivednumericNumber of bids in responses from demand partners that had a non-zero bid value. In case of multi-bid responses, each non-zero bid in the response is counted individually. 
nonZeroBidResponsesnumericNumber of bid responses from demand partners that had a non-zero bid value; indicates bid responses intended to participate in the auction.
paidImpressionsnumericNumber of impressions won by the demand partner.
pbImpressionsBotnumericNumber of impressions passed back to the publisher because requests came from a Web bot.
pbImpressionsNet numeriNumber of impressions sent back to the publisher's passback networks because they were not monetized by the ad networks configured in the PubMatic system. 
pbImpressionsNonApproved numericNumber of impressions passed back to the publisher because its site URL was either not included in the publisher's whitelisted domains or included in the global supply-side blocklist.  
percentInViewForMoreThan15secnumeric(%) of Ad in viewable area more than 15 seconds.
percentInViewForMoreThan5sec numeric(%) of Ad in viewable area more than 5 seconds.
percentViewabilitynumeric(%) of Ad in viewable area.
phantomBidsnumericHow often PubMatic bid response loses to others.
revenue numericRevenue amount generated by the winning impressions.
ssExpectedRevenuenumericPotential revenue generated by all PubMatic bid responses.
suspiciousImpressions numericNumber of impressions marked as suspicious by IAS
totalBidAmountnumericAmount of the total bid responses received by the PubMatic system.Formula: Total bid responses * Avg. bid eCPM
totalBidsRequestsDspnumericTotal number of bid requests sent by PubMatic to a DSP.
totalImpressionsnumericTotal number of impressions sent by the publisher to the PubMatic system. This value does not include the number of defaulted impressions.
totalLostBidsAdvnumericTotal number of advertiser bid responses that did not win the impressions. 
totalLostBidsAtd numericTotal number of buyer bid responses that did not win the impressions. 
totalLostBidsDspnumeric Total number of DSP bid responses that did not win the impressions.
totalRequests numericTotal Requests.
vctr  numericClick Through Rate
video25PercentCountnumeric25% Video Count 
video50PercentCountnumeric50% Video Count  
video75PercentCountnumeric75% Video Count
videoClicksCount   numericVideo Click Count 
videoCompleteCount numericVideo Complete Count 
videoErrorCountnumericVideo Error Count
videoEventCount numericError Count
videoImpressions numericVideo Distinct Impressions
videoStartCountnumericVideo Start Event Count
vtrnumericVideo Through Rate 
winningImpressionsnumericNumber of times PubMatic responds with a bid response
winRate numericPubMatic Paid Impressions/Total Requests
spendnumericSpend generated by an impression request.

Metrics for Domain Data

Metrics IDData TypeDescription
clicksnumericNumber of paid impressions clicked by users. 
defaultsnumericNumber of impressions not served (defaulted) by an ad network configured in the PubMatic system. 
paidImpressionsnumericNumber of impressions won by the demand partner.
pbImpressionsnumericNumber of impressions sent back to the publisher's passback networks because they were not monetized by the ad networks configured in the PubMatic system.
revenuenumericRevenue amount generated by the winning impressions.
spendnumericSpend generated by an impression request.
totalRequestsnumericTotal Requests

Metrics for Rules Data

Metrics IDData TypeDescription
paidImpressionsnumericNumber of impressions won by the demand partner.
revenuenumericRevenue amount generated by the winning impressions.
spendnumericSpend generated by an impression request.
totalRequestsnumericTotal Requests.

Get the Bulk-Data Details for a Buyer

This API describes how to access bulk-data details for a specific Buyer.

Request

URIhttp://{domainName}//data/buyer/{buyerId}
HTTP MethodGET

Request Headers

Header NameTypeValueRequiredDescription
Authorizationstring  Bearer
${access_token}
YesThe access token generated for authentication should be sent in place of ${access_token}. Example:curl  "http://api.pubmatic.com/v1/analytics/data/buyer/xxxxx?dateUnit=date&dimensions=siteId&filters=&fromDate=2015-01-01T00:00&metrics=spend,paidImpressions,ecpm&pageNumber=1&pageSize=10&sort=-spend&toDate=2015-01-31T23:59" -H "Authorization: Bearer BDxxxx9d"

Request Path Parameters

Parameter NameTypeRequiredValidationsDescription
buyerIdintegerYesBuyers can only query their own data.Indicates the Buyer ID.

Request Query Parameters

The following table lists parameters you can use to build requests.

Excerpt Include
EX:API Data Pull - Request Query Parameters Excerpt
EX:API Data Pull - Request Query Parameters Excerpt
nopaneltrue

Response

Response Header   

Response Header NameTypeDescription
Content-Typeapplication/jsonJSON response

Response Body

The following table lists parameters returned in API responses.

Excerpt Include
EX:API Data Pull - Response Body Parameters Excerpt
EX:API Data Pull - Response Body Parameters Excerpt
nopaneltrue
 

HTTP Status Codes

The table below lists common HTTP status codes sent in REST API responses from the PubMatic API platform.

StatusErrorTypeDescription
200OKsuccessThe request has been successfully processed; check contents of body.
400Bad Requestclient-side errorThere is some validation failure; check the response body for error details.
401Unauthorized There is an authentication or authorization failure; check the response body for specific details.
403Forbidden You are not subscribed to this feature of the Platform.
404Not Found The server does not have this resource.
500Internal Server ErrorAPI-side errorThere is problem in the PubMatic API Platform. Please contact the PubMatic API support team.
503  Service not available or too many requests.

Available Dimensions

Dimensions are attributes, such as CountryPlatform, and Site, available in the PubMatic system. The following tables provide information about dimension grouping.

Dimensions for Historic Data

Dimension IDData TypeDescription
averageBidEcpmAdvnumericAverage CPM of the bid responses associated with an advertiser. 
averageBidEcpmAtd numericAverage CPM of the bid responses associated with a buyer.  
bidLossRateAdvnumericNumber of lost bids as % of total bids for Advertiser.Formula: bidLossRateAdv = (nonZeroBidReceived - paidImpressions ) * 100 / nonZeroBidReceived
bidLossRateAtdnumericNumber of lost bids as % of total bids for ATD.Formula: bidLossRateAtd = (nonZeroBidReceived - paidImpressions ) * 100 / nonZeroBidReceived
bidPercentageAdv numericNumber of non-zero bids received as % of bid received.Formula: bidPercentageAdv =  (nonZeroBidReceived / totalBidsRequestsAdv ) * 100
bidPercentageAtdnumericNumber of non-zero bids received as % of bids received.Formula: bidPercentageAtd = ( nonZeroBidReceived / totalBidsRequestsAtd ) * 100
bidWinRateAdv numericAn advertiser's paid impressions divided by non-zero bids received, expressed as a percentage.Formula: (Paid Impressions * 100) / Non-Zero Bids Received$$
bidWinRateAtd numericA buyer's paid impressions divided by non-zero bids received, expressed as a percentage.Formula: (Paid Impressions * 100) / Non-Zero Bids Received
clicksnumericNumber of paid impressions clicked by users.
ctrnumericEffectiveness of an ad based on the number of clicks it receives compared to the number of times it is displayed. Formula :(Clicks / Paid Impressions) * 100
ecpmnumericAverage CPM (cost per thousand) for the impressions.
lostBidsByAuctionnumericNumber of bid responses that did not win the impression (lost to other bid responses from DSPs and ad networks). 
lostBidsByBlockListnumericNumber of bid responses that did not win the impression because the attributes were either included in the publisher\u2019s blocklist or not included in the publisher\u2019s whitelist.
lostBidsByDWLFnumericNumber of bid responses that did not win the impression because the associated Marketplace deal's whitelist did not include the advertiser associated with the bid. 
lostBidsByFloornumericNumber of bid responses that did not win the impression because the demand partner's bid value was below the floor set in the Marketplace Rule Manager.
nonZeroBidReceivednumericNumber of bids in responses from demand partners that had a non-zero bid value. In case of multi-bid responses, each non-zero bid in the response is counted individually.
paidImpressions numericNumber of impressions won by the demand partner.    
spendnumericSpend generated by an impression request.      
totalLostBidsAdvnumericTotal number of advertiser bid responses that did not win the impressions. Formula : totalLostBidsAdv = nonZeroBidReceived - paidImpressions
totalLostBidsAtdnumericTotal number of buyer bid responses that did not win the impressions. Formula :totalLostBidsAtd = nonZeroBidReceived - paidImpressions


Info
titlePlease note…
Not all dimensions and metrics are supported together. For more information and verification, login to PubMatic Analytics UI.

Available Metrics     

Metrics for Historical Data

Metric IDData TypeDescription
averageBidEcpmAdvnumericAverage CPM of the bid responses associated with an advertiser. 
averageBidEcpmAtdnumericAverage CPM of the bid responses associated with a buyer.
bidLossRateAdvnumericNumber of non-zero bids received as % of bid received. Formula: bidPercentageAdv =  (nonZeroBidReceived / totalBidsRequestsAdv ) * 100
bidLossRateAtd numericNumber of lost bids as % of total bids for ATD. Formula: bidLossRateAtd = (nonZeroBidReceived - paidImpressions ) * 100 / nonZeroBidReceived
bidPercentageAdvnumericNumber of non-zero bids received as % of bid received. Formula: bidPercentageAdv =  (nonZeroBidReceived / totalBidsRequestsAdv ) * 100
bidPercentageAtdnumericNumber of non-zero bids received as % of bids received. Formula: bidPercentageAtd = ( nonZeroBidReceived / totalBidsRequestsAtd ) * 100
bidWinRateAdvnumericNumber of non-zero bids received as % of bid received. Formula: bidPercentageAdv =  (nonZeroBidReceived / totalBidsRequestsAdv ) * 100
bidWinRateAtdnumericA buyer's paid impressions divided by non-zero bids received, expressed as a percentage. Formula : (Paid Impressions * 100) / Non-Zero Bids Received
clicks numericNumber of paid impressions clicked by users.
ctrnumericEffectiveness of an ad based on the number of clicks it receives compared to the number of times it is displayed. Formula :CTR = clicks/paidImpressions *100
ecpm numericAverage CPM (cost per thousand) for the impressions.
lostBidsByAuctionnumericNumber of bid responses that did not win the impression (lost to other bid responses from DSPs and ad networks).  
lostBidsByBlockListnumericNumber of bid responses that did not win the impression because the attributes were either included in the publisher\u2019s blocklist or not included in the publisher\u2019s whitelist.
lostBidsByDWLFnumericlostBidsByDWLF
lostBidsByFloornumericNumber of bid responses that did not win the impression because the demand partner's bid value was below the floor set in the Marketplace Rule Manager.  
nonZeroBidReceivednumericNumber of bids in responses from demand partners that had a non-zero bid value. In case of multi-bid responses, each non-zero bid in the response is counted individually.
paidImpressions numericNumber of impressions won by the demand partner.
spendnumericSpend generated by an impression request.
totalLostBidsAdvnumericTotal number of advertiser bid responses that did not win the impressions. 
totalLostBidsAtdnumericTotal number of buyer bid responses that did not win the impressions. 

Get the Bulk-Data Details for a DSP

This API describes how to access bulk-data details for a DSP. 

Request

URIhttp://{domainName}//data/dsp/{dspId}
HTTP MethodGET

Request Headers

Header NameTypeValueRequiredDescription
Authorizationstring  Bearer
${access_token}
YES The access token generated for authentication should be sent in place of ${access_token}. Example:curl  "http://api.pubmatic.com/v1/analytics/data/dsp/xxxxx?dateUnit=date&dimensions=siteId&filters=&fromDate=2015-01-01T00:00&metrics=spend,paidImpressions,ecpm&pageNumber=1&pageSize=10&sort=-spend&toDate=2015-01-31T23:59" -H "Authorization: Bearer BDxxxx9d"

Request Path Parameters

Parameter NameTypeRequiredValidationsDescription
dspIdIntegerYESDSPs can only query their own data.Indicates the DSP ID.

Request Query Parameters                                                                           

The following table lists parameters you can use to build requests.

Excerpt Include
EX:API Data Pull - Request Query Parameters Excerpt
EX:API Data Pull - Request Query Parameters Excerpt
nopaneltrue

Response

Response Header

Response Header NameTypeDescription
Content-Typeapplication/jsonJSON response

Response Body        

The following table lists parameters returned in API responses.

Excerpt Include
EX:API Data Pull - Response Body Parameters Excerpt
EX:API Data Pull - Response Body Parameters Excerpt
nopaneltrue

HTTP Status Codes

The table below lists common HTTP status codes sent in REST API responses from the PubMatic API platform.

StatusDescriptionTypeDescription
400Bad Requestclient-side errorThere is some validation failure; check the response body for error details.
401Unauthorized There is an authentication or authorization failure; check the response body for specific details.
403Forbidden You are not subscribed to this feature of the Platform.
404Not Found The server does not have this resource.
503

Service Not Available or too many requests.
500Internal Server ErrorAPI-side errorThere is problem in the PubMatic API Platform. Please contact the PubMatic API support team.

Available Dimensions

Dimensions are attributes, such as CountryPlatform, and Site, available in the PubMatic system. The following tables provide information about dimension grouping.

Dimensions for Historic Data

Dimension IDData TypeDescription
adFormatIdnumericType of ad associated with the impression (example: video, display).
adSizeId numericSize of ad associated with the impression (example: 200x800).
advertiserCategoryId numericIndicates category of advertiser.
advertiserIdnumericName of the advertiser associated with the ad.
atdIdnumericName of the ATD, agency, or buyer associated with the DSP that won the impression
campaignIdnumericCampaign of the advertiser associated with the ad.
categoryIdnumericCategory of the site from which an impression was requested.
channelIdnumericSales channel through which the impression was won (example: PMP, RTB).
cookiednumericIndicates whether the DSP's cookies were dropped when an impression was requested.
countryId numericCountry from which an impression was requested.
dataCenter numericData Center
datenumericDate (YYYY-MM-DD format) on which an impression was requested. 
dealMetaIdnumericName of the Marketplace deal that won the impression
domainIdnumericAdvertiser Domain is the domain name (Web address) of the advertiser. These domains are identified by the landing page of the impression displayed.
foldPositionIdnumericFold placement associated with the ad tag used when an impression was requested.
hournumericTime (YYYY-MM-DD'T'HH format) at which an impression was received. 
mobDeviceIdFlagnumericIndicates whether the user's device ID is present in the impression requests.
mobDeviceIdTypeIdnumericType of device used by the visitor to generate an impression request.
mobDeviceTypeIdnumericType of device ID used by the visitor to generate an impression request.
mobGeoSourceFlagnumericSource that provided the visitor's geographical location.
mobLatLongFlagnumericIndicates whether the visitor's latitude/longitude details were included in the impression request.
monthnumericMonth (YYYY-MM format) at which an impression was received.
multiBidsnumericTotal number of bid responses for a bid request.
platformIdnumericPlatform through which an impression was requested (example: Web, Mobile Web).
pubIdnumericPublisher associated with the impression requests.
secureStatusnumericIndicates whether the inventory is secure.
siteIdnumericURL of the site from which an impression was requested.
weeknumericWeek (YYYYWww format) at which an impression was received.

Dimensions for Domain Data

Info
Domains displayed in the Domain report are only for whitelisted publishers and channel partners.
                                 
Dimension IDData TypeDescription
applicationIdnumericMobile Application
bundleIdnumericMobile Bundle
dspTldIdnumericMobile Bundle

Available Metrics

Metrics for Historical Data

Metric IDData TypeDescription
averageBidEcpmAdv numericAverage CPM of the bid responses associated with an advertiser.      
averageBidEcpmAtdnumericAverage CPM of the bid responses associated with a buyer.        
averageBidEcpmDsp numericAverage CPM of the bid responses received from a DSP.
bidLossRateAdvnumericNumber of lost bids as % of total bids for Advertiser. Formula: bidLossRateAdv = (nonZeroBidReceived - paidImpressions ) * 100 / nonZeroBidReceived  
bidLossRateAtdnumericNumber of lost bids as % of total bids for ATD. Formula: bidLossRateAtd = (nonZeroBidReceived - paidImpressions ) * 100 / nonZeroBidReceived
bidLossRateDspnumericNumber of lost bids as % of total bids for DSP. Formula : bidLossRateDsp = (nonZeroBidResponses - paidImpressions) * 100 / nonZeroBidResponses
bidPercentageAdvnumericNumber of non-zero bids received as % of bid received. Formula: bidPercentageAdv =  (nonZeroBidReceived / totalBidsRequestsAdv ) * 100
bidPercentageAtdnumericNumber of non-zero bids received as % of bids received. Formula: bidPercentageAtd = ( nonZeroBidReceived / totalBidsRequestsAtd ) * 100
bidPercentageDsp numericNumber of non-zero bids received as % of bids received. Formula: bidPercentageAtd = ( nonZeroBidReceived / totalBidsRequestsAtd ) * 100
bidRequestCount numericBid Request Count
bidWinRateAdv numericAn advertiser's paid impressions divided by non-zero bids received, expressed as a percentage. Formula : (Paid Impressions * 100) / Non-Zero Bids Received
bidWinRateAtdnumericA buyer's paid impressions divided by non-zero bids received, expressed as a percentage. Formula : (Paid Impressions * 100) / Non-Zero Bids Received
bidWinRateDspnumericA DSP's paid impressions divided by non-zero bid responses, expressed as a percentage. Formula :(Paid Impressions * 100) / Non-Zero Bid Responses
clicksnumericNumber of paid impressions clicked by users.
ctrnumericEffectiveness of an ad based on the number of clicks it receives compared to the number of times it is displayed. Formula :CTR = clicks/paidImpressions *100
ecpmnumericAverage CPM (cost per thousand) for the impressions.
lostBidsAmountByCBLKnumericLost Bid Amount (Creative Block)  
lostBidsByAuctionnumericNumber of bid responses that did not win the impression (lost to other bid responses from DSPs and ad networks).  
lostBidsByBlockListnumericNumber of bid responses that did not win the impression because the attributes were either included in the publisher\u2019s blocklist or not included in the publisher\u2019s whitelist.
lostBidsByCBLK numeric Lost Bid Count (Creative Block) 
lostBidsByDWLFnumericNumber of bid responses that did not win the impression because the associated Marketplace deal's whitelist did not include the advertiser associated with the bid.
lostBidsByFloornumericNumber of bid responses that did not win the impression because the demand partner's bid value was below the floor set in the Marketplace Rule Manager.
nonZeroBidReceived  numericNumber of bids in responses from demand partners that had a non-zero bid value. In case of multi-bid responses, each non-zero bid in the response is counted individually. 
nonZeroBidResponsesnumericNumber of bid responses from demand partners that had a non-zero bid value; indicates bid responses intended to participate in the auction.  
paidImpressionsnumericNumber of impressions won by the demand partner.  
queryPerSecond numericQueries Per Second
spend numericSpend generated by an impression request.
timeoutRatenumericRate at which the ad timed out or failed to load.Formula: (Number of timeouts / Total number of requests to the DSP) * 100    
totalBidResponses  numericTotal bid responses received by the PubMatic system. 
totalBidsRequestsDspnumericTotal number of bid requests sent by PubMatic to a DSP.    
totalLostBidsAdv numericTotal number of advertiser bid responses that did not win the impressions.
totalLostBidsAtdnumericTotal number of buyer bid responses that did not win the impressions.
totalLostBidsDspnumericTotal number of DSP bid responses that did not win the impressions.  
totalRequestsnumericTotal Requests
vctrnumericClick Through Rate
video25PercentCountnumeric25% Video Count
video50PercentCountnumeric50% Video Count
video75PercentCountnumeric75% Video Count
videoClicksCountnumericVideo Click Count
videoCompleteCountnumericVideo Complete Count  
vtrnumeric Video Through Rate


Page Turner

⇧ Top