Skip to main content

Metrics

M
Written by Megan Pratt
Updated over a month ago


Metrics Parameter

REQUIRED.

To understand what each metric represents, see the metrics glossary.

Parameter

Type

Examples

metrics

array of strings

"metrics": ["viewable_impressions", "viewable_ctr"]

Available Metrics

The available options for metrics varies for each specific Reporting resource.

πŸ“˜

New metrics

The available metrics can change as new features are added.

To get the latest list of available metrics for a specific endpoint, submit one of the following requests:

Endpoint

Description

GET /data/direct/options/metrics

Metrics for Direct campaigns

GET /data/preferred/options/metrics

Metrics for Preferred campaigns

GET /data/marketplace/options/metrics

Metrics for Marketplace campaigns

GET /data/managed/options/metrics

Metrics for Managed campaigns

GET /data/demand/options/metrics

Metrics for Demand

GET /data/auction/options/metrics

Metrics for Auction

GET /data/inventory/options/metrics

Metrics for Inventory

Sample Response

The response returns a multiple arrays of objects where:

  • label: the human-readable name

  • value: the option that can be submitted in a request

Each array represents a set of related metrics. The grouping is not use in requests.

Sample Response

{ "data": { "metrics": { "reach": [ { "label": "Impressions", "value": "impressions" }, { "label": "CTR", "value": "ctr" } ] } }, "messages": null, "status": "success", "status_code": 200 }

Globally Deprecated Metrics

The following metrics are no longer available for any Reporting resource:

Value

Description

publisher_ecpm

Replaced by publisher_evcpm

publisher_cpm

Replaced by publisher_evcpm

Metric Dependencies

🚧

Requests must include dependencies

Some metrics require a specific breakdown to be included in the request.

Label

Value

Required Breakdown

Actual End Date

actual_end_date

One of: campaign, budget, or ad

Actual Start Date

actual_start_date

One of: campaign, budget, or ad

Budget Amount

total_budget

budget

Flight End Date

flight_end_date

One of: campaign, budget, or ad

Flight Start Date

flight_start_date

One of: campaign, budget, or ad

Rate Type

rate_type

budget

% Gross Budget Spent

gross_budget_fill

One of: campaign, budget, or ad

Metric Compatibility

Label

Value

Inventory

merged_inventory

Does not work with ANY breakdown

Did this answer your question?