impact.com: Most-used fields

impact.com: Most-used fields#

The table below gives information about most-used fields that you can import from impact.com. 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

AOV

AOV

Average Order Value: The average monetary value of each order placed.

dimension

ATId

ATId

The unique identifier for an Action Tracker, which is a tracking method applied to a defined action.

metric

AT_Id

AT_Id

A unique identifier for an Action Tracker.

dimension

AVGImpressionDuration

AVGImpressionDuration

dimension

ActionCost

ActionCost

The cost associated with a specific action.

metric

ActionDate

ActionDate

The date on which a specific user action (e.g., conversion, click) was recorded.

dimension

ActionTracker

ActionTracker

The tracking method that is applied to a defined action.

dimension

Action_Cost

Action_Cost

The cost associated with a specific action.

metric

Action_Date

Action_Date

The date when the action occurred.

dimension

Action_Id

Action_Id

A unique identifier for a specific action.

dimension

Action_Tracker

Action_Tracker

The name or identifier of the action tracker used for recording an event.

dimension

Actionid

Actionid

A unique identifier for an action or conversion event.

dimension

Actions

Actions

The total number of tracked customer actions, such as conversions, leads, or sales.

metric

ActionsConfirmed

ActionsConfirmed

The number of actions that have been confirmed.

dimension

ActionsCost

ActionsCost

The total cost associated with all tracked actions.

metric

ActionsOpen

ActionsOpen

The number of actions that are currently open or pending confirmation.

dimension

Actiontrackerid

Actiontrackerid

A unique identifier for an action tracker.

metric

Actiontrackername

Actiontrackername

The name or identifier of the action tracker used for recording an event.

dimension

Activity

Activity

A general term for an action or event tracked within the Impact.com platform, such as a click, conversion, or engagement.

dimension

Ad

Ad

The name or identifier of the advertisement creative.

dimension

AdCampaign

AdCampaign

The name or identifier of the advertising campaign.

dimension

AdPlacement

AdPlacement

The specific placement where an advertisement was displayed.

dimension

AdType

AdType

The type or format of the advertisement (e.g., banner, text, video).

dimension

Adid

Adid

The unique identifier for the ad that generated the click or action.

metric

Adj_Date

Adj_Date

dimension

Advertiser

Advertiser

The name of the advertiser or program associated with the data.

dimension

Advertiserid

Advertiserid

A unique identifier for an advertiser.

metric

Advertising Platform

Advertising Platform

The specific advertising platform (e.g., social media platform) from which data is collected.

dimension

Amount

Amount

The amount of revenue generated by an action.

metric

AttributedConversions

AttributedConversions

The number of conversions accurately credited to a specific partner or campaign.

metric

AttributedRevenue

AttributedRevenue

The revenue accurately credited to a specific partner or campaign.

metric

BatchDate

BatchDate

The date an action batch was processed.

dimension

BatchId

BatchId

The unique identifier of an API submission batch.

dimension

BatchType

BatchType

The type of batch process an API submission belongs to.

dimension

Bonus_Cost

Bonus_Cost

The cost attributed to bonus payments or incentives.

metric

Business

Business

dimension

CPA

CPA

Cost Per Action (or Cost Per Acquisition), a metric representing the average cost incurred to achieve a desired action or conversion.

dimension

CPC

CPC

Cost Per Click: The average cost incurred for each click.

metric

CPCCost

CPCCost

The total cost incurred from clicks.

metric

CPC_Cost

CPC_Cost

The total cost incurred from clicks.

metric

CR

CR

Conversion Rate, the percentage of users who complete a desired action out of the total number of visitors or interactions.

dimension

CTR

CTR

Click-Through Rate, the ratio of users who click on a specific link to the number of total users who view a page, email, or advertisement.

dimension

CallCost

CallCost

The cost associated with a phone call action.

dimension

CallRevenue

CallRevenue

The revenue generated from phone call actions.

dimension

Call_CR

Call_CR

Call Conversion Rate: The percentage of calls that result in a conversion.

metric

Call_Cost

Call_Cost

The cost associated with a phone call action.

dimension

Call_EPA

Call_EPA

Earnings Per Action for phone calls: The average earnings for each call action.

dimension

Call_EPC

Call_EPC

Earnings Per Click for phone calls: The average earnings for each click leading to a call.

metric

Call_RR

Call_RR

Call Reversal Rate: The percentage of calls that were reversed or invalidated.

dimension

Call_Revenue

Call_Revenue

The revenue generated from phone call actions.

dimension

Call_Sale_Amount

Call_Sale_Amount

The total sales amount attributed to phone call actions.

metric

Callerid

Callerid

A unique identifier for the caller in a phone call action.

dimension

Calls

Calls

The total number of phone calls tracked.

metric

Campaign

Campaign

The name or identifier of a marketing campaign.

dimension

Campaign_Name

Campaign_Name

The name of a marketing campaign.

dimension

Campaignid

Campaignid

A unique identifier for a marketing campaign.

metric

Campaignname

Campaignname

The name or title of a marketing campaign.

dimension

CartCurrency

CartCurrency

The currency of the shopping cart for an action.

dimension

CatalogCategory

CatalogCategory

The primary category from the product catalog associated with an item.

dimension

CatalogSubcategory

