Skip to end of metadata
Go to start of metadata

Publisher Analytics Report

This documentation assumes you have access to the AppNexus API. You will have to work with the AppNexus platform member you are partnering with to get access to the publisher reporting described on this page.

For instructions on authenticating with our APIs, see the Authentication Service.

The Publisher Analytics report can be used to view revenue and profit data across a specific publisher's sites and placements. This report is available to both network and publisher users.

For instructions on retrieving a report, please see the Examples below. This report requires that a publisher ID be specified as part of the URL as follows:

http://api.appnexus.com/report?publisher_id=PUBLISHER_ID

On This Page

Time Frame

The report_interval field in the JSON request can be set to one of the following:

  • current_hour
  • last_hour
  • today
  • yesterday
  • last_48_hours
  • last_7_days
  • month_to_date
  • month_to_yesterday
  • quarter_to_date
  • last_month
  • lifetime

Data Retention Period

Most data in this report is maintained permanently (exceptions noted below). After:

  • 100 days, you are no longer able to report on hourly data (however, daily, monthly and cumulative intervals are still available) 
  • 14 months, you are no longer able to report on individual:
    • Creatives
    • Placements
    • Brands

In some cases Analytics reports can show delivery that does not match Lifetime QuickStats for a given advertiser or publisher. This is due to the way that Analytics reporting data older than 100 days and 14 months is aggregated. The data from Billing reports are kept in non-aggregated form indefinitely. 

Dimensions

Column

Type

Group?

Filter?

Example

Description

hour

time

yes

no

"2010-02-01 06:00:00"

The hour of the auction. Note that, for impressions older than 100 days, the day will be returned rather than the hour.

day

time

yes

no

"2010-02-01"

The day of the auction.

month

time

yes

no

"2010-02"

The month of the auction.

publisher_id

int

yes

yes

923

The ID of the publisher.

publisher_code

string

no

no

"My Publisher Code"

The custom code for the publisher.

publisher_currency

string

no

no

"USD"

The currency of the publisher.

pub_rule_id

int

yes

yes

736

The ID of the publisher rule.

pub_rule_name

string

no

no

"My Publisher Rule"

The name of the publisher rule.

pub_rule

string

no

no

"My Publisher Rule (736)

The name of the publisher rule followed by the ID (AppNexus format).

pub_rule_code

string

no

no

"My Publisher Rule Code"

The custom code for the publisher rule.

seller_member_id

int

yes

yes

456

The ID of the selling member.

geo_country

string

yes

yes

"US"

The code of the geographical country.

geo_country_name

string

no

no

"United States"

The name of the geographical country.

size

string

yes

yes

"728x90"

The size of the placement/creative served.

placement_id

int

yes

yes

546

The ID of the placement. Note that, for RTB impressions older than 30 days, and for non-RTB impressions older than 100 days, placements will be aggregated into one row with -1 as the placement_id.

placement_name

string

no

no

"300x250 Business"

The name of the placement. Note that, for RTB impressions older than 30 days, and for non-RTB impressions older than 100 days, placements will be aggregated into one row with "All placement data older than 100 days" as the placement_name.

placement

string

no

no

"Photos 728x90 (567)"

The name of the placement followed by the ID (AppNexus format).

placement_code

string

no

no

"Photos Code"

The custom code for the placement.

brand_id

int

yes

yes

3

The ID of the brand associated with a creative served on the publisher's inventory.

brand_name

string

no

no

"Ace Hardware"

The name of the brand associated with a creative served on the publisher's inventory.

brand

string

no

no

"Ace Hardware (3)"

The name of the brand followed by the ID (AppNexus format).

supply_type

string

yes

no

 

The type of inventory. Possible values:

  • "web"
  • "mobile_web"
  • "mobile_app"

imp_type_id

int

yes

yes

1

The ID for the type of impression. Possible values (associated types in parentheses):

  • 1 ("Blank"): No creative served.
  • 2 ("PSA"): A public service announcement served because there were no valid bids and no default creative was available.
  • 3 ("Default Error"): A default creative served due to a timeout issue.
  • 4 ("Default"): A default creative served because there were no valid bids.
  • 5 ("Kept"): Your advertiser's creative served on your publisher's site.
  • 6 ("Resold"): Your publisher's impression was sold to a third-party buyer.
  • 7 ("RTB"): Your advertiser's creative served on third-party inventory.
  • 8 ("PSA Error"): A public service announcement served due to a timeout issue or lack of a default creative.
  • 9 ("External Impression"): An impression from an impression tracker.
  • 10 ("External Click"): A click from a click tracker.

imp_type

name

yes

yes

"Kept"

