Adform Field Reference

Sample

https://connectors.windsor.ai/adform?api_key=<APIKEY>&date_preset=last_7d&fields=date,campaign_id,campaign,client,impressions,clicks,cost


Fields

IDTypeNameDescription
avgengagementtimeNUMERICAverage Engagement TimeThis metric shows the average engagement time of visible banners. A banner is visible when at least X % of its area is visible in user's screen. X parameter is collected from Campaign Details page. Three timed events are considered during calculation - mouse-over time, video play time, and expansion time. Measurement is based on sampled data.
avgviewabilitytimeNUMERICAverage Viewability TimeThis metric shows the average amount of time that users actually saw a viewable banner in their screen. TIP: A viewable impression is defined in the Ad Viewability settings, visible in the Campaign Details.
TEXTBannerThis dimension groups information by banner for Display campaigns, or by Adgroup for Search campaigns. Banner is an advertisement vehicle. The banner is displayed through different medias/publishers on different placements. Adgroup contains one or more keywords used in Search Engine campaigns.
TEXTBanner Attribute1This dimension groups information by Banner Attribute 1. Banner attribute is a user-defined property of a banner. Banner Attribute 1 is usually assigned to the banner batch column in Banner Overview page.
TEXTBanner SizeThis dimension groups information by banner size. Banner size is shown as "width x height" in pixels, e.g. 300 x 250.
TEXTBanner TypeThis dimension groups information by creative material type. Most common banner types include Flash, Image, Rich Media, Link, Keyword and other.
buy_typeTEXTBuy TypeThis dimension indicates the booking/buy types of the selected placement. Possible values - Impressions (CPM), Clicks (CPC), Viewable Impressions (vCPM), Days, Weeks, Months and Conversions.
campaignTEXTCampaignThis dimension shows and groups information by campaign. The campaign is the base item in Adform system, it contains media, placements, banners.
campaign_idTEXTCampaign_IDThis dimension groups data by Adform campaign ID.
campaign_typeTEXTCampaign TypeThis dimension groups information by campaign type. Campaign type can be assigned in Campaign Details page, possible values - Display, Affiliate, Email, Social Media and other.
clicksNUMERICClicksThis metric shows the number of clicks for the selected dimension. A click occurs when a user interacts with the advertisement by engaging a mouse button (usually the left) while the mouse pointer is hovering over the advertisement.
clicks_to_landing_pagePERCENTClicks To Landing PageThis metric shows the percentage of clicks ending up as visits on the landing page for the selected dimension.
clickscrossdeviceNUMERICClicks Cross DeviceThis metric shows the number of times that users clicked on a banner and were directed to an advertiser's destination. When selecting uniqueness levels, a user is considered unique across all their devices and identifiers. TIP - User engagements with rich media banners, e.g., click on video play start button, are not taken into account.
clientTEXTClientDisplays client/advertiser information. Used to group campaigns, in benchmarking reports etc.
conversionsNUMERICConversionsA tracked page can be defined as a Conversion - usually a page where a sign-up is confirmed or a sale is made. This metric shows the number of all Conversion pageviews displayed as a sum for all tracked conversion pages.
conversions_allcampaignNUMERICConversions for all Campaign interactions onlyDisplay site tracking statistics for all Campaign ad interaction only
conversions_allnoncampaignNUMERICConversions for all Non Campaign interactions onlyDisplay site tracking statistics for all Non Campaign ad interaction only
conversions_downloadNUMERICConversions for Download PagesDisplay statistics for Download page category only
conversions_homepageNUMERICConversions for Home PagesDisplay statistics for Home page category only
conversions_infopagesNUMERICConversions for Info PagesDisplay statistics for Info Pages page category only
conversions_landingpagesNUMERICConversions for Landing PagesDisplay statistics for Landing Pages page category only
conversions_nonepagesNUMERICConversions for None defined category of PagesDisplay statistics for None defined page category only
conversions_postclickNUMERICConversions for post Click interactions onlyDisplay site tracking statistics for post Click ad interaction only
conversions_postimpressionNUMERICConversions for post Impression interactions onlyDisplay site tracking statistics for post Impression ad interaction only
conversions_productpageNUMERICConversions for Product PagesDisplay statistics for Product page category only
conversions_recentclickNUMERICConversions for recent Click interactions onlyDisplay site tracking statistics for recent Click ad interaction only
conversions_recentimpressionNUMERICConversions for recent Impression interactions onlyDisplay site tracking statistics for recent Impression ad interaction only
conversions_signuppagesNUMERICConversions for Sign Up PagesDisplay statistics for Sign Up page category only
conversions_thankyoupageNUMERICConversions for Thank you PagesDisplay statistics for Thank you page category only
conversions_type1NUMERICConversions Type 1
conversions_type2NUMERICConversions Type 2
conversions_type3NUMERICConversions Type 3
conversionsallNUMERICConversions (all)A tracked page can be defined as a Conversion - usually a page where a sign-up is confirmed or a sale is made. This metric shows the number of all Conversion pageviews, displayed as a sum for all tracked conversion pages. It has predefined Uniqueness of 'No Repeat', which means that Conversion pageviews, generated by the same user within 15 minutes, are excluded.
costNUMERICCostThis metric shows the cost value for the selected dimension (usually on a media, placement (line item) level). Please check documentation for more details.
cost_by_salesNUMERICCost By SalesThis metric shows Cost value divided by Sales value. Cost is either booked or accumulated cost for the selected dimension, or RTB Budget Spent in case of Real Time Bidding campaign. Sales is a system variable and represents the returned value of a campaign.
cost_non_viewNUMERICCost Non ViewThis metric shows the cost value taking into account the percentage of non-viewable and undetermined impressions. TIP - Check documentation for more details.
cost_post_clickNUMERICCost Post ClickThis metric shows the post click conversions cost.
cost_viewNUMERICCost ViewThis metric shows the cost value taking into account the percentage of viewable impressions. TIP - Check documentation for more details.
countryCOUNTRYCountryGeographical dimension, groups information by visitor's country e.g. Denmark, UK, USA, etc.
covNUMERICCovThis metric shows the conversion rate for the selected dimension. Calculated as conversions divided from clicks, in percent.
ctrPERCENTCTRThis metric shows click-through rate for the selected dimension. It is a percentage of users who have been exposed to an advertisement and then clicked. Calculated as clicks divided from impressions, in percent.
ctr_adjustedPERCENTCTR AdjustedThis metric shows click-through rate for the selected dimension. It is a percentage of users who have been exposed to an advertisement and then clicked. Calculated as clicks divided from impressions, in percent. This metric considers all tag serving types such as Impressions, Invisible, Offile, etc. except for Clicks in order to assure consistent metric values.
ctr_uniquePERCENTCTR UniqueThis metric shows unique click-through rate for the selected dimension. It is a percentage of unique users who have been exposed to an advertisement and then clicked. Calculated as campaign unique clicks divided from campaign impressions, in percent.
ctr_viewPERCENTCTR ViewThis metric shows the percentage of impressions that resulted in a click, taking into account only those impressions that were actually in the users' screens.
datasourceTEXTData SourceThe name of the Windsor connector returning the row
dateDATEDateThis dimension groups information by date when a transaction happened.
day_of_monthTEXTDay of monthDay of the month
device_typeTEXTDevice typeTechnical dimension, groups data by device type, which can be - Desktop and Laptop, Small Screen Phone, Smart Phone, Tablet, Other Mobile, Media Hub, Console, TV, eReader, Smart Watch, Smart Speaker. It shows what share of traffic comes from different device types.
ecpaNUMERICEffective Cost per ActionThis metric shows effective Cost per Conversion (ID Fusion) with the conversion pages listed as a sum. Here, the user may have interacted with the campaign and website on different devices.
ecpcNUMERICEffective Cost per ClickThis metric shows cost per click for the selected dimension. Cost is either booked or accumulated cost for the selected dimension, or RTB Budget Spent in case of Real Time Bidding campaign.
ecpmNUMERICEffective Cost per Thousand ImpressionsThis metric shows cost per mille (thousand impressions) for the selected dimension. TIP: to report on eCPM (Reach) metric set Uniqueness as “Campaign Unique” and Cost type as “RTB” in metric settings.
engagementsNUMERICEngagementsThis metric shows the count of user interactions with a banner. User interactions are tracked as user-initiated banner events for Rich Media, Flash and Image banner types. Examples of user-initiated banner events are mouse-over (only if > 1 sec.), video play button press, close button press, etc. Not user-initiated banner events are not included into this metric, except for auto-expand event. Examples of not user-initiated banner event are Floating Banner Shown, 25% of Video Play, etc.
engaging_impressionsNUMERICEngagingImpressionsThis metric shows the sum of impressions, where at least one engagement occurred during each impression. Engagements are tracked as user-initiated banner events for Rich Media, Flash and Image banner types. Examples of user-initiated banner events are mouse-over (only if > 1 sec.), video play button press, close button press, etc.
eventTEXTEventThis dimension groups information by banner event name. Banner events can be implemented in flash banners in order to track user interactions with banners, such as expands, clicks on play button, etc.
eventsNUMERICEventsThis metric shows how many times an event has been invoked in a banner. Events can be implemented in flash banners in order to track user interactions with banners, such as expands, clicks on play button, etc. Tip - use with dimension Event Name if several different events are implemented.
hourTEXTHourTime dimension, groups information by hour of the day (values from 0 to 23).
impressionsNUMERICImpressionsThis metric shows the number of tracked ads (formerly known as impressions) and includes both rendered and served-but-not-rendered ads. Both client-initiated and server-initiated measurement is taken into account. Only client-initiated measurement is compliant with Media Rating Council (MRC) guidelines.
line_itemTEXTLineItemThis dimension groups information by Line Item. Line Item is an advertisement spot on a media/publisher.
line_item_end_dateDATELine Item End DateThis dimension displays Line Item end date collected from Mediaplan scheduler.
line_item_idTEXTLine Item IDThis dimension groups data by Adform Line Item ID.
line_item_label1TEXTLine Item Label 01This dimension groups data by Line Item Label 01
line_item_label10TEXTLine Item Label 1This dimension groups data by Line Item Label 10
line_item_label11TEXTLine Item Label 11This dimension groups data by Line Item Label 11
line_item_label12TEXTLine Item Label 12This dimension groups data by Line Item Label 12
line_item_label13TEXTLine Item Label 13This dimension groups data by Line Item Label 13
line_item_label14TEXTLine Item Label 14This dimension groups data by Line Item Label 14
line_item_label15TEXTLine Item Label 15This dimension groups data by Line Item Label 15
line_item_label16TEXTLine Item Label 16This dimension groups data by Line Item Label 16
line_item_label17TEXTLine Item Label 17This dimension groups data by Line Item Label 17
line_item_label18TEXTLine Item Label 18This dimension groups data by Line Item Label 18
line_item_label19TEXTLine Item Label 19This dimension groups data by Line Item Label 19
line_item_label2TEXTLine Item Label 02This dimension groups data by Line Item Label 02
line_item_label20TEXTLine Item Label 20This dimension groups data by Line Item Label 20
line_item_label3TEXTLine Item Label 03This dimension groups data by Line Item Label 03
line_item_label4TEXTLine Item Label 04This dimension groups data by Line Item Label 04
line_item_label5TEXTLine Item Label 05This dimension groups data by Line Item Label 05
line_item_label6TEXTLine Item Label 06This dimension groups data by Line Item Label 06
line_item_label7TEXTLine Item Label 07This dimension groups data by Line Item Label 07
line_item_label8TEXTLine Item Label 08This dimension groups data by Line Item Label 08
line_item_label9TEXTLine Item Label 09This dimension groups data by Line Item Label 09
line_item_start_dateDATELine Item Start DateThis dimension displays Line Item start date collected from Mediaplan scheduler.
measurable_impressionsNUMERICMeasurable ImpressionsThis metric shows the part of measured impressions that were actually in the users' screens, calculated as the percentage of viewable impressions in relation to measurable impressions
mediaTEXTMediaMedia/publisher is the provider of online advertising space, such as an online newspaper, social network site or other.
monthTEXTMonthNumber of the month
mpamountNUMERICMedia Plan AmountThis metric shows the spent amount visible in the Mediaplan. It can be set to show gross amount or net amount. Could be used to report on the cost and fee breakdown of a campaign.
mpnetamountNUMERICMedia Plan Net AmountThis metric shows the net spent amount visible in the Mediaplan.
pageviewsallNUMERICTotal PageviewsThis metric shows the number of all tracked pages (tracking points) pageviews, displayed as a sum for all tracked pages.
roiPERCENTROIThis metric shows the return of investment. A positive value corresponds to capital growth, a negative value corresponds to capital decay, and a value of 0% corresponds to no change. It is calculated as (Sales - Cost) / Cost * 100%, or as (Sales - RTB Budget Spent) / RTB Budget Spent * 100% in case of Real Time Bidding campaign.
rtb_domainTEXTRtb DomainThis dimension groups data by RTB domain. RTB domains show 2nd level URLs of publisher sites (e.g. cnn.com), where a banner was displayed when impression was registered. RTB domain values are tracked and sent to Adform by AdExchanges.
rtb_inventory_sourceTEXTRtb Inventory SourceGroups information by RTB Inventory Source. Inventory source is an ad exchange, which can be selected for running a Real Time Bidding campaign, e.g. Admeld, Microsoft Ad Exchange, etc.
rtbbidsNUMERICReal-Time Bidding BidsThis metric shows the number of offers done by Adform in attempt to win an impression on an ad exchange auction.
rtbwinratePERCENTReal-Time Bidding Win RateThis metric shows the proportion of impressions (won bids) in total number of bids (attempts to win an impression). Calculated as Impressions / Bids in %.
salesNUMERICSalesThis metric shows the sales value collected from all visits on tracked pages and is an Order level variable. Collected only if variable is implemented in Tracking points. It has predefined Uniqueness of 'No Repeat', which means that sales value form pageviews, generated by the same user within 15 minutes, are excluded.
salesallNUMERICTotal SalesThis metric shows the sales value collected from all visits on tracked pages. Collected only if variable is implemented in Tracking points.
sourceTEXTSourceThe name of the Windsor connector returning the row
tagTEXTTagTag is a small piece of code used to track online advertisements. This dimension groups information in relations to tags, it could be used to show rotators information.
todayDATETodayToday's date
totalcostNUMERICTotal CostThis metric shows the cost value for the selected dimension (usually on a media, placement (line item) level). Please check documentation for more details. (Duplicate)
unique__impressions_percentPERCENTUnique Impressions PercentThis metric shows the percentage of unique tracked ads(formerly known as impressions) in relation to all registered tracked ads
video_views_100NUMERICVideo views 100This metric shows 100% of the interactions with video banners,where banner events are implemented. Interactions such as Play, Pause, Stop, Sound On,and others can be reported
video_views_25NUMERICVideo views 25This metric shows at least 25% of the interactions with video banners,where banner events are implemented. Interactions such as Play, Pause, Stop, Sound On,and others can be reported
video_views_50NUMERICVideo views 50This metric shows at least 50% of the interactions with video banners,where banner events are implemented. Interactions such as Play, Pause, Stop, Sound On,and others can be reported
video_views_75NUMERICVideo views 75This metric shows at least 75% of the interactions with video banners,where banner events are implemented. Interactions such as Play, Pause, Stop, Sound On,and others can be reported
viewimpressionsNUMERICViewable ImpressionsThis metric shows the number of eligible impressions that were actually in the users' screens. According to IAB standards, an impression is counted as viewable when at least 50 % of the banner area is visible in the user's screen for at least 1 second; at least 30% of the large (greater than 242,000 pixels) banner area is visible in the user's screen for at least 1 second; at least 50% of the in-stream video is visible in the user's screen for at least 2 seconds. This metric is accredited by Media Rating Council (MRC) only when reported together with 'Ad Creative Type' dimension.
visitorsNUMERICVisitorsShows the number of unique visitors in advertiser's website for the selected tracking setup.
visitsNUMERICVisitsShows the number of visits in advertiser's website for the selected tracking setup.
weekTEXTWeekWeek (Sun-Sat).
week_dayTEXTDay of week and day numberWeekday number and name combined (Sun-Sat).Numbered from 0 Sunday to 6 Saturday.
week_day_isoTEXTDay of week and day number, ISOWeekday number and name combined, ISO format (Mon-Sun).Numbered from 1 Monday to 7
week_isoTEXTWeek ISOWeek, ISO format (Mon-Sun).
yearTEXTYearYear
year_monthTEXTYearmonthYear and month, e.g. 2024|3
year_of_weekTEXTYear of weekThe year that contains first day of the week (Sun-Sat).
year_of_week_isoTEXTYear of week, ISOThe year that contains first day of the ISO week (Mon-Sun).
year_weekTEXTYear weekYear and week for US weeks (Sun-Sat), e.g. 2024|15
year_week_isoTEXTYear week ISOYear and week for ISO weeks (Mon-Sun), e.g. 2024|20