CatalogSubcategory

The secondary categorization for a product from the catalog.

dimension

Category

Category

A classification or group for products, deals, or actions.

dimension

CategoryList

CategoryList

A list of categories associated with an item or action.

dimension

Category_List

Category_List

A list of categories associated with an item or action.

dimension

Cell

Cell

metric

Changeinamount

Changeinamount

The change in the monetary amount of a transaction or record, often due to an update or adjustment.

metric

Changeinpayout

Changeinpayout

The change in the payout amount, often due to an update or adjustment.

metric

Channel

Channel

The marketing channel that drove the action.

dimension

City

City

The city in which the customer resides.

dimension

Cleareddate

Cleareddate

The actual payout clearing date for an action, or the date when the payout scheduling was changed.

dimension

ClickCost

ClickCost

The cost incurred for a single click.

metric

Click_Action_Cost

Click_Action_Cost

The calculated cost paid for a single click, based on the rules established in the template terms for a partner. This represents the aggregated value due to partners for driving clicks.

metric

Click_Date

Click_Date

The time and date that the click was registered.

dimension

Clicks

Clicks

The total number of clicks recorded on ads or tracking links.

metric

ClientCost

ClientCost

The total cost for the client (advertiser) for all tracked activities.

metric

Client_Cost

Client_Cost

metric

Company_URL

Company_URL

The URL of the partner’s company, if available.

dimension

ConversionCity

ConversionCity

The city where the conversion event occurred.

dimension

ConversionCountry

ConversionCountry

The country where the conversion event occurred.

dimension

ConversionDate

ConversionDate

The date when a conversion event was recorded.

dimension

ConversionPosition

ConversionPosition

The position of the conversion in the customer journey or attribution model.

metric

ConversionRegion

ConversionRegion

The geographic region where the conversion event occurred.

dimension

Conversion_Country

Conversion_Country

The country where a conversion event occurred.

dimension

ConvertedCalls

ConvertedCalls

The number of phone calls that resulted in a conversion.

dimension

Converted_Calls

Converted_Calls

The number of phone calls that resulted in a conversion.

dimension

Cost

Cost

The overall monetary cost associated with a specific record or activity.

metric

Country

Country

The country where the action or customer originated.

dimension

CpcPayable

CpcPayable

The Cost Per Click amount that is payable.

metric

Creationdate

Creationdate

The date when a record or entity was created.

dimension

Creative_URL

Creative_URL

The URL of the creative asset used in an advertisement.

dimension

CurrentAccountBalance

CurrentAccountBalance

The current financial balance of an account within the Impact.com platform, often available in reports like ‘Account Balance History’.

metric

Customer_Id

Customer_Id

A unique identifier for a customer.

dimension

Customer_Status

Customer_Status

The customer’s Customer Status Mapping code for the action.

dimension

Customerarea

Customerarea

The geographical area of the customer.

dimension

Customercity

Customercity

The city of the customer.

dimension

Customercountry

Customercountry

The country of the customer.

dimension

Customerid

Customerid

A unique identifier for a customer or user.

metric

Customerpostcode

Customerpostcode

The postal code of the customer.

dimension

Customerregion

Customerregion

The region (or state) in which the customer resides.

dimension

Customerstatus

Customerstatus

The customer’s Customer Status Mapping code for the action.

dimension

Date

Date

The specific date associated with the data record.

dimension

Description

Description

A general description of an item, report, or entity.

dimension

Device

Device

The type of device (e.g., desktop, mobile) used for an interaction.

dimension

DeviceType

DeviceType

The type of device (e.g., desktop, mobile, tablet) used during the conversion.

dimension

Discount

Discount

The total discount amount applied to transactions.

dimension

DiscountRate

DiscountRate

The rate or percentage of discount applied.

dimension

Discount_Rate

Discount_Rate

The rate or percentage of discount applied.

dimension

DownloadCost

DownloadCost

The cost associated with a download action.

dimension

Download_Cost

Download_Cost

The cost associated with a download action.

dimension

Downloads

Downloads

The number of download events tracked as actions within the system. Downloads are a type of event that is tracked.

dimension

EPA

EPA

Earnings Per Action, a metric representing the average earnings generated for each tracked action.

dimension

EPC

EPC

Earnings Per Click, a metric representing the average earnings generated for each click.

metric

Earnings

Earnings

The total amount of money earned from activities.

metric

Email

Email

The email address associated with a contact or customer.

dimension

EventCity

EventCity

The city where an event took place.

dimension

EventCountry

EventCountry

The country where an event took place.

dimension

EventId

EventId

A unique identifier for a specific tracked event.

dimension

EventRegion

EventRegion

The region or state where an event took place.

dimension

EventType

EventType

The type of event being tracked (e.g., click, install, purchase).

dimension

Eventdate

Eventdate

The date on which a specific event, such as a conversion or action, occurred. This is used as an incremental key in reports like ‘Actions - Media Partners’.

dimension

FileSubmissionId

FileSubmissionId

The ID of a batch event or file submission through which an action was entered into impact.com.

dimension

Forwardbalance

Forwardbalance

metric

GeoLocation

GeoLocation

The geographic location, which can include the region, state, country, or city, where the customer resides or the event occurred.

dimension

Geo_Location

Geo_Location

