HomeGuidesAPI ReferenceAPI Changelog
Log In
API Reference
Start typing to search…

The action object

Attributes

Id string

Unique identifier for the action.

CampaignId integer

Unique identifier for the campaign (or program) that the action is associated with. This value is also known as the ProgramId.

CampaignName string

Display name for the campaign (or program) that the action is associated with.

ActionTrackerId integer

Unique identifier for the action tracker (or event type) that tracked the conversion associated with the action.

ActionTrackerName string

Display name for the action tracker (or event type) that tracked the conversion associated with the action.

MediaPartnerId integer

Unique identifier for the partner that is credited for the action.

MediaPartnerName string

Display name for the partner that is credited for the action.

State enum

Current state of the action.

Possible enum values
PENDINGAction is awaiting its locking date for approval, or to be manually approved. Actions that have been modified will also have this state.
APPROVEDAction reached its locking date and was approved, or was manually approved and will pay out the partner. No further modifications can occur.
REVERSEDAction was reversed and will not pay out the partner.

AdId integer

Unique identifier for the ad that drove the winning click.

Payout decimal

Commission amount calculated for the action that will be paid out to the partner.

Amount decimal

Revenue amount associated with the action.

Currency enum

Three-letter ISO 4217 alpha code representing the currency for the action. In most cases, this will be the default currency of your account. This is not the currency sent in on the order.

ReferringDate datetime

ISO 8601 format of the date and time when the winning click occured.

EventDate datetime

ISO 8601 format of the date and time when the conversion event occured.

LockingDate datetime

ISO 8601 format of the date and time when the action will lock and can no longer be modified or reversed.

ClearedDate datetime

ISO 8601 format of the date and time when the action commission cleared your account balance. Returns empty if the action hasn't cleared yet.

ReferringDomain string

Domain of the site that the winning click occured on.

PromoCode string

Populates with the promotional code applied to the conversion if one was used.

Oid string

Your unique identifier for the order associated with this conversion. For example, in a retail sale, this could be the Order ID you've assigned the customer for their purchase. Note that an Oid value only needs to be unique to the action tracker.

CustomerId string

Your unique identifier for the customer associated with this conversion. This attribute should never have personally identifiable information (PII). Values such as plaintext email addresses are not permitted.

CustomerStatus string

The particular status of the customer associated with the conversion. These are custom-mapped in the Event Type setup of your account. Commonly mapped values are New or Existing to distinguish new customers.

SharedId string

The Shared ID value associated with the winning click for the action. This value is a query string parameter that partners can append to the tracking link, typically used to share traffic segments (or other information) with the brand (you).

Uri string

Unique reference to the action object in the impact.com API.

More attributes

View more attributes

EventCode string

[Legacy value] For mobile app events, populates with an associated EventCode field representing the type of event tracked.

ClientCost decimal

Total cost of the action to the brand (you). If an agency commission is configured, this will be the partner's commission plus the agency's commission.

DeltaPayout decimal

The change in Payout value between the current action update and the previous one. If this is the first update record for the action, the DeltaPayout will equal the action's Payout.

IntendedPayout decimal

Original payout amount for the action calculated by the template terms before any modifications.

DeltaAmount decimal

The change in Amount value between the current action update and the previous one. If this is the first update record for the action, the DeltaAmount will equal the action's Amount.

IntendedAmount decimal

Original amount for the action before any modifications.

CreationDate datetime

ISO 8601 format of the date and time when the action was created in impact.com.

ReferringType enum

Legacy value denoting the internal type associated with the winning referral.

Possible enum values
CLICK_COOKIE
CLICK_FINGERPRINT
CALL
PROMOCODE
ACTION
REPORTED_PARTNER_ID
IMPRESSION_COOKIE
IMPRESSION_FINGERPRINT
ACTION_INQUIRY

IpAddress string

Hash of the public IP address of the customer that converted.

CustomerPostCode string

Postal code (or ZIP code) for the customer's area.

Note string

General field used to pass information for event-level reporting purposes.

CallerId string

Primarily used for conversions occurring over the phone, this is the customer's caller ID value.

CustomerArea string

The Designated Market Area (DMA) code of the customer's area, derived from IP address.

CustomerCity string

The city the customer resides in.

CustomerRegion string

The region (or state) the customer resides in.

CustomerCountry string

The country the customer resides in.

{
  "Id": "1000.4636.158133",
  "CampaignId": "1000",
  "CampaignName": "Acme Campaign",
  "ActionTrackerId": "2240",
  "ActionTrackerName": "Sale",
  "EventCode": "",
  "MediaPartnerId": "10000",
  "MediaPartnerName": "Acme Partner",
  "State": "PENDING",
  "AdId": "506720",
  "ClientCost": "0.8800",
  "Payout": "0.88",
  "DeltaPayout": "0.88",
  "IntendedPayout": "0.88",
  "Amount": "21.99",
  "DeltaAmount": "21.99",
  "IntendedAmount": "21.99",
  "Currency": "USD",
  "ReferringDate": "2020-09-10T09:45:07-07:00",
  "EventDate": "2020-09-10T10:42:38-07:00",
  "CreationDate": "2020-09-10T10:51:23-07:00",
  "LockingDate": "2020-09-26T00:00:00-07:00",
  "ClearedDate": "",
  "ReferringType": "CLICK_COOKIE",
  "ReferringDomain": "",
  "IpAddress": "979823c536b3e06e4f1ee31af1f82b9d",
  "PromoCode": "SUMMERSALE2020",
  "Oid": "9217374917472",
  "CustomerId": "BCZ2WVSH674563PDPYOTM3AXDQ",
  "CustomerPostCode": "15122",
  "CustomerStatus": "NEW",
  "Note": "",
  "CallerId": "",
  "CustomerArea": "n/a",
  "CustomerCity": "Santa Barbara",
  "CustomerRegion": "California",
  "CustomerCountry": "US",
  "SharedId": "RT-19247423",
  "Uri": "/Advertisers/<AccountSid>/Actions/1000.4636.158133"
 }