AdUp API

Ad 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 advertiser account under 'Profile' or read the support article Access API in more detail. For setting up the queries, we've put together everything you need to know in the Basics article.

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

Segments

  • Date
  • DayOfWeek
  • Ad Id
  • Month
  • MonthOfYear
  • Quarter
  • Week
  • Year

Attributes

  • AccountId
  • AccountDescriptiveName
  • AdName
  • CampaignId
  • CampaignName
  • CampaignStatus
  • CreativeFinalUrl
  • CreativeFinalMobileUrl
  • CreativeFinalUrlSuffix
  • Description
  • DisplayUrl
  • Headline
  • Path1
  • Path2
  • Slot
  • Status
  • TrackingUrlTemplate

Metrics

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

Example

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

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

Description fields

Name Typ Beschreibung
AccountDescriptive
Name

String

the name of the account

AccountId

Long

the ID of the account

AdgroupId

Long

the ID of the adgroup

AdgroupName

String

the name of the adgroup

AdgroupStatus

String

the status of the Adgroup

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

All conversions tracked by AdUp

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

CampaignId

Long

Campaign ID

CampaignName

String

Campaign name

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

number of conversions

Cost

Micro Amount

Total cost of 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

Beschreibungstext des Ads

Device type of the user

DisplayUrl

Anzeige-URL des Ads

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. Clicks with normal ads.

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 PathString 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 conversions, i.e. conversions that are completed after a user has been shown an ad.