The geographic location, which can include the region, state, country, or city, where the customer resides or the event occurred.

dimension

GoodsCost

GoodsCost

The total cost of products in the shopping basket captured at the time of conversion.

dimension

Goods_Cost

Goods_Cost

dimension

Grossactioncost

Grossactioncost

The total cost of actions before any deductions or adjustments.

dimension

Grossactions

Grossactions

The total number of actions before any reversals or invalidations.

dimension

Grossrevenue

Grossrevenue

The total revenue before any deductions or adjustments.

dimension

IO

IO

Refers to an Insertion Order, which is a unique identifier for a contract.

dimension

IO_ID

IO_ID

The unique identifier of the Insertion Order, which is the Contract ID.

dimension

Id

Id

A generic unique identifier for a record or entity.

dimension

ImportedClicks

ImportedClicks

Click data that has been imported from an external source.

dimension

ImportedCost

ImportedCost

The Cost of Actions imported from third-party tracking systems.

dimension

ImportedImpressions

ImportedImpressions

Impression data that has been imported from an external source.

dimension

Impressions

Impressions

The total number of times an ad or content was displayed.

metric

Imps

Imps

Short for Impressions: The total number of times an ad or content was displayed.

metric

InstallCost

InstallCost

The cost associated with an application install action.

dimension

Installs

Installs

The total number of application installations tracked.

dimension

Intendedpayout

Intendedpayout

The calculated payout amount expected for a partner based on an action or conversion.

metric

Ipaddr

Ipaddr

The IP address associated with a user interaction.

dimension

Ipaddress

Ipaddress

The IP address recorded for a user interaction or event.

dimension

Items

Items

A list or count of items within an order or product catalog.

dimension

Keyword

Keyword

The keyword associated with an ad click or search that led to an action.

dimension

Labels

Labels

Categorization tags or labels applied to products, content, or campaigns for organizational purposes.

dimension

LandingPageUrl

LandingPageUrl

The URL of the landing page where a user arrived after clicking an ad or link.

dimension

Language

Language

The language associated with a customer or campaign.

dimension

LeadCPA

LeadCPA

Cost Per Lead: The average cost incurred for each generated lead.

dimension

LeadCR

LeadCR

Lead Conversion Rate: The percentage of clicks or actions that result in a lead.

dimension

LeadCost

LeadCost

The total cost associated with generated leads.

dimension

LeadRR

LeadRR

Lead Reversal Rate: The percentage of leads that were reversed or invalidated.

dimension

Lead_CPA

Lead_CPA

Cost Per Lead: The average cost incurred for each generated lead.

dimension

Lead_CR

Lead_CR

Lead Conversion Rate: The percentage of clicks or actions that result in a lead.

dimension

Lead_Cost

Lead_Cost

The total cost associated with generated leads.

dimension

Lead_EPA

Lead_EPA

Earnings Per Action for leads: The average earnings for each lead action.

dimension

Lead_EPC

Lead_EPC

Earnings Per Click for leads: The average earnings for each click leading to a lead.

metric

Lead_RR

Lead_RR

Lead Reversal Rate: The percentage of leads that were reversed or invalidated.

metric

Lead_Sale_Amount

Lead_Sale_Amount

The total sales amount attributed to leads.

metric

Leads

Leads

The total number of leads generated.

dimension

Lockedstatus

Lockedstatus

Indicates whether an action is locked, meaning it can no longer be modified or reversed after its locking date.

dimension

Lockingdate

Lockingdate

The date after which an action can no longer be modified or reversed.

dimension

MPId

MPId

A unique identifier for a media partner.

metric

Manufacturer

Manufacturer

The company that produced the product.

dimension

Margin

Margin

The profit margin associated with a conversion event.

dimension

MatchType

MatchType

The match type of a keyword in advertising (e.g., exact, phrase, broad).

dimension

Media

Media

Refers to the advertising content, creative, or placement used in a campaign.

dimension

MediaPartner

MediaPartner

The name or identifier of the media partner.

dimension

Mediapartnerid

Mediapartnerid

A unique identifier for a media partner.

metric

Mediatype

Mediatype

The type of media or partner web property associated with a click or action.

dimension

MobileInstallRevenue

MobileInstallRevenue

The revenue generated from mobile application installations.

dimension

Mobile_Install_CR

Mobile_Install_CR

Mobile Install Conversion Rate: The percentage of clicks or actions that result in a mobile app install.

metric

Mobile_Install_Cost

Mobile_Install_Cost

The cost associated with mobile application installations.

dimension

Mobile_Install_EPA

Mobile_Install_EPA

Earnings Per Action for mobile installs: The average earnings for each mobile install action.

dimension

Mobile_Install_EPC

Mobile_Install_EPC

Earnings Per Click for mobile installs: The average earnings for each click leading to a mobile app install.

metric

Mobile_Install_RR

Mobile_Install_RR

Mobile Install Reversal Rate: The percentage of mobile app installs that were reversed or invalidated.

dimension

Mobile_Install_Revenue

Mobile_Install_Revenue

The revenue generated from mobile application installations.

dimension

Mobile_Installs

Mobile_Installs

The total number of mobile application installations.

dimension

Mobile_Installs_Sale_Amount

Mobile_Installs_Sale_Amount

The total sales amount attributed to mobile application installations.

