Adform (Master Data): Most-used fields#
The table below gives information about most-used fields that you can import from Adform (Master Data). Other fields might also be available in Adverity.
The fields that you can fetch in Adverity are updated regularly to reflect updates to data source APIs.
API name |
Adverity UI name |
Description |
Use in Adverity |
|---|---|---|---|
AdInteraction |
AdInteraction |
Represents a specific interaction with an advertisement, such as a click or view. Master data files store raw data from online transactions like clicks, impressions, events, and tracking points. |
dimension |
AgencyId |
AgencyId |
A unique identifier for an advertising agency. |
metric |
AllSitesUniqueCampaignFlag |
AllSitesUniqueCampaignFlag |
A flag indicating a unique campaign view across all sites for a specific user. |
metric |
AllSitesUniqueDayFlag |
AllSitesUniqueDayFlag |
A flag indicating a unique view across all sites for a specific user within a single day. |
metric |
Assists |
Assists |
The number of non-last-click interactions (impressions or clicks) that contributed to a conversion. |
dimension |
AttributedByCookielessPostClickID |
AttributedByCookielessPostClickID |
An identifier used to attribute a transaction back to a cookieless post-click event. |
dimension |
AttributedTransactionGUID |
AttributedTransactionGUID |
A globally unique identifier for a transaction that has been attributed to an ad interaction, linking a conversion back to a specific ad touchpoint. |
dimension |
AttributedTransactionId |
AttributedTransactionId |
A unique identifier for a transaction that has been attributed to an ad interaction, linking a conversion back to a specific ad touchpoint. |
metric |
BannerElementGroupId |
BannerElementGroupId |
Identifier for a group of elements within an ad banner. |
metric |
BannerId-AdGroupId |
BannerId-AdGroupId |
A combined identifier representing a specific banner within an ad group, used for grouping information by banner or ad group in Display and Search campaigns respectively. |
metric |
BatchId |
BatchId |
An identifier assigned to a group of data records processed together in a batch. |
metric |
BrowserId |
BrowserId |
A unique identifier for the web browser used during an ad interaction or website visit. Browsers are part of metadata files. |
metric |
BuyType |
BuyType |
The type of booking or buying model used for a placement, such as Impressions (CPM), Clicks (CPC), Viewable Impressions (vCPM), Days, Weeks, Months, or Conversions. |
dimension |
Campaign Category |
Campaign Category |
A categorization for campaigns, allowing for easier organization and analysis. |
dimension |
CampaignID |
CampaignID |
A unique identifier for an advertising campaign. |
metric |
CampaignId |
CampaignId |
A unique identifier for an advertising campaign. Campaigns are the base item in the Adform system and are part of metadata files. |
metric |
CampaignName |
CampaignName |
The name of the advertising campaign. |
dimension |
CampaignStartDate |
CampaignStartDate |
The start date of the advertising campaign. |
dimension |
CcpaPrivacyString |
CcpaPrivacyString |
A privacy string adhering to the California Consumer Privacy Act (CCPA) specification, indicating user consent and privacy preferences. |
dimension |
CityId |
CityId |
A unique identifier for a city. |
metric |
ClickCost |
ClickCost |
The cost incurred for a click on an advertisement. |
metric |
ClientId |
ClientId |
A unique identifier for a client or advertiser account. This dimension displays and groups client/advertiser information, used for benchmarking reports. |
metric |
CookieID |
CookieID |
A unique identifier stored in a user’s browser cookie for tracking purposes. |
metric |
CookielessPostClickID |
CookielessPostClickID |
A unique identifier for a post-click event that occurred without the use of cookies, often for cross-device tracking. |
dimension |
CookiesEnabled |
CookiesEnabled |
A flag indicating if cookies are enabled in the user’s browser for tracking purposes. |
metric |
CrossDeviceData |
CrossDeviceData |
Data used to link user interactions and behaviors across multiple devices. |
dimension |
Date |
Date |
The date of an event or interaction, used for time-based data grouping. Dates in Adform APIs are passed as strings which follow ISO-8601 format. |
dimension |
DecryptedIP |
DecryptedIP |
The decrypted Internet Protocol (IP) address of the user’s device, used for privacy-compliant logging and analysis. |
dimension |
DecryptedIPv6 |
DecryptedIPv6 |
The decrypted IPv6 address of the user’s device. |
dimension |
DestinationURL |
DestinationURL |
The URL a user is directed to after clicking an advertisement. |
dimension |
DeviceTypeId |
DeviceTypeId |
A unique identifier for the type of device (e.g., desktop, mobile, tablet) used by the user. Devices are part of metadata files. |
metric |
Engagement |
Engagement |
A metric representing user interaction with an ad beyond a simple impression, such as mouseovers or video plays. |
metric |
EuConsentString |
EuConsentString |
A privacy string adhering to European Union (EU) consent regulations, such as GDPR and IAB TCF, indicating user consent. |
dimension |
EventId |
EventId |
A unique identifier for a specific event tracked in a banner or on a website. Events are part of transactional data. |
metric |
FirstPartyId |
FirstPartyId |
A unique identifier for a first-party entity, such as an advertiser or direct client. |
dimension |
FrequencyCampaignViewInterval |
FrequencyCampaignViewInterval |
The time interval used to measure how often a campaign is viewed by a user. |
metric |
FrequencyPlacementViewInterval |
FrequencyPlacementViewInterval |
The time interval used to measure how often an ad placement is viewed by a user. |
metric |
GUID |
GUID |
A globally unique identifier used for various entities within the Adform system. |
dimension |
GppPrivacyString |
GppPrivacyString |
A string communicating user privacy preferences according to the Global Privacy Platform (GPP) framework. |
dimension |
IP |
IP |
The Internet Protocol address of the user’s device during an ad interaction. |
dimension |
IPv6 |
IPv6 |
The Internet Protocol Version 6 (IPv6) address of the user’s device. |
dimension |
ImpressionCost |
ImpressionCost |
The cost incurred for an impression of an advertisement. |
metric |
InteractionId |
InteractionId |
A unique identifier for a user interaction with an advertisement. |
metric |
InventorySourceId |
InventorySourceId |
Unique identifier for the platform or entity providing the ad inventory. |
metric |
IsRobot |
IsRobot |
A boolean flag indicating whether the traffic source is identified as a robot or bot. |
dimension |
LineItem |
LineItem |
A specific component within a campaign that defines targeting, bidding, and creative settings. Often referred to as programmatic line items. |
metric |
LogTime |
LogTime |
The timestamp when a specific event or interaction was logged, usually in ISO-8601 format. |
dimension |
MediaId |
MediaId |
Unique identifier for a media asset, such as an image or video creative. |
metric |
MouseOverTime |
MouseOverTime |
The duration a user’s mouse cursor hovered over an ad creative. |
dimension |
MouseOvers |
MouseOvers |
The count of times a user’s mouse cursor hovered over an ad creative. |
dimension |
NaturalSearchKeywords |
NaturalSearchKeywords |
Keywords used by a user in organic search that led to a website visit. |
dimension |
OrderId |
OrderId |
A unique identifier for an order within a campaign. |
metric |
PageURL |
PageURL |
The URL of the webpage where the ad interaction or event occurred. |
dimension |
PlacementId-ActivityId |
PlacementId-ActivityId |
A combined identifier representing a specific ad placement and a related user activity (e.g., click, conversion). |
metric |
PointUniqueCampaignFlag |
PointUniqueCampaignFlag |
A flag indicating a unique tracking point event within a campaign for a specific user. |
metric |
PointUniqueSessionFlag |
PointUniqueSessionFlag |
A flag indicating a unique tracking point event within a session for a specific user. |
metric |
PublisherDomain |
PublisherDomain |
The domain of the publisher’s website where the ad was displayed. |
dimension |
PublisherURL |
PublisherURL |
The URL of the website where the ad was displayed. |
dimension |
ReactionTime |
ReactionTime |
The time taken for a user to react to an advertisement or content. |
metric |
Referrer |
Referrer |
The URL of the webpage that referred the user to the current page. |
dimension |
ReferrerType |
ReferrerType |
The category of the source that directed the user to the current page (e.g., organic search, direct, referral). |
dimension |
RotatorId |
RotatorId |
An identifier for an ad rotator, which cycles through multiple creatives. |
metric |
RtbCost |
RtbCost |
The cost associated with a real-time bidding (RTB) impression or click. |
metric |
RtbDomain |
RtbDomain |
The second-level domain of publisher sites where a banner was displayed during a Real-Time Bidding (RTB) impression. |
dimension |
SiteUniqueCampaignFlag |
SiteUniqueCampaignFlag |
A flag indicating a unique campaign view on a specific site for a user. |
metric |
TP_AttributedTransactionGUID |
TP_AttributedTransactionGUID |
A globally unique identifier for a transaction attributed to a tracking point event. |
dimension |
TP_GUID |
TP_GUID |
A globally unique identifier associated with a specific tracking point event. |
dimension |
TP_TagId |
TP_TagId |
The unique identifier of the tracking tag associated with a tracking point event. |
metric |
TP_Timestamp |
TP_Timestamp |
The timestamp of a tracking point event, usually in ISO-8601 format. |
dimension |
TP_TrackingPointId |
TP_TrackingPointId |
The unique identifier for the tracking point itself. |
metric |
TP_count |
TP_count |
The count of a specific tracking point event. |
metric |
TagId |
TagId |
A unique identifier for an Adform tracking tag implemented on a website. |
metric |
Timestamp |
Timestamp |
The date and time of an event or interaction, usually in ISO-8601 format. |
dimension |
Timestamp-Server |
Timestamp-Server |
The date and time of an event or interaction as recorded by the server, usually in ISO-8601 format. |
dimension |
TrackingPointId |
TrackingPointId |
A unique identifier for a specific tracking point configured on a website. Tracking points are part of transactional data. |
metric |
TransactionId |
TransactionId |
A unique identifier for a financial transaction or conversion. |
metric |
TransactioncostMax |
TransactioncostMax |
The maximum monetary cost recorded for a specific transaction or conversion. |
metric |
UniqueBannerFlag |
UniqueBannerFlag |
A flag indicating a unique banner view for a specific user. |
metric |
UniqueCampaignDayFlag |
UniqueCampaignDayFlag |
A flag indicating a unique campaign view for a specific user within a single day. |
metric |
UniqueCampaignFlag |
UniqueCampaignFlag |
A flag indicating a unique campaign view for a specific user. |
metric |
UniqueMediaFlag |
UniqueMediaFlag |
A flag indicating a unique media view for a specific user. |
metric |
UniqueOrderIdFlag |
UniqueOrderIdFlag |
A flag indicating a unique order ID for a transaction. |
metric |
UniquePlacementDayFlag |
UniquePlacementDayFlag |
A flag indicating a unique placement view for a specific user within a single day. |
metric |
UniquePlacementFlag |
UniquePlacementFlag |
A flag indicating a unique placement view for a specific user. |
metric |
Visibility1Flag |
Visibility1Flag |
A flag indicating whether an ad met a primary visibility criterion. |
metric |
VisibilityPercentage |
VisibilityPercentage |
The percentage of the ad creative that was viewable on screen. |
metric |
VisibilityTime |
VisibilityTime |
The length of time, in seconds, that an ad creative was viewable on screen. |
metric |
VisitNumber |
VisitNumber |
The sequential number of a user’s visit to a website or application. |
metric |
VisitPageNumber |
VisitPageNumber |
The sequential number of a page viewed by a user within a single visit. |
metric |
ZipCodeId |
ZipCodeId |
A unique identifier for a postal code. |
metric |
active |
active |
A boolean flag indicating if an entity (e.g., campaign, line item) is currently active. |
dimension |
activity_grouping |
activity_grouping |
A categorization or grouping of related user activities or tracking points. |
dimension |
attributed |
attributed |
A flag indicating if an event or conversion has been attributed to an ad interaction. |
dimension |
banner |
banner |
Information about the ad creative displayed. |
dimension |
bannerAttribute1 |
bannerAttribute1 |
A user-defined custom attribute field (1) for banners, providing additional descriptive information. |
dimension |
bannerAttribute2 |
bannerAttribute2 |
A user-defined custom attribute field (2) for banners, providing additional descriptive information. |
dimension |
bannerAttribute3 |
bannerAttribute3 |
A user-defined custom attribute field (3) for banners, providing additional descriptive information. |
dimension |
bannerAttribute4 |
bannerAttribute4 |
A user-defined custom attribute field (4) for banners, providing additional descriptive information. |
dimension |
bannerAttribute5 |
bannerAttribute5 |
A user-defined custom attribute field (5) for banners, providing additional descriptive information. |
dimension |
bannerSize |
bannerSize |
The dimensions (width x height) of the creative banner, e.g., ‘300 x 250’. |
dimension |
bannerType |
bannerType |
The type of creative material used for the banner, such as Flash, Image, Rich Media, Link, or Keyword. |
dimension |
bannerWeight |
bannerWeight |
A numerical value determining the likelihood or frequency of a banner being served in rotation. |
dimension |
banner_grouped |
banner_grouped |
Data grouped by banner creative for reporting and analysis. |
dimension |
bidPrice |
bidPrice |
The price bid for an ad impression in a Real-Time Bidding (RTB) auction. |
metric |
brand_code |
brand_code |
A unique alphanumeric code identifying a specific brand. |
dimension |
brand_name |
brand_name |
The human-readable name of a brand. |
dimension |
budget |
budget |
The allocated financial budget for a campaign or line item. |
metric |
budgetGoalType |
budgetGoalType |
Defines the objective or strategy for a campaign’s budget allocation (e.g., maximizing clicks, conversions, or impressions). |
dimension |
budgetPeriodType |
budgetPeriodType |
Specifies the time frame over which a campaign budget is applied (e.g., daily, weekly, lifetime). |
dimension |
campaign |
campaign |
Information about the advertising campaign. This dimension shows and groups information by campaign, which is the base item in the Adform system. |
dimension |
campaignEndDate |
campaignEndDate |
The end date of the advertising campaign. |
dimension |
campaignID |
campaignID |
A unique identifier for an advertising campaign. |
metric |
campaignStartDate |
campaignStartDate |
The start date of the advertising campaign. |
dimension |
campaignStatus |
campaignStatus |
The current operational status of a campaign (e.g., Active, Paused, Ended). |
dimension |
campaignType |
campaignType |
The type of advertising campaign, such as Display, Affiliate, Email, or Social Media. |
dimension |
campaign_name_id |
campaign_name_id |
A unique identifier associated with the name of an advertising campaign. |
dimension |
capping |
capping |
The frequency capping settings applied to an ad or campaign, limiting the number of times a user sees an ad. |
metric |
cappingTypeName |
cappingTypeName |
The strategy used to limit the number of times an ad is shown to a unique user within a specified period. |
dimension |
channelTypeName |
channelTypeName |
The type of advertising channel used for a campaign, such as Display, Affiliate, Email, or Social Media. |
dimension |
channel_code |
channel_code |
A unique code identifying the advertising channel (e.g., display, video, social). |
dimension |
channel_name |
channel_name |
The human-readable name of the advertising channel. |
dimension |
city |
city |
The name of the city associated with an ad interaction or user location. |
dimension |
cityId |
cityId |
A unique identifier for a city. |
metric |
clientId |
clientId |
A unique identifier for the client or advertiser. |
metric |
country |
country |
The name of the country associated with an ad interaction or user location. |
dimension |
countryCodeISO3 |
countryCodeISO3 |
The three-letter ISO 3166-1 alpha-3 code representing the country of the user or related entity. |
dimension |
countryId |
countryId |
A unique numerical identifier for a country. |
metric |
country_code |
country_code |
The ISO 2-letter country code associated with an ad interaction or user location. |
dimension |
currencyCode |
currencyCode |
The ISO currency code used for financial transactions or reporting. |
dimension |
currencyName |
currencyName |
The name of the currency used for financial transactions or reporting. |
dimension |
dealId |
dealId |
A unique identifier for a programmatic deal in which ads are bought or sold. |
dimension |
dealName |
dealName |
The name of the programmatic deal. |
dimension |
deleted |
deleted |
A boolean flag indicating if an entity (e.g., campaign, line item) has been marked as deleted. |
dimension |
endDate |
endDate |
The end date of a campaign, line item, or other time-bound entity, usually in ISO-8601 format. |
dimension |
fiscal_year |
fiscal_year |
The fiscal year to which the data belongs. |
metric |
id |
id |
A generic unique identifier for an entity within the Adform system. |
dimension |
isGlobal |
isGlobal |
A flag indicating if an entity has global scope or applicability. |
dimension |
isLead |
isLead |
A boolean flag indicating whether a conversion event is classified as a lead. |
dimension |
leadCategory |
leadCategory |
The categorization of a generated lead (e.g., qualified, unqualified, MQL, SQL). |
dimension |
leadType |
leadType |
The specific classification or nature of a lead. |
dimension |
lineItem |
lineItem |
Information about the ad line item within a campaign. Programmatic line items are used to define targeting, bidding, and creative settings. |
dimension |
lineItem_grouped |
lineItem_grouped |
Data grouped by ad line item for reporting and analysis. |
dimension |
media |
media |
The media or publisher providing the online advertising space, such as an online newspaper or social network site. |
dimension |
month |
month |
The month number (1-12) when an event or transaction occurred. |
dimension |
name |
name |
The name of an entity (e.g., campaign name, banner name, line item name). |
dimension |
new_timestamp |
new_timestamp |
The precise date and time when an event or action occurred. |
dimension |
page |
page |
The page number within a paginated list of results or a website. |
dimension |
partyid |
partyid |
A unique identifier for a party involved in the advertising ecosystem, such as an advertiser or publisher. |
metric |
paused |
paused |
A boolean flag indicating if an entity (e.g., campaign, line item) is currently paused. |
dimension |
product_code |
product_code |
A unique alphanumeric code identifying a specific product. |
dimension |
product_name |
product_name |
The human-readable name of a product. |
dimension |
region |
region |
The geographical region or state within a country associated with an ad interaction or user location. |
dimension |
regionCode |
regionCode |
The code representing a geographical region or state. |
dimension |
regionId |
regionId |
A unique numerical identifier for a geographical region or state. |
metric |
section |
section |
A logical section within a website or application. |
dimension |
segment_code |
segment_code |
A unique code identifying an audience segment used for targeting. |
dimension |
segment_name |
segment_name |
The human-readable name of an audience segment. |
dimension |
startDate |
startDate |
The start date of a campaign, line item, or other time-bound entity, usually in ISO-8601 format. |
dimension |
std_taxonomy_flag |
std_taxonomy_flag |
A flag indicating adherence to a standard taxonomy for data classification. |
metric |
sysvar_sales |
sysvar_sales |
A system-defined variable used to capture sales revenue data from tracking points. |
metric |
sysvar_sv1 |
sysvar_sv1 |
A generic system variable (1) that can be customized for various tracking or reporting purposes. |
dimension |
sysvar_sv10 |
sysvar_sv10 |
A generic system variable (10) that can be customized for various tracking or reporting purposes. |
dimension |
sysvar_sv11 |
sysvar_sv11 |
A generic system variable (11) that can be customized for various tracking or reporting purposes. |
dimension |
sysvar_sv12 |
sysvar_sv12 |
A generic system variable (12) that can be customized for various tracking or reporting purposes. |
dimension |
sysvar_sv2 |
sysvar_sv2 |
A generic system variable (2) that can be customized for various tracking or reporting purposes. |
dimension |
sysvar_sv3 |
sysvar_sv3 |
A generic system variable (3) that can be customized for various tracking or reporting purposes. |
dimension |
sysvar_sv4 |
sysvar_sv4 |
A generic system variable (4) that can be customized for various tracking or reporting purposes. |
dimension |
sysvar_sv5 |
sysvar_sv5 |
A generic system variable (5) that can be customized for various tracking or reporting purposes. |
dimension |
sysvar_sv6 |
sysvar_sv6 |
A generic system variable (6) that can be customized for various tracking or reporting purposes. |
dimension |
sysvar_sv7 |
sysvar_sv7 |
A generic system variable (7) that can be customized for various tracking or reporting purposes. |
dimension |
sysvar_sv8 |
sysvar_sv8 |
A generic system variable (8) that can be customized for various tracking or reporting purposes. |
dimension |
sysvar_sv9 |
sysvar_sv9 |
A generic system variable (9) that can be customized for various tracking or reporting purposes. |
dimension |
timeZone |
timeZone |
The time zone relevant to the data, often in ISO-8601 format for dates. |
dimension |
type |
type |
The classification or category of an entity, such as banner type or campaign type. |
dimension |
videoDuration |
videoDuration |
The total playback duration of a video creative. |
metric |
visibilityArea |
visibilityArea |
The measurable area of the ad creative that was displayed on screen. |
metric |
visibilityArea2 |
visibilityArea2 |
A second measured area of an ad creative that was visible on the user’s screen, possibly for custom viewability settings. |
metric |
visibilityArea3 |
visibilityArea3 |
A third measured area of an ad creative that was visible on the user’s screen, possibly for custom viewability settings. |
dimension |
visibilityTime |
visibilityTime |
The length of time, in seconds, that an ad creative was viewable on screen. |
metric |
visibilityTime2 |
visibilityTime2 |
A second measure of the duration for which an ad was visible on the user’s screen. |
metric |
visibilityTime3 |
visibilityTime3 |
A third measure of the duration for which an ad was visible on the user’s screen. |
dimension |
website |
website |
The domain name of the website where an event occurred or an ad was displayed. |
dimension |
websiteSection |
websiteSection |
A specific section or category within a website. |
dimension |
websiteSubSection |
websiteSubSection |
A more granular subsection within a broader website section. |
dimension |
yyyymmdd |
yyyymmdd |
The date in YYYYMMDD format, used for time-based data grouping. |
metric |
zipCode |
zipCode |
The postal code associated with the user’s geographical location. |
dimension |
zipCodeId |
zipCodeId |
A unique identifier for a postal code. |
metric |