Home

Support

Campaign Performance Report (Advertiser API)

Home

Support

Campaign Performance Report (Advertiser API)

Campaign

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.

Basics

To take advantage of the AdUp API, you need access. Find it 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 Campaign Performance Report contains statistics at campaign level (one row per campaign). If other segment fields are used, you will get more than one row per campaign.

Segments

  • CampaignId

  • Device

  • Date

  • DayOfWeek

  • Month

  • MonthOfYear

  • Quarter

  • Week

  • Year

Attributes

  • AccountId

  • AccountDescriptiveName

  • AdGapId

  • CampaignDesktopBidModifier

  • CampaignMobileBidModifier

  • CampaignTabletBidModifier

  • CampaignName

  • CampaignStatus

  • EndDate

  • Period

  • StartDate

  • TrackingUrlTemplate

Metrics

  • AllConversionsRate

  • AllConversionsRateByConversionDate

  • AllConversions

  • AllConversionsByConversionDate

  • AverageCost

  • AverageCpc

  • AverageCpm

  • AveragePosition

  • Clicks

  • ConversionRate

  • ConversionRateByConversionDate

  • Conversions

  • ConversionsByConversionDate

  • Cost

  • CostPerAllConversion

  • CostPerAllConversionByConversionDate

  • CostPerConversion

  • CostPerConversionByConversionDate

  • Ctr

  • Impressions

  • InteractionRate

  • Interactions

  • InvalidClickRate

  • InvalidClicks

  • ViewThroughConversions

  • ViewThroughConversionsByConversionDate

Example

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

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


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


{
  "report_name": "Test Report",
  "report_type": "CAMPAIGN_PERFORMANCE_REPORT",
  "select": [
    "Month",
    "CampaignName",
    "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

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

CampaignDesktop
BidModifier

Double

Bid modifier for desktop devices

CampaignId

Long

ID of the campaign

CampaignName

String

Name of the campaign

CampaignMobile
BidModifier

Double

Bid modifier for mobile devices

CampaignStatus

String

Status of the campaign


Double

Bid modifier for tablet devices

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 after the impression date, including externally uploaded conversions. Conversions after the impression date can change retroactively, depending on the stored tracking window.

Cost

Micro Amount

Total cost of the Ads

CostPerAllConversion

Micro Amount

Cost divided by AllConversions

CostPerConversion

Micro Amount

Cost divided by Conversions

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)

Device

String

Device type of the user

EndDate

String

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

Format YYYY-MM-DD

Impressions

Long

Number of impressions of the Ads

InteractionRate

Double

Interactions divided by impressions

Interactions

Long

Interactions with the Ads. Currently exclusively clicks.

InvalidClickRate

Double

InvalidClicks divided by the number of all clicks

InvalidClicks

Long

Number of clicks identified as invalid and not charged.

Month

String

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

MonthOfYear

String

Name of the month (e.g. January)

Period

String

Budget period (“daily“ or “total“)

Quarter

String

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

StartDate

String

Start date of the campaign.

Format YYYY-MM-DD

TrackingUrlTemplate

String

Tracking URL template at campaign level.

ViewThroughConversions

Long

The number of view-through conversions, i.e. conversions completed after a user has been 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

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.

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