metric

ModificationReason

ModificationReason

The reason for a modification to an action or record.

dimension

Modificationdate

Modificationdate

The date when an action or record was modified.

dimension

Month

Month

The month in which an event or action occurred.

dimension

Mp

Mp

An abbreviation or identifier for a media partner.

dimension

Mps

Mps

Refers to Media Partners involved in a campaign or action.

dimension

Network

Network

The network from which the data originated.

metric

Notes

Notes

Any additional notes added to an action or record.

dimension

OID

OID

A unique Order ID for the action.

metric

OS

OS

The operating system of the device on which the click was performed.

dimension

Opens

Opens

The number of times an email or application was opened.

dimension

Orders

Orders

The number of orders placed or associated with an action.

metric

OriginalCurrency

OriginalCurrency

The original currency in which a transaction or payout was recorded.

dimension

OriginalRevenue

OriginalRevenue

The revenue generated by a conversion before any adjustments or currency conversions.

dimension

Original_Currency

Original_Currency

The original currency of a transaction or payout.

dimension

OtherCost

OtherCost

Additional costs associated with performance bonuses, make-good payments, and placement fees.

metric

OtherMobileActions

OtherMobileActions

The number of other mobile-specific actions tracked, apart from installs.

dimension

OtherMobileCost

OtherMobileCost

The cost associated with other mobile-specific actions.

dimension

OtherMobileRevenue

OtherMobileRevenue

The revenue generated from other mobile-specific actions.

dimension

Other_Actions

Other_Actions

A category for tracked actions that do not fall into predefined or primary action types.

dimension

Other_Cost

Other_Cost

Additional costs not categorized under specific action or click costs. This is similar to ‘Other Cost’ defined as additional costs associated with performance bonuses, make-good payments, and placement fees.

metric

Other_Mobile_Actions

Other_Mobile_Actions

The number of other mobile-specific actions tracked, apart from installs.

dimension

Other_Mobile_CR

Other_Mobile_CR

Other Mobile Conversion Rate: The conversion rate for other mobile-specific actions.

metric

Other_Mobile_Cost

Other_Mobile_Cost

The cost associated with other mobile-specific actions.

dimension

Other_Mobile_EPA

Other_Mobile_EPA

Earnings Per Action for other mobile actions: The average earnings for each other mobile action.

metric

Other_Mobile_EPC

Other_Mobile_EPC

Earnings Per Click for other mobile actions: The average earnings for each click leading to other mobile actions.

metric

Other_Mobile_RR

Other_Mobile_RR

Other Mobile Reversal Rate: The percentage of other mobile-specific actions that were reversed or invalidated.

metric

Other_Mobile_Revenue

Other_Mobile_Revenue

The revenue generated from other mobile-specific actions.

dimension

Other_Mobile_Sale_Amount

Other_Mobile_Sale_Amount

The total sales amount attributed to other mobile-specific actions.

metric

Partner

Partner

The name or identifier of the partner involved in an event or transaction.

dimension

PastDuePayout

PastDuePayout

dimension

Payout

Payout

The amount paid out to a partner for a conversion or action.

metric

PerfAOV

PerfAOV

The average order value (AOV) calculated based on performance data. This is derived from ‘Average Order Value (AOV)’ which is the total revenue of sale actions divided by the number of sale actions.

dimension

PerfActions

PerfActions

The number of performance-related actions.

metric

PerfCPA

PerfCPA

The Cost Per Action (CPA) calculated based on performance data. This is derived from ‘Cost per Action (CPA)’ which is the Total Cost of Actions divided by the number of actions.

dimension

PerfCR

PerfCR

The percentage rate determined by the revenue total and action costs, often representing a performance conversion rate.

dimension

PerfROAS

PerfROAS

The Return on Ad Spend (ROAS) calculated based on performance data. This is derived from ‘Return on Ad Spend (ROAS)’ which represents Revenue divided by Total Cost.

metric

PerfROI

PerfROI

The Return on Investment for performance, calculated as revenue divided by total business cost.

dimension

PerfRevenue

PerfRevenue

The revenue generated as a result of performance, representing the total sales partners have driven from conversions for a product.

metric

Platform

Platform

The social platform or advertising platform associated with the data.

dimension

Position

Position

The general position of an ad or content, or its ranking on search engine results pages.

metric

PositionType

PositionType

The type of position for an ad or content.

dimension

PostalCode

PostalCode

The postcode in which the customer generated the action.

dimension

Postcode

Postcode

The postcode in which the customer generated the action.

dimension

Product

Product

The name or identifier of the product involved in a transaction.

dimension

ProductCategory

ProductCategory

The category to which a product belongs.

dimension

Product_CartAmount

Product_CartAmount

The total monetary amount of products in a shopping cart.

metric

Promo_Code

Promo_Code

A specific code used for promotional offers or tracking.

dimension

Promocode

Promocode

A specific code used for promotional offers, discounts, or tracking referrals.

dimension

Promotional_Method

Promotional_Method

The method used for promotion (e.g., social media, email).

dimension

Propertyid

Propertyid

A unique identifier for a media property.

dimension

Quantity

Quantity

The amount of product sold as a result of partner-driven actions.

dimension

ROAS

ROAS

