Home

Support

Ad Performance Report (Advertiser API)

Home

Support

Ad Performance Report (Advertiser API)

Campaign

Ad Performance Report (Advertiser API)

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

Basics

In order to benefit from the AdUp API, you need access. You can find this in your Advertiser Account under ‘Profile’, or read more details in the support article Access  API . For setting up queries, we have compiled everything you need to know in the Basics article.

The Ad Performance Report contains statistics at the account level (one row per account). If other segment fields are used, you will receive more than one row per account.

Segments

  • Date

  • DayOfWeek

  • Id

  • Month

  • MonthOfYear

  • Quarter

  • Week

  • Year

Attributes

  • AccountId

  • AccountDescriptiveName

  • AdGapId

  • AdGapLevel

  • AdgroupId

  • AdgroupName

  • AdgroupStatus

  • AdName

  • CampaignId

  • CampaignName

  • CampaignStatus

  • CreativeFinalUrl

  • CreativeFinalMobileUrl

  • CreativeFinalUrlSuffix

  • Description

  • DisplayUrl

  • Headline

  • Path1

  • Path2

  • Slot

  • Status

  • TrackingUrlTemplate

Metrics

  • AllConversionsRate

  • AllConversionsRateByConversionDate

  • AllConversions

  • AllConversionsByConversionDate

  • AverageCost

  • AverageCpc

  • AverageCpm

  • AveragePosition

  • Clicks

  • ConversionRate

  • ConversionRateByConversionDate

  • Conversions

  • ConversionsByConversionDate

  • Cost

  • CostPerAllConversion

  • CostPerAllConversionByConversionDate

  • CostPerConversion

  • CostPerConversionByConversionDate

  • Ctr

  • Impressions

  • InteractionRate

  • Interactions

  • ViewThroughConversions

  • ViewThroughConversionsByConversionDate

Example

For example, if you want to retrieve the Ad Performance Report on a monthly basis per ad, you use the Segment Month, the Attribute AdName, and the Metric Clicks.

{
  "report_name": "Test Report",
  "report_type": "AD_PERFORMANCE_REPORT",
  "select": [
    "Month",
    "AdName",
    "Clicks"
  ],
  "conditions": [
    {
      "field": "Clicks",
      "operator": "GREATER_THAN",
      "values": [
        "0"
      ]
    }
  ],
  "download_format": "JSON",
  "date_range_type": "LAST_MONTH"


{
  "report_name": "Test Report",
  "report_type": "AD_PERFORMANCE_REPORT",
  "select": [
    "Month",
    "AdName",
    "Clicks"
  ],
  "conditions": [
    {
      "field": "Clicks",
      "operator": "GREATER_THAN",
      "values": [
        "0"
      ]
    }
  ],
  "download_format": "JSON",
  "date_range_type": "LAST_MONTH"


{
  "report_name": "Test Report",
  "report_type": "AD_PERFORMANCE_REPORT",
  "select": [
    "Month",
    "AdName",
    "Clicks"
  ],
  "conditions": [
    {
      "field": "Clicks",
      "operator": "GREATER_THAN",
      "values": [
        "0"
      ]
    }
  ],
  "download_format": "JSON",
  "date_range_type": "LAST_MONTH"

Field Description

Name

Type

Description

AccountDescriptive
Name

String

the name of the account

AccountId

Long

the ID of the account

AdGapId

String

AdGap ID of the ad

AdgroupId

Long

the ID of the ad group

AdgroupName

String

the name of the ad group

AdgroupStatus

String

the status of the ad group

AdName

String

the name of the ad

AdStatus

String

the status of the ad

AllConversionRate

Double

Number of all conversions tracked by AdUp divided by the number of clicks that can generate conversions.

AllConversions

Long

Currently, there is no difference to “Conversions”

AverageCost

Micro Amount

Average cost per interaction

AverageCpc

Micro Amount

Cost of clicks divided by the number of clicks.

AverageCpm

Micro Amount

Average cost per thousand impressions (CPM)

AveragePosition

Double

Average position in relation to other advertisers

CampaignId

Long

ID of the campaign

CampaignName

String

Name of the campaign

CampaignStatus

String

Status of the campaign

Clicks

Long

Number of clicks

ConversionRate

Double

Number of conversions divided by the number of clicks that can generate conversions.

Conversions

Long

All click conversions available in the statistics by impression date, including externally uploaded conversions. Conversions by impression date may change retrospectively, depending on the tracking window defined.

Cost

Micro Amount

Total cost of the ads

CostPerAllConversion

Micro Amount

Cost divided by AllConversions

CostPerConversion

Micro Amount

Cost divided by Conversions

CreativeFinalUrl

String

the final URL of the ad

CreativeFinalMobileUrl

String

the mobile final URL of the ad

CreativeFinalUrlSuffix

String

additional text at the end of the final URL

Ctr

Double

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

Date

String

Formatted as YYYY-MM-DD

DayOfWeek

String

Name of the day (e.g. Monday)

Description

Description text of the ad

Device type of the user

DisplayUrl

Display URL of the ad

End date of the campaign or NULL if no end date was specified.

Format YYYY-MM-DD

Headline

String

Headline of the ad

Id

Long

the ID of the ad

Impressions

Long

Number of impressions of the ads

InteractionRate

Double

Interactions divided by impressions

Interactions

Long

Interactions with the ads. Currently, exclusively clicks.

Month

String

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

MonthOfYear

String

Name of the month (e.g. January)

Path1

String

Path string in display URL

Path2

String

in addition to Path1, another path string in display URL

Quarter

String

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

Status

String

the status of the ad

TrackingUrlTemplate

String

Tracking URL template at campaign level.

ViewThroughConversions

Long

The number of view-through conversions, i.e. conversions that are completed after a user was shown an ad.

Notes

How can conversions be reported by conversion date?

Conversions by conversion date are currently not available via the API.

You might also be interested in this

5 min read

Basics of the AdUp API

Use the AdUp API to retrieve reports and performance data automatically. Learn how to authenticate via OAuth, generate reports and efficiently integrate data into your own systems.

Product

5 min read

Our Delivery API

Use the AdUp Delivery API to programmatically integrate, update or remove ads – ideal for dynamic websites and modern web applications.

Publisher

5 min read

Placement Layout Performance Report

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

Publisher

5 min read

Campaign Performance Report (Advertiser API)

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

Advertiser

5 min read

Account Performance Report

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

Advertiser

5 min read

Access to the AdUp API

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

Advertiser

Publisher