Campaign Performance Report Advertiser API

Basics

To take advantage of the AdUp API, you need an account. Find it in your advertiser 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 Basics article.

The Campaign Performance Report contains campaign-level statistics (one row per campaign). If other Segement fields are used, you will get more than one row per campaign.

Segment

CampaignId
Device
Date
DayOfWeek
Month
MonthOfYear
Quarter
Week
Year

Attribute

AccountId
AccountDescriptiveName
AdGapId
CampaignDesktopBidModifier
CampaignMobileBidModifier
CampaignTabletBidModifier
CampaignName
CampaignStatus
EndDate
Period
StartDate
TrackingUrlTemplate

Metrics

AllConversionsRate
AllConversions
AverageCost
AverageCpc
AverageCpm
AveragePosition
Clicks
ConversionRate
Conversions
Cost
CostPerAllConversion
CostPerConversion
Ctr
Impressions
InteractionRate
Interactions
InvalidClickRate
InvalidClicks
ViewThroughConversions

Example

For example, if you want to get the Campaign Performance Report on a monthly basis per campaign, you use the Month segment, the CampaignName attribute, and the Clicks metric.

{
  "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"
}

Description fields

Name	Typ	Beschreibung
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 the same as "Conversions"
AverageCost	Micro Amount	Average cost per interaction
AverageCpc	Micro Amount	Cost of clicks divided by 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	Campaign ID
CampaignName	String	Campaign name
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 by impression date. Including externally uploaded conversions. Conversions by impression date can change afterwards, depending on the tracking time window specified.
Cost	Micro Amount	Total cost of 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 was 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 only clicks.
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)
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 conversions, i.e. conversions that are completed after a user has been shown an ad.

Notes

How can I report conversions by conversion date?

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

Campaign Performance Report