Return On Ad Spend, a metric used to evaluate the effectiveness of an advertising campaign by dividing the revenue generated by the cost of the advertising.

dimension

ROI

ROI

Return on Investment: A metric indicating the profitability of an investment.

dimension

RR

RR

Reversal Rate: The percentage of actions or transactions that were reversed or invalidated.

dimension

Rate

Rate

The percentage rate determined by the total revenue and action costs.

metric

RawClicks

RawClicks

The unfiltered, raw count of clicks before any deduplication or fraud detection.

dimension

RawImpressions

RawImpressions

The total number of raw or unfiltered ad impressions.

dimension

Raw_Clicks

Raw_Clicks

dimension

Raw_Impressions

Raw_Impressions

The total number of raw or unfiltered ad impressions.

dimension

Rebate

Rebate

The rebate amount associated with a transaction.

dimension

Records

Records

The total number of individual data entries or rows returned in a report.

metric

RefUrl

RefUrl

The referring URL from which a consumer originated.

dimension

Referral_Date

Referral_Date

The date when the customer was initially referred to generate the action.

dimension

Referral_Type

Referral_Type

The type of referral that led to an action or conversion.

dimension

ReferringDate

ReferringDate

The date on which the customer was initially referred to generate the action.

dimension

ReferringURL

ReferringURL

The full URL of the page that referred the user to the current page.

dimension

Referring_URL

Referring_URL

The URL of the webpage that directed the user to the current page or action.

dimension

Referringdomain

Referringdomain

The domain from which the referral originated.

dimension

Referringtype

Referringtype

The type of referral, indicating how the customer was referred.

dimension

Region

Region

The geographical region where the action or customer originated.

dimension

Revenue

Revenue

The total monetary value generated from sales or actions.

metric

ReversedActionCost

ReversedActionCost

The cost associated with actions that have been reversed or invalidated.

dimension

ReversedActions

ReversedActions

The number of actions that have been reversed or invalidated.

dimension

ReversedLeadCost

ReversedLeadCost

The cost associated with leads that have been reversed or invalidated.

dimension

ReversedLeads

ReversedLeads

The number of leads that have been reversed or invalidated.

dimension

ReversedRevenue

ReversedRevenue

The revenue from transactions or actions that have been reversed or invalidated.

dimension

ReversedSaleCost

ReversedSaleCost

The cost associated with sales that have been reversed or invalidated.

dimension

ReversedSales

ReversedSales

The number of sales that have been reversed or invalidated.

dimension

Reversed_Call_Earnings

Reversed_Call_Earnings

Earnings from call actions that have been reversed or invalidated.

metric

Reversed_Call_Sale_Amount

Reversed_Call_Sale_Amount

The sales amount from call actions that have been reversed or invalidated.

metric

Reversed_Calls

Reversed_Calls

The number of call actions that have been reversed or invalidated.

metric

Reversed_Lead_Payout

Reversed_Lead_Payout

The payout amount for leads that have been reversed or invalidated.

dimension

Reversed_Lead_Sale_Amount

Reversed_Lead_Sale_Amount

The sales amount from lead actions that have been reversed or invalidated.

metric

Reversed_Leads

Reversed_Leads

The number of leads that have been reversed or invalidated.

dimension

Reversed_Mobile_Install_Earnings

Reversed_Mobile_Install_Earnings

Earnings from mobile install actions that have been reversed or invalidated.

metric

Reversed_Mobile_Install_Sale_Amount

Reversed_Mobile_Install_Sale_Amount

The sales amount from mobile install actions that have been reversed or invalidated.

metric

Reversed_Mobile_Installs

Reversed_Mobile_Installs

The number of mobile install actions that have been reversed or invalidated.

metric

Reversed_Other_Mobile_Actions

Reversed_Other_Mobile_Actions

The number of other mobile actions that have been reversed or invalidated.

metric

Reversed_Other_Mobile_Earnings

Reversed_Other_Mobile_Earnings

Earnings from other mobile actions that have been reversed or invalidated.

metric

Reversed_Other_Mobile_Sale_Amount

Reversed_Other_Mobile_Sale_Amount

The sales amount from other mobile actions that have been reversed or invalidated.

metric

Reversed_Revenue

Reversed_Revenue

The revenue from transactions or actions that have been reversed or invalidated.

dimension

Reversed_Sale_Payout

Reversed_Sale_Payout

The payout amount for sales that have been reversed or invalidated.

dimension

Reversed_Sales

Reversed_Sales

The number of sales that have been reversed or invalidated.

dimension

RulesROI

RulesROI

The Return on Investment (ROI) determined by specific program rules. This is derived from ‘Return on Investment (ROI)’ which represents Revenue divided by Total Business Cost.

dimension

SKU

SKU

The Stock Keeping Unit for an item.

dimension

SKUs

SKUs

Stock Keeping Units: Identifiers for individual products.

dimension

SaleAmount

SaleAmount

The total monetary amount of a sale.

metric

SaleCPA

SaleCPA

Cost Per Sale: The average cost incurred for each completed sale.

dimension

SaleCR

SaleCR

Sale Conversion Rate: The percentage of clicks or actions that result in a sale.

dimension

SaleCost

SaleCost

The total cost associated with sales.

dimension

SaleRR

SaleRR

