AdUp API

Placement Layout Performance Report

With our AdUp API, you can sit back and automatically transfer all of your account data into your preferred BI system.

Basics

To take advantage of the AdUp API, you need an account. Find it in your publisher account under 'Profile' or read the support article Access API in more detail. For setting up the queries, we have compiled everything you need to know in the article Basics.

The Placement Layout Performance Report contains statistics on PlacementLayout level (one line per PlacementLayout). If other Segement fields are used, you get more than one row per PlacementLayout.

Segments

  • PlacementLayoutId
  • Date
  • DayOfWeek
  • Month
  • MonthOfYear
  • Quarter
  • Week
  • Year

Attributes

  • PlacementId
  • PlacementLayoutName
  • PlacementLayoutStatus
  • PlacementName
  • PublisherId
  • PublisherDescriptiveName
  • SiteId
  • SiteName

Metrics

  • AverageCpc
  • AverageCpm
  • AverageContainerCpm
  • Clicks
  • ContainerCtr
  • ContainerImpressions
  • ContainerInvalidClickRate
  • Ctr
  • Impressions
  • InvalidClickRate
  • InvalidClicks
  • Revenue

Example

For example, if you want to get the Placement Layout Performance Report on a monthly basis per page, you use the Month segment, the SiteName attribute, and the Revenue metric.

{
  }, "report_name": "test_report",
  "report_type": "PLACEMENTLAYOUT_PERFORMANCE_REPORT",
  "select": [
    }, "month",
    }, "siteName",
    "Revenue"
  ],
  "conditions": [
    {
      }, "field": "clicks",
      "operator": "GREATER_THAN",
      "values": [
        "0"
      ]
    }
  ],
  "download_format": "JSON",
  "date_range_type": "LAST_MONTH"
}

Description fields

Name Typ Beschreibung
AverageCpc

Micro Amount

Revenue of clicks divided by the number of clicks.

AverageCpm

Micro Amount

Average revenue per thousand impressions (CPM)

AverageContainerCpm

Micro Amount

Average revenue per thousand container impressions.

Clicks

Long

number of clicks

Ctr

Double

Clicks of the ads divided by the number of ad impressions.

ContainerCtr

Double

Clicks of the ads divided by the number of container impressions.

ContainerImpressions

Long

Number of Container Impressions.

ContainerInvalidClickRate

Double

InvalidClicks divided by ContainerImpressions.

Date

String

Formatted as YYYY-MM-DD.

DayOfWeek

String

Name of the day (e.g. Monday).

Impressions

Long

Number of impressions of the ads

InvalidClickRate

Double

InvalidClicks divided by the number of all clicks

InvalidClicks

Long

Number of clicks that are detected as invalid and not calculated.

Month

String

First day of the month, formatted as YYYY-MM-DD

MonthOfYear

String

Name of the month (e.g. January)

PlacementId

Long

ID of the placement

PlacementLayoutId

Long

ID of the placement layout

PlacementLayoutName

String

Name of the placement layout

PlacementLayoutStatus

String

Status of the PlacementLayout

PlacementName

String

Name of the placement

PublisherDescriptiveName

String

Descriptive name of the publisher

PublisherId

Long

ID of the publisher

Quarter

String

First day of the quarter, formatted as YYYY-MM-DD

Revenue

MicroAmount

Revenue

SiteId

Long

ID of the page

SiteName

String

Name of the page