The type of impressions. For possible values see imp_type_id.

media_type

string

no

no

"Banner", "Pop", "Interstitial", "Video", "Text", "Expandable", "Skin"

The general display style of a creative served on the publisher's inventory.

adjustment_id

int

yes

yes

  

Metrics

Column

Type

Example

Formula

Description

imps_total

int

234223

imps

The total number of impressions (including defaults).

imps_sold

int

234123

imps_sold

The total number of impressions sold to direct and real-time advertisers.

imps_default

int

100

imps_default

The total number of impressions that defaulted.

imps_blank

int

12

imps_blank

The number of impressions served with a blank.

imps_psa

int

10

imps_psa

The number of impressions served a PSA.

imps_default_error

int

3

imps_default_error

The number of impressions that defaulted due to a timeout issue .

imps_default_bidder

int

5

imps_default_bidder

The number of impressions that defaulted because there were no valid bids.

imps_kept

int

405

imps_kept

The number of impressions your advertiser purchased from your publisher .

imps_resold

int

506

imps_resold

The number of impressions your publisher sold to a third party .

imps_rtb

int

94

imps_rtb

The number of impressions your advertiser bought from a third party .

imps_filled

int

4900

imps_filled

The number of blank, PSA, default, kept, resold, and external impressions.

external_impression

int

0

external_impression

The number of impressions from an impression tracker.

external_click

int

0

external_click

The number of clicks from a click tracker.

clicks

int

545

clicks

The total number of clicks across all impressions.

publisher_revenue

money

400.05

publisher_revenue

The revenue paid out to the publisher (based on revshare or CPM).

publisher_revenue_pub_curr

money

400.05

publisher_revenue_pub_curr

The revenue paid out to the publisher (based on revshare or CPM), in the currency of the publisher.

publisher_filled_revenue

money

350.02

publisher_filled_revenue

The revenue paid out to the publisher (based on revshare or CPM) for filled impressions.

publisher_filled_revenue_publisher_curr

money

350.02

publisher_filled_revenue

The revenue paid out to the publisher (based on revshare or CPM) for filled impressions, in the currency of the publisher.

publisher_default_revenue

money

350.02

publisher_default_revenue

The revenue paid out to the publisher (based on revshare or CPM) for default impressions.

publisher_default_revenue_publisher_curr

money

350.02

publisher_default_revenue

The revenue paid out to the publisher (based on revshare or CPM) for default impressions, in the currency of the publisher.

total_convs

int

205

total_convs

The total number of post view and post click conversions.

ctr

double

0.002327

clicks / imps

The rate of clicks to impressions.

click_thru_pct

double

1.12359550561797

(clicks / imps) * 100

The rate of clicks to impressions as a percentage.

convs_rate

double

0.000856

total_convs / imps

The rate of conversions to impressions.

convs_per_mm

double

221.877080097625

(total_convs / imps) x 1,000,000

The number of conversions per million impressions.

publisher_rpm

money

1.71

(publisher_revenue / imps) x 1000

The publisher revenue per 1000 impressions.

publisher_rpm_pub_curr

money

1.71

(publisher_revenue / imps) x 1000

The publisher revenue per 1000 impressions, in the currency of the publisher.

publisher_filled_rpm

money

 

(publisher_revenue / imps_filled) x 1000

The publisher revenue per 1000 filled impressions.

publisher_filled_rpm_publisher_currency

money

 

(publisher_revenue / imps_filled) x 1000

The publisher revenue per 1000 filled impressions, in the publisher's currency.

publisher_default_rpm

money

1.71

(publisher_revenue / imps_default) x 1000

The publisher revenue per 1000 default impressions.

publisher_default_rpm_publisher_curr

money

1.71

(publisher_revenue / imps_default) x 1000

The publisher revenue per 1000 default impressions, in the currency of the publisher.

Age Buckets

Bucket ID

Bucket Name

0

"unknown"

1

"13-17"

2

"18-24"

3

"25-34"

4

"35-44"

5

"45-54"

6

"'55-64"

7

"65+"

Example

This example assumes you have already gained access to the API using the Authentication Service.

Retrieving a report from our system involves the following steps:

  1. POST the JSON file describing your request to our reporting API.
  2. Check the status of your request by sending periodic GET requests until the JSON response's "status" field is "ready"; when this happens you can extract the report download URL from the response's "url" field.
  3. Make a GET call to the /report-download endpoint to get the report data. Note that report data is always formatted as CSV. Here's an example: publisher_analytics_report.csv.

 

Step 1. Prepare your report request
Step 2. POST the request JSON to the report service
Step 3. Check the status of your request
Step 4. Download your data
  • No labels