Sale Reversal Rate: The percentage of sales that were reversed or invalidated.

dimension

SaleRevenue

SaleRevenue

The total revenue generated from sales.

dimension

Sale_Amount

Sale_Amount

The total monetary amount of a sale.

metric

Sale_CPA

Sale_CPA

Cost Per Sale: The average cost incurred for each completed sale.

dimension

Sale_CR

Sale_CR

Sale Conversion Rate: The percentage of clicks or actions that result in a sale.

dimension

Sale_Cost

Sale_Cost

The total cost associated with sales.

dimension

Sale_EPA

Sale_EPA

Earnings Per Action for sales: The average earnings for each sale action.

dimension

Sale_EPC

Sale_EPC

Earnings Per Click for sales: The average earnings for each click leading to a sale.

metric

Sale_RR

Sale_RR

Sale Reversal Rate: The percentage of sales that were reversed or invalidated.

metric

Sale_Revenue

Sale_Revenue

The total revenue generated from sales.

dimension

Sales

Sales

The total number of sales completed.

dimension

Sales_Sales_Amount

Sales_Sales_Amount

The total monetary amount of all sales.

metric

Sends

Sends

dimension

SharedId

SharedId

The Shared ID, if used for this action.

dimension

Shared_Id

Shared_Id

The Shared ID, if used for this action.

dimension

State

State

The geographical state or province where the action or customer originated.

dimension

Status

Status

The current status of an action, campaign, or entity (e.g., pending, approved, reversed).

dimension

StatusDetail

StatusDetail

Detailed information about the status of an action or submission.

dimension

SubId1

SubId1

The first sub-identifier used for granular tracking by partners.

dimension

SubId2

SubId2

The second sub-identifier used for granular tracking by partners.

dimension

SubId3

SubId3

The third sub-identifier used for granular tracking by partners.

dimension

Sub_Channel

Sub_Channel

A more granular classification within a primary marketing channel.

dimension

Subcategory

Subcategory

The subcategory to which a product or item belongs.

dimension

SubmitDate

SubmitDate

The date when an API submission was submitted.

dimension

Tax

Tax

Tax incurred indirectly on goods and services.

dimension

TemplateTermName

TemplateTermName

The name of the template term applied to a contract or deal, which outlines specific conditions and payouts.

dimension

Time

Time

The specific time an action or event occurred.

dimension

TimesImpressionsViewed

TimesImpressionsViewed

The total count of how many times ads were displayed to users. This relates to ‘Impressions’ (the number of audience members that viewed content) and ‘Raw Impressions’ (the total number of times the ad was displayed on a user’s screen).

dimension

TotalBusinessCost

TotalBusinessCost

The sum of the total cost of goods and other total costs associated with the business.

dimension

TotalClicks

TotalClicks

The grand total number of clicks recorded.

dimension

TotalCost

TotalCost

The overall total cost across all tracked activities.

metric

TotalPendingPayout

TotalPendingPayout

metric

Total_Business_Cost

Total_Business_Cost

dimension

Total_Cost

Total_Cost

The overall total cost across all tracked activities.

metric

Txn_Type

Txn_Type

The type of financial transaction (e.g., sale, refund, commission) posted to an account.

dimension

Type

Type

The type or category of an action or event, such as a sale or lead.

dimension

Url

Url

The URL a consumer came from.

dimension

User_Agent

User_Agent

The user agent string from the client’s browser or device, providing information about the operating system and browser.

dimension

VAT

VAT

Value Added Tax incurred indirectly on goods and services.

metric

Version

Version

The version identifier of the API or report schema used.

dimension

ViewableImpressions

ViewableImpressions

The number of ad impressions that were actually viewable by users according to industry standards.

metric

Year

Year

The year in which an event or action occurred.

metric

account_id

account_id

A unique identifier for an account within the Impact platform.

dimension

account_name

account_name

The name of the account (advertiser or media partner).

dimension

action_batch_date

action_batch_date

The date when a batch of actions was processed or recorded.

dimension

activation_date

activation_date

The date when a campaign, deal, or account was activated.

dimension

actual_clearing_date

actual_clearing_date

The actual date on which a payment or action was cleared.

dimension

ad_campaign

ad_campaign

The name or identifier of the advertisement campaign.

dimension

ad_campaign_group

ad_campaign_group

A grouping of related advertising campaigns for organizational and reporting purposes.

dimension

ad_description

ad_description

A textual description of the advertisement.

dimension

ad_end_date

ad_end_date

The end date of an advertisement or campaign.

dimension

ad_group

ad_group

The name or identifier of the ad group within a campaign.

dimension

ad_id

ad_id

A unique identifier for an advertisement.

dimension

ad_name

ad_name

The name or title of an advertisement.

dimension

ad_start_date

ad_start_date

The start date of an advertisement or campaign.

dimension

ad_target_publisher

ad_target_publisher

The specific publisher or media partner targeted by an advertisement.

dimension

ad_target_publisher_group

ad_target_publisher_group

A group or category of publishers targeted by an advertisement.

dimension

ad_target_publisher_group_ids

ad_target_publisher_group_ids

Identifiers for groups of publishers targeted by the advertisement.

dimension

ad_target_publisher_ids

ad_target_publisher_ids

Identifiers for specific publishers targeted by the advertisement.

