Skip to main content

AdButler: Dimensions and metrics

List of AdButler dimensions and metrics available through a data request in Funnel.

How to get these dimensions and metrics in your workspace?

What do you need?

Submit a data request and select Request new data source. See Request new data in Funnel.

  • Business or Enterprise plan

  • In the Describe your need step, name AdButler and the report you want

  • Say whether each data source is for an advertiser or a publisher in AdButler

  • For the Ad Item Status report, say whether to turn off the zone breakdown

Each AdButler data source covers one advertiser or one publisher. Use the Campaign report or the Ad Item report for daily delivery data. Use the Ad Item Status report to add the current status and schedule of each ad item to your Ad Item report data.

​

Campaign report

Dimensions

  • Date

  • Campaign ID

  • Campaign Name

  • Campaign Start Date

  • Campaign End Date

  • Currency

  • Advertiser ID: Advertiser data sources only.

  • Advertiser Name: Advertiser data sources only.

  • Publisher ID: Publisher data sources only.

  • Publisher Name: Publisher data sources only.

​

Metrics

  • Clicks

  • Conversions

  • Conversion Quantity

  • Conversion Value

  • Cost

  • CTR

  • CVR

  • E CPA

  • E CPC

  • E CPM

  • Eligible

  • Eligible Impressions

  • Impressions

  • Payout

  • Responses

  • Revenue

  • Viewable

  • Viewable CTR

  • Viewable Impressions

​

Ad Item report

Dimensions

  • Date

  • Ad Item ID

  • Ad Item Name

  • Advertiser ID

  • Advertiser Name

  • Campaign ID

  • Campaign Name

  • Campaign Start Date

  • Campaign End Date

  • Currency

  • Zone ID

  • Zone Name

  • Zone Type

  • Publisher ID: Publisher data sources only.

  • Publisher Name: Publisher data sources only.

​

Metrics

  • Clicks

  • Conversions

  • Conversion Quantity

  • Conversion Value

  • Cost

  • CTR

  • CVR

  • E CPA

  • E CPC

  • E CPM

  • Eligible

  • Eligible Impressions

  • Impressions

  • Payout

  • Responses

  • Revenue

  • Viewable

  • Viewable CTR

  • Viewable Impressions

​

Ad Item Status report

The Ad Item Status report shows the current status and schedule of every ad item. It has no date. Each sync replaces the previous data, so the report never holds history. By default, the report has one row per campaign, ad item and zone, so Ad Item ID and Campaign ID can repeat. Before you use Ad Item ID as a lookup key for your Ad Item report data, turn off the zone breakdown and check that each Ad Item ID appears only once.

​

Dimensions

  • Ad Item ID

  • Ad Item Name

  • Ad Item Type

  • Ad Item Active

  • Advertiser ID

  • Campaign ID

  • Campaign Name

  • Campaign Archived

  • Assignment Status: The status of the campaign assignment, as AdButler returns it.

  • Zone ID: Only when the zone breakdown is on.

  • Zone Name: Only when the zone breakdown is on.

  • Placement Active

  • Placement Type

  • Schedule ID

  • Schedule Status

  • Schedule Start Datetime: Includes the UTC offset of the schedule time zone.

  • Schedule End Datetime: Includes the UTC offset of the schedule time zone. Empty if the schedule never ends or its end is unknown.

  • Schedule Start Date: The date (YYYY-MM-DD) in the schedule time zone.

  • Schedule End Date: The last day the schedule can deliver, in the schedule time zone. An end at exactly 00:00 gives the day before.

  • Campaign Scheduling Source: CAMPAIGN or AD_ITEM. Shows whether AdButler takes the schedule from the campaign or from the ad item.

  • Campaign Status: active or paused, based on the campaign placements. Empty if the campaign has no placement.

  • Campaign Schedule Status

  • Campaign Schedule Start Datetime: The earliest start of the campaign schedules.

  • Campaign Schedule End Datetime: The latest end of the campaign schedules. Empty if any schedule has no end date.

  • Campaign Schedule Start Date

  • Campaign Schedule End Date

​

The campaign schedule dimensions are empty for ad items placed directly in a zone, without a campaign.

​

Metrics

  • Zone Count: The number of distinct zones in the row. Only when the zone breakdown is off. Funnel sums it when you group rows.

​

Zone breakdown

The zone breakdown is on by default. It changes how many rows the Ad Item Status report has:

​

  • On: One row per campaign, ad item and zone. The report includes Zone ID and Zone Name.

  • Off: One row per campaign and ad item. The report includes Zone Count instead of Zone ID and Zone Name. Ad Item ID is unique only if each ad item is in one campaign, so check for repeated IDs before you use it as a lookup key.

​

When the zone breakdown is off, Placement Active is true if any zone is active. Schedule start is the earliest start and schedule end is the latest end across the zones. Schedule ID and Placement Type are empty if the zones differ.

​

To turn the zone breakdown off, say so in your data request.

​

Notes

  • You can't switch an existing AdButler data source to the Ad Item Status report. Request a new data source for it.

  • Changing the zone breakdown on an existing data source replaces Zone ID and Zone Name with Zone Count, or the other way around. If your reports use the zone dimensions, request a separate data source instead.

​

API documentation

For full field definitions and updates, see the AdButler API documentation.

Did this answer your question?