Version Upgrade
The latest action feed version is Version 5 (V5). If you're using an older version, see the upgrade section to learn how to upgrade.
Data Feeds are automated, scheduled files that can report on a number of different data for your campaign. The primary feature is the Action Feed, which reports both new actions and any updates to existing actions.
An Action Feed can be customized in terms of its delivery frequency, data format, and delivery method.
From the left navigation menu, select
[Menu] → Settings.In the left column, scroll to the Technical section.
Select Data Feeds.
On the right side of the screen, select
[Edit].Select
[Toggle on] to enable the action feed.
From here, you can customize the details of your action feed.
Frequency | Choose the frequency that you want to receive the feed, from hourly up to monthly. |
Data Format | This determines the file type of the action feed:
|
Delivery Method | Choose your preferred delivery method: impact.com FTP (i.e., you pull your action feed from our FTP servers), Partner FTP (i.e., we send the action feed file to your FTP server), or Email (i.e., we email this file as an attachment to an email address). |
Once the action feed is enabled, you can always disable or change details about it—like the frequency, data format, and more.
From the left navigation bar, select
[Menu] → Settings.In the left column, scroll to the Technical section.
Select Event Notifications.
In the top of the screen, select the Data Feeds tab.
On the right side of the screen, select
[Edit].
Refer to the description list in the previous section for details on each setting.
The action feed file can be read using a plain text editor or imported into a spreadsheet.
See the table below for reference to the headers for Action Feed Version 5 (V5).
Field | Format | Description |
AdvertiserId | Integer | The unique advertiser account ID to which the action posted. |
CampaignId | Integer | The unique ID of the campaign to which the action corresponds. |
CampaignName | String | The name of the campaign to which the action corresponds. |
ActionTrackerId | Integer | The unique ID of the action tracker to which the action corresponds. |
ActionTrackerName | String | The name of the action tracker to which the action corresponds. |
TemplateTermName | String | The name of the template term to which the action corresponds. |
MediaPartnerId | Integer | The unique media partner ID to which the action was credited. |
MediaPartnerName | String | The name of the media partner to which the action was credited. |
ActionId | String | The unique ID that impact.com has assigned to the action. |
Status | String | Important: This is a deprecated field and is not available in the latest version of the Action Feed (version 4). An action can have one of the below statuses. Note that all actions with an over limit status can be approved manually by the advertiser. Default: The status of the action when it is first created. If no changes are made to the action, then this would remain as the status. Approved: The advertiser decided this was a valid action, but the advertiser can still make a change before the locking date. Rejected: The advertiser decided this was an invalid action, so the media partner should not be paid out. Modified: The advertiser decided that part of the action was invalid (e.g., the customer returned an item in the order) so the payout was reduced. Over Limit - Weekday Cap: The action occurred after the weekday cap was already met. Over Limit - Weekend Cap: The action occurred after the weekend cap was already met. Over Limit - Budget: The action occurred after the budget specified on the insertion order was already met. Over Limit - Action Cap: The action occurred after the maximum number of actions specified on the insertion order was already met. Over Limit - IO Expired: The action occurred after the insertion order was terminated or expired. Over Limit - Concurrent Calls: The action occurred after the number of concurrent calls specified on the insertion order was already met. |
State | String | This value is a status indicating advertiser response to the action, with one of the following values: "APPROVED", "PENDING", or "REVERSED". This value cannot be changed after the action’s locking date. |
ModificationReason | String | Important: This is a deprecated field and is not available in the latest version of the Action Feed (version 4). |
AdId | Integer | The unique ID of the ad with which the consumer interacted to initiate the action. |
ClientCost | Decimal (8,2) | The net “cost” of the action to the advertiser. |
Payout | Decimal (8,2) | The payout to be received by the media partner. For modified actions, this is the net payout. For over limit actions, the payout is $0.00. |
DeltaPayout | Decimal (8,2) | The change in the payout from the previous state. For example, if the advertiser modified the action as a result of a customer return, this value represents the negative adjustment in the payout. If the action has not been modified, this will be the same value as Payout. |
IntendedPayout | Decimal (8,2) | The payout of the action before it was modified. If the action has not been modified, this will be the same value as Payout. |
Amount | Decimal (8,2) | The sales amount, or revenue, of the action. This value is only relevant for pay-per-sale events. |
DeltaAmount | Decimal (8,2) | The change in the sales amount if the action has been modified. If the action has not been modified, this will be the same value as Amount. |
IntendedAmount | Decimal (8,2) | The sales amount before the action was modified. If the action has not been modified, this will be the same value as Amount. |
Currency | String (3) | The currency code that the action was submitted with (currency in advertiser settings is the default if currency code value is not submitted). |
OriginalCurrency | String (3) | The original currency code detected with the action. |
ReferringDate | Timestamp, ISO 8601 | The date and time of the referral associated with the action. This will be the same as the EventDate for actions batched without a ClickId. |
EventDate | Timestamp, ISO 8601 | The date and time that the event took place. |
CreationDate | Timestamp, ISO 8601 | The date and time when the action was processed and created in the impact.com system. |
LockingDate | Timestamp, ISO 8601 | The date when the action locks. After this date, the action cannot be modified by advertiser, and it becomes payable to the media partner. |
ClearedDate | Timestamp, ISO 8601 | If the media partner has been paid on this action already, this is the date and time when the funds were transferred to their account. |
ReferringType | String | The type of referral corresponding to this action. For example, ‘CLICK_COOKIE’ for a click referral, or ‘REPORTED_PARTNER_ID’ if the action was batched with a media partner ID. |
ReferringDomain | String | The URL where the click referral came from. |
IpAddress | String | The customer's IP Address. |
PromoCode | String (64) | The promo code that was submitted with the action, if there was one. |
Oid | String (64) | The unique, trackable order ID of the action. |
CustomerId | String (50) | The customer ID submitted with the action. |
CustomerPostCode | Numeric | The customer’s postal code, if it was submitted with the action. |
CustomerStatus | String (40) | The customer’s status (New or Returning), if it was submitted with the action. |
Note | String (255) | A note can include any extra information the advertiser wants to include in the action. If a Note was submitted with the action, it will appear here. |
CallerId | Integer | If this was a Call Tracking action, the required CallerId value for the action will appear here. |
CustomerArea | String | The geographical area of the customer, if it was detected with the action (i.e. DMA code). |
CustomerCity | String | The city of the customer, if it was detected with the action. |
CustomerRegion | String | The region of the customer, if it was detected with the action. |
CustomerCountry | String | The country of the customer. |
SharedId | String (32) | This value is specific to the media partner, but available to both the media partner and advertiser. |
Items | String (255) | Item-level category, sku, amount, quantity, payout, name, item rebate, and item list (respectively) separated by the “^” character. Multiple items are separated by the “~” character. |