dimension

ad_type

ad_type

The category or format of the advertisement (e.g., banner, text, video).

dimension

adgroup_id

adgroup_id

A unique identifier for an ad group within an advertising campaign.

dimension

adv_cust_city

adv_cust_city

The city of the customer that generated the action.

dimension

adv_cust_country

adv_cust_country

The country of the customer that generated the action.

dimension

adv_cust_region

adv_cust_region

The geographical region of the customer that generated the action.

dimension

adv_cust_status

adv_cust_status

The status of the customer who generated an action.

dimension

allow_deeplinking

allow_deeplinking

Indicates whether deep linking is enabled for the advertisement, allowing direct links to specific content within an app.

dimension

banner_size

banner_size

The dimensions (width x height) of a banner advertisement.

dimension

batch_id

batch_id

A unique identifier for a batch of records or actions.

dimension

begin_balance

begin_balance

The starting financial balance of an account for a specified period, often found in financial reports like ‘Account Balance History’.

metric

business_model

business_model

The business model associated with a partner or advertiser.

dimension

campaign_id

campaign_id

A unique identifier for an advertising or partnership campaign.

dimension

campaign_status

campaign_status

The current operational state of a campaign, such as active, paused, or completed.

dimension

catalog_category

catalog_category

The primary category from the product catalog associated with an item.

dimension

catalog_subcategory

catalog_subcategory

The secondary categorization for a product from the catalog.

dimension

click_cost

click_cost

The cost incurred for a single click.

metric

click_id

click_id

A unique identifier for a click event.

dimension

client_os_name

client_os_name

The operating system of the client’s device on which a click or action was performed.

dimension

company_phone

company_phone

metric

contact_name

contact_name

The full name of a contact person.

dimension

country_name

country_name

The name of the country where the action or customer originated.

dimension

create_date

create_date

The date when an action or record was initially created or tracked.

dimension

currency_exch_rate

currency_exch_rate

The currency exchange rate applied for conversions between different currencies.

dimension

date_

date_

The specific date associated with the data record.

dimension

date_display

date_display

The date formatted for display purposes.

dimension

date_expired

date_expired

The expiration date for an offer, campaign, or contract.

dimension

date_joined

date_joined

The date when a partner or entity joined the platform or a program.

dimension

date_sort

date_sort

The date value used for sorting records.

dimension

deal_category

deal_category

The category to which a deal belongs.

dimension

deal_description

deal_description

A textual description of the deal or offer.

dimension

deal_discount_amount

deal_discount_amount

The fixed monetary discount amount offered in a deal.

dimension

deal_discount_end_percent

deal_discount_end_percent

The ending percentage of a discount range for a deal.

dimension

deal_discount_maximum_percent

deal_discount_maximum_percent

The maximum percentage discount offered in a deal.

dimension

deal_discount_percent

deal_discount_percent

The percentage discount offered in a deal.

dimension

deal_discount_start_percent

deal_discount_start_percent

The starting percentage of a discount range for a deal.

dimension

deal_discount_type

deal_discount_type

The type of discount offered in a deal (e.g., percentage, fixed amount).

dimension

deal_end_date

deal_end_date

The date when the deal or offer expires.

dimension

deal_gift

deal_gift

Description of any gift offered as part of the deal.

dimension

deal_maximum_savings_amount

deal_maximum_savings_amount

The maximum monetary savings a customer can achieve with the deal.

dimension

deal_minimum_purchase_amount

deal_minimum_purchase_amount

The minimum purchase amount required to qualify for the deal.

dimension

deal_name

deal_name

The name or title of the deal or offer.

dimension

deal_product

deal_product

The product or service associated with the deal.

dimension

deal_promocode

deal_promocode

The promotional code associated with the deal.

dimension

deal_rebate

deal_rebate

Description of any rebate offered as part of the deal.

dimension

deal_scope

deal_scope

The applicability or scope of the deal (e.g., sitewide, specific products).

dimension

deal_start_date

deal_start_date

The date when the deal or offer becomes active.

dimension

deal_target_publisher

deal_target_publisher

The specific publisher or media partner involved in a particular deal or partnership agreement.

dimension

deal_target_publisher_group

deal_target_publisher_group

A group or category of publishers involved in a particular deal or partnership agreement.

dimension

deal_target_publisher_group_ids

deal_target_publisher_group_ids

Identifiers for groups of publishers targeted by the deal.

dimension

deal_target_publisher_ids

deal_target_publisher_ids

Identifiers for specific publishers targeted by the deal.

dimension

deal_type

deal_type

The classification or type of deal (e.g., coupon, sale, free shipping).

dimension

delivery_type

delivery_type

dimension

device_type

device_type

The categorization of the device type (e.g., mobile, desktop, tablet).

dimension

end_balance

end_balance

The closing financial balance of an account for a specified period, often found in financial reports like ‘Account Balance History’.

metric

expiration_date

expiration_date

The date when an item or offer expires.

dimension

gross_action_cost

gross_action_cost

The total cost associated with an action before any deductions or adjustments.

dimension

gross_revenue

gross_revenue

The total revenue generated before any deductions or adjustments.

dimension

group_name

group_name

The name of a partner group or campaign group.

dimension

insertion_order

insertion_order

The identifier for an insertion order, a contract between an advertiser and a publisher.

dimension

invoice_date

invoice_date

The date an invoice was issued. The API supports listing and retrieving invoices.

dimension

is_test

is_test

A flag indicating if the data or action is part of a test. The API documentation mentions ‘Partner Test Accounts for Brands’ [2] and ‘Create Test Actions For Partners’ [2].

metric

item_brand

item_brand

dimension

join_date

join_date

The date when a partner or entity joined the platform. This is similar to ‘Date Joined’ which filters data by when it was created.

dimension

landing_page

landing_page

The URL of the webpage where users land after clicking an ad or link.

dimension

landing_page_url

landing_page_url

The URL of the landing page where a user was directed.

dimension

location_id

location_id

The unique identifier of the location from where the customer generated the action.

dimension

location_name

location_name

The name of the location from where the customer generated the action.

dimension

location_type

location_type

The type or kind of location from where the customer generated the action.

dimension

locking_date

locking_date

The date when an action or record was locked for processing.

dimension

media_count

media_count

metric

media_id

media_id

A unique identifier for a piece of media or creative.

dimension

media_partner

media_partner

An entity, such as an influencer or affiliate, that promotes products or services and earns commissions.

dimension

media_partner_id

media_partner_id

A unique identifier for a media partner.

dimension

media_property_id

media_property_id

A unique identifier for a media property, such as a website or app.

dimension

media_property_name_current

media_property_name_current

The name of the partner web property currently associated with the click.

dimension

media_property_name_historic

media_property_name_historic

The name of the previous partner web property associated with the click.

dimension

media_property_type_current

media_property_type_current

The type of partner web property currently associated with the click (e.g., Website, Social).

dimension

media_property_type_historic

media_property_type_historic

The previous type of partner web property associated with the click (e.g., Website, Social).

dimension

mobile_app_landingpages

mobile_app_landingpages

A list of landing page URLs specific to mobile applications.

dimension

mp_id

mp_id

A unique identifier for a Media Partner.

dimension

mp_name

mp_name

The name of the media partner.

dimension

original_currency_sale_amount

original_currency_sale_amount

The sale amount in its original currency before any conversions.

dimension

original_payout

original_payout

The original payout amount earned from driving or participating in an action.

dimension

original_sale_amount

original_sale_amount

The total sale amount before any adjustments or currency conversions.

dimension

partner_group

partner_group

The group(s) in which the partner (publisher) is listed.

dimension

partner_group_id

partner_group_id

A unique identifier for a partner group.

dimension

partner_group_name

partner_group_name

The name of the partner group to which a partner belongs.

dimension

partner_id

partner_id

A unique identifier for a media partner or affiliate.

dimension

payment_type

payment_type

How the customer paid for their order.

dimension

posting_date

posting_date

The date and time when an action was recorded.

dimension

product_category

product_category

The category to which a product belongs.

dimension

promotional_area

promotional_area

dimension

property_name

property_name

The name of a media property.

dimension

property_type

property_type

The classification or type of a media property.

dimension

publisher_id

publisher_id

A unique identifier for a publisher (also known as a media partner).

dimension

publisher_name

publisher_name

The name of the publisher (also known as a media partner).

dimension

ref_ad_placement

ref_ad_placement

The location where the referring ad was hosted when it referred a customer.

dimension

ref_ad_position

ref_ad_position

The type of screen on which the referring ad was placed when it referred a customer.

dimension

ref_ad_rank

ref_ad_rank

The ranking of the referring ad on search engine results pages.

dimension

ref_landingpage_url

ref_landingpage_url

The URL of the landing page associated with the referral.

dimension

ref_media_business_region

ref_media_business_region

The geographical region in which the business that referred the customer operates.

dimension

ref_media_line_of_business

ref_media_line_of_business

The product grouping classification of the referring partner, if passed during a conversion.

dimension

ref_media_property

ref_media_property

The media property (e.g., website, app) that generated the referral.

dimension

ref_redirect_rule_id

ref_redirect_rule_id

The unique identifier of the blocking or redirect rule that affected the customer’s referral journey.

dimension

ref_type_display

ref_type_display

The display name for the referral type.

dimension

ref_unique_id

ref_unique_id

The unique identifier for a customer referral.

dimension

ref_url

ref_url

The URL from which the user was referred.

dimension

referral_traffic_source

referral_traffic_source

The referring ad that generated the traffic for the click action.

dimension

referral_traffic_type

referral_traffic_type

The specific type or kind of traffic that generated the click action.

dimension

scheduled_clearing_date

scheduled_clearing_date

The planned date for a payment or action to be cleared.

dimension

site_category

site_category

The category or type of site that referred the customer.

dimension

start_date

start_date

The start date of a campaign, report, or event.

dimension

status_detail

status_detail

Additional details regarding the status of a record or action.

dimension

sub_account

sub_account

An identifier for a specific sub-account or child account under a primary account, used for campaign filtering.

dimension

sum_cost

sum_cost

The aggregated total cost associated with an action or campaign.

metric

traffic_cat

traffic_cat

A classification or category for the type of traffic that generated a click action.

dimension

traffic_category

traffic_category

A classification or category for the type of traffic that generated a click action.

dimension

txn_id

txn_id

A unique transaction identifier for an action.

dimension