The action updates object

An ActionUpdates object is created when an action has been updated, which is defined as:

When the action is initially tracked
If the action is modified, and each modification thereafter
If the action is reversed

Each time an update occurs, a new ActionUpdates object is created and identifiable by a unique Id value. This endpoint is useful as a feed of update data for actions, which can be imported into your own system or a data warehouse.

🚧
Note
impact.com recommends using action lifecycle postbacks instead of the ActionUpdates endpoint for all but occasional requests in order to receive low latency (near realtime) action updates. Learn more about enabling postbacks here.

Attributes

`Id` string

Unique identifier for the action update. Every time an Action is updated, a new Id value is generated to track the specific updates that occurred.

`ActionId` 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.

`ActionTrackerId` integer

Unique identifier 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.

`State` enum

Current state of the action.

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

`StateDetail` string

Additional details for the state of the action. Can be blank if no details exist.

Possible enum values
`OPEN`	Action is currently pending and its locking date is not finalized.
`PAYMENT_PENDING`	Action is approved is payment is pending. No further modifications to the action amounts will occur.
`PAID`	Action payout has been paid to the partner.
`OVERDUE`	Action is past its payment due date and has not been paid.
`DEFAULTED`	Action is overdue and the brand account has been closed without paying. This is rare.
`OVERLIMIT_BUDGET`	Action was reversed due to a budget limit constraint on the contract.
`OVERLIMIT_ACTIONCAP`	Action was reversed due to an action limit constraint on the contract.
`ITEM_RETURNED`	Action was modified/reversed due to the purchased item being returned.
`ITEM_OUT_OF_STOCK`	Action was modified/reversed due to the purchased item being out of stock.
`NOT_COMPLIANCE_TERMS`	Action doesn't qualify for a payout due to violating terms of the contract.
`REJECTED`	General rejection of the action.
`ORDER_ERROR`	Action was modified/reversed due to an error with the order.
`CONS_FRAUD`	Action was modified/reversed due to a fraudulent transaction.
`CREDITED_DIFFERENT_MP`	A different partner was credited for this action.
`TEST_ACTION`	A test action not eligible for payout.

`AdId` integer

Unique identifier for the ad that drove the winning click.

`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.

`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.

`Category` string

Your category for the product associated with this action item. This is the passed value as opposed the value looked-up from the product catalog.

`Sku` string

Stock-keeping unit (SKU) identifier that you've assigned to the item. This field is used for lookups to your product catalog.

`Quantity` string

Number of units of the product in the action item.

`CatalogName` string

The display name for the product associated with this action item according to the Name field in the product catalog.

`CatalogCategory` string

The display name for the product associated with this action item according to the Category field in the product catalog.

`UpdateDate` datetime

ISO 8601 format of the date and time when the action was first modified. If an action is modified multiple times, this will change to date and time the action was last updated.

`LockingDate` datetime

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

`ClearingDate` datetime

ISO 8601 format of the date and time when the action commission will be paid to the winning partner.

`ActionDate` datetime

ISO 8601 format of the date and time when the action took place.

`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).

`ActionUri` string

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

`Uri` string

Unique reference to the action update 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.

`StateDetailDescription` string

Description for the current state of the action.

`Disposition` string

A custom state for the action, which is configured in event type settings. Displays IR_BLANK if one isn't sent.

`Currency` currency

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.

`CatalogDescription` string

Description of the product from the product catalog.

`CatalogManufacturer` string

Name of the product's manufacturer from the product catalog.

`CatalogOriginalFormatCategory` string

If the product catalog has been modified, this is the product's original category.

`CatalogSubCategory` string

Name of the sub-category for the product from the product catalog.

`CallerId` string

If the action was from a call tracking event type, this is the caller ID value associated with the conversion.

`ContractId` string

Unique identifier of the contract associated with the action.

`EventTypeId` string

Unique identifier for the event type. This is identical to ActionTrackerId found in other endpoints.

`EventTypeName` string

Name of the event type (or action tracker).

`PayoutLevel` enum

Payout level for the action.

Possible enum values
`ORDER`	Action pays out at the order-level (payout is calculated based on the order total).
`ITEM`	Action pays out at the item-level (payout is calculated for each item in the action individually, then totaled up)

`DefaultPayout` decimal

The default payout for this action without any modifications.

`DefaultPayoutCurrency` enum

Three-letter ISO 4217 alpha code representing the default currency for the action.

`PayoutGroup` array

Payout groups that the contract has set up.

View child attributes

`Id` string

Payout group’s Id.

`Rank` integer

Rank order of a payout group.

`Rules` array

Rules of the payout group. These rules will apply based on the performance of the component items or variables within the rule.

View child attributes

`Variable` enum

What the payout group looks for.

View possible enum values
`ITEM_SKU`	SKU number of the item.
`ITEM_SKU_LIST`	Array of item SKU numbers.
`ITEM_CATEGORY`	Category that the item is listed in.
`ITEM_CATEGORY_LIST`	Category list an item is placed in.
`ITEM_SUBCATEGORY`	Subcategory an item is placed in.
`ITEM_BRAND`	Brand that makes an item.
`ITEM_PRICE`	Price of an item.
`ITEM_QUANTITY`	Quantity of an item.
`ITEM_PROMO_CODE`	Promo code associated with an item.
`ITEM_PROMO_CODE_LIST`	Promo code list associated with an item.
`ITEM_DISCOUNT`	Item’s discount.
`ITEM_SUBTOTAL`	Item’s subtotal before any deals or fees are applied.
`ITEM_CATALOG_CATEGORY`	The catalog category an item was placed in.
`ITEM_CATALOG_ORIGINAL_FORMAT_CATEGORY`	The original catalog category an item was placed in.
`ITEM_CATALOG_SUBCATEGORY`	The catalog subcategory an item was placed in.
`ITEM_CATALOG_MANUFACTURER`	The item’s manufacturer as it is listed in a product catalog.
`ORDER_PROMO_CODE`	Promo code used in the order.
`ORDER_PROMO_CODE_LIST`	List a promo code used was placed in.
`ORDER_DISCOUNT`	Order’s discount.
`ORDER_SHIPPING`	Order’s shipping cost.
`ORDER_TAX`	Tax applied to an order.
`ORDER_PAYMENT_TYPE`	How a customer pays for an order.
`ORDER_LOCATION_ID`	The location Id an order was placed in.
`ORDER_LOCATION_NAME`	The location name an order was placed in.
`ORDER_LOCATION_TYPE`	The location type an order was placed in.
`ORDER_TOTAL`	The order total.
`GIFT_PURCHASE`	If the product purchased is intended to be a gift.
`CURRENCY`	The currency used to purchase the product.
`CUSTOMER_CITY`	The city a customer purchased the product from.
`CUSTOMER_REGION`	Region the customer purchased from.
`CUSTOMER_POSTCODE`	Postal code the customer purchased from.
`CUSTOMER_COUNTRY`	Country the customer purchased from.
`CUSTOMER_STATUS`	If the customer is new, existing, re-engaged, frequent, or another status.
`MONEY1`	A unique money value.
`MONEY2`	A unique money value.
`MONEY3`	A unique money value.
`DATE1`	A custom date value. See ISO 8601.
`DATE2`	A custom date value. See ISO 8601.
`DATE3`	A custom date value. See ISO 8601.
`NUMERIC1`	A custom numeric value.
`NUMERIC2`	A custom numeric value.
`NUMERIC3`	A custom numeric value.
`TEXT1`	A custom text value.
`TEXT2`	A custom text value.
`TEXT3`	A custom text value.
`SITE_CATEGORY`	The category a site was placed in.
`SITE_VERSION`	A website’s version.
`HEAR_ABOUT_US`	How a customer heard about the brand or product.
`NOTE`	A note.
`DERIVED_COUNTRY`	What country the payout group is derived from.
`DERIVED_STATE_REGION`	What state or region the payout group is derived from.
`DERIVED_DEVICE_TYPE`	What device type the payout group is derived from.
`DERIVED_BROWSER`	What browser the payout group is derived from.
`DERIVED_OS`	What operating system the payout group is derived from.
`REFERRAL_TYPE`	How the customer was referred to the product.
`REFERRAL_AD`	Ad associated with the referring action.
`REFERRAL_DEAL`	Deal associated with the referring action.
`REFERRAL_SHARED_ID`	SharedId associated with the referring action.
`REFERRAL_TRAFFIC_CATEGORY`	Traffic category associated with the referring action.
`REFERRAL_TRAFFIC_SOURCE`	Traffic source associated with the referring action.
`REFERRAL_SKU`	SKU code associated with the referring action.
`REFERRAL_URL`	URL associated with the referring action.
`REFERRAL_LANDING_PAGE`	Landing page associated with the referring action.
`REFERRAL_AD_PLACEMENT`	Ad placement associated with the referring action.
`REFERRAL_AD_TYPE`	Ad type associated with the referring action.
`REFERRAL_AD_KEYWORD`	Ad keyword associated with the referring action.
`REFERRAL_AD_CAMPAIGN`	Ad program (formerly known as campaign) associated with the referring action.
`REFERRAL_AD_CAMPAIGN_ID`	Ad program (formerly known as campaign) Id associated with the referring action.
`REFERRAL_AD_GROUP`	Ad group associated with the referring action.
`REFERRAL_AD_GROUP_ID`	Ad group Id associated with the referring action.
`REFERRAL_PARAM1`	Param parameter associated with the referring action.
`REFERRAL_PARAM2`	Param parameter associated with the referring action.
`REFERRAL_PARAM3`	Param parameter associated with the referring action.
`REFERRAL_PARAM4`	Param parameter associated with the referring action.
`REFERRAL_SUB_ACCOUNT_ID`	Sub account Id associated with the referring action.
`REFERRAL_SUB_ACCOUNT_NAME`	Sub account name associated with the referring action.
`REFERRAL_DERIVED_COUNTRY`	Payout group’s derived country associated with the referring action.
`REFERRAL_DERIVED_STATE_REGION`	Payout group’s derived state or region associated with the referring action.
`REFERRAL_DERIVED_DEVICE_TYPE`	Payout group’s derived device type associated with the referring action.
`REFERRAL_DERIVED_BROWSER`	Payout group’s derived web browser associated with the referring action.
`REFERRAL_DERIVED_OS`	Payout group’s derived operating system associated with the referring action.
`CALLER_COUNTRY`	Country the caller called from.
`CALLED_COUNTRY`	Country of the call recipient.
`CALLED_NUMBER`	Phone number of the call recipient.
`CALL_DURATION`	Duration of the phone call.
`CALL_TALK_DURATION`	Duration of the phone conversation.
`CALL_PHONE_TYPE`	Type of phone the call recipient used.
`CALL_KEY1`	A custom call key.
`CALL_KEY2`	A custom call key.
`CALL_KEY3`	A custom call key.
`CALL_KEY4`	A custom call key.
`CALL_TRAFFIC_SOURCE`	Traffic source associated with the phone call.
`PATH_PARTICIPATION_CHANNELS`	What channels were involved in a customer’s journey.
`PATH_PARTICIPATING_MEDIA`	What partner(s) were involved in a customer’s journey.
`PATH_PARTICIPATING_GROUPS`	What partner groups were involved in a customer’s journey.
`PATH_STEPS`	Amount of steps a customer took on their journey.
`PATH_INTRODUCING_MEDIA`	Partner(s) that started a customer’s journey.
`PATH_INTRODUCING_GROUPS`	Comma-separated list of the partner group(s) that began a customer’s journey.
`PATH_INTRODUCING_CHANNELS`	Comma-separated list of the channel(s) that began a customer’s journey.
`PATH_CLOSING_MEDIA`	Partner that closed a customer journey.
`PATH_CLOSING_GROUPS`	Comma-separated list of the partner group(s) that closed the sale.
`PATH_CLOSING_CHANNELS`	Comma-separated list of channels that closed the sale.
`PATH_MEDIA_COUNT`	How many media pieces were involved in the customer’s journey.
`PATH_IMPACT_PARTNER_COUNT`	How many partners were involved in the customer’s journey.
`PATH_PARTNER_COUNT`	How many partners were involved in a customer’s journey.
`PATH_CHANNEL_COUNT`	How many steps the customer took on their purchase journey.

`Operator` enum

How the Variable is applied.

View possible enum values
`IS`	`Variable` must be `Value`.
`IS_NOT`	`Variable` cannot be `Value`.
`IS_NOT_WHEN_PRESENT`	If `Variable` is present, it cannot be `Value`. Only for string `Values`.
`IS_PRESENT`	If `Variable` is present.
`IS_NOT_PRESENT`	If `Variable` is not present.
`RANGE`	Number range that `Value` can land in. Only for integer `Values`.
`LESS_THAN`	`Variable` must be lower than `Value`. Only for integer `Values`.
`GREATER_THAN`	`Variable` must be greater than `Value`. Only for integer `Values`.
`DATE_RANGE`	`Variable` must land within the date range defined in `Value`.
`DATE_LESS_THAN`	`Variable` must be before the date defined in `Value`.
`DATE_GREATER_THAN`	`Variable`Value.
`WILDCARD`	If the listed character string(s) appear anywhere in `Value`. Only for string `Values`.
`BEGINS_WITH`	If `Value` begins with certain characters. Only for string `Values`.
`ENDS_WITH`	If `Value` ends with certain characters. Only for string `Values`.
`CONTAINS`	If `Value` contains certain characters. Only for string `Values`.
`DOES_NOT_CONTAIN`	If `Value` does not contain certain characters. Only for string `Values`.
`COLLECTION_CONTAINS`	If `Value` is contained within the collection.
`COLLECTION_DOES_NOT_CONTAIN`	If `Value` is not contained in the collection.

`Values` array

What Variable is looking for. Will be empty if Variable: IS_PRESENT or Variable: IS_NOT_PRESENT.

`MatchedValue` string

The value that matched the condition to trigger the payout group.

`Payout` decimal

The payout amount if the payout rule is applied. If present, PayoutRate will not be.

`PayoutRate` integer

Order percentage that will become the payout if the tier is met. If present, Payout will not be.

`PayoutAdjustments` array

Conditions that can change an action’s payout details.

View child attributes

`Id` string

Payout adjustment’s Id.

`Rules` array

Rules for how the payout adjustment applies.

View child attributes

`Variable` enum

What the payout group looks for.

View possible enum values
`ITEM_SKU`	SKU number of the item.
`ITEM_SKU_LIST`	Array of item SKU numbers.
`ITEM_CATEGORY`	Category that the item is listed in.
`ITEM_CATEGORY_LIST`	Category list an item is placed in.
`ITEM_SUBCATEGORY`	Subcategory an item is placed in.
`ITEM_BRAND`	Brand that makes an item.
`ITEM_PRICE`	Price of an item.
`ITEM_QUANTITY`	Quantity of an item.
`ITEM_PROMO_CODE`	Promo code associated with an item.
`ITEM_PROMO_CODE_LIST`	Promo code list associated with an item.
`ITEM_DISCOUNT`	Item’s discount.
`ITEM_SUBTOTAL`	Item’s subtotal before any deals or fees are applied.
`ITEM_CATALOG_CATEGORY`	The catalog category an item was placed in.
`ITEM_CATALOG_ORIGINAL_FORMAT_CATEGORY`	The original catalog category an item was placed in.
`ITEM_CATALOG_SUBCATEGORY`	The catalog subcategory an item was placed in.
`ITEM_CATALOG_MANUFACTURER`	The item’s manufacturer as it is listed in a product catalog.
`ORDER_PROMO_CODE`	Promo code used in the order.
`ORDER_PROMO_CODE_LIST`	List a promo code used was placed in.
`ORDER_DISCOUNT`	Order’s discount.
`ORDER_SHIPPING`	Order’s shipping cost.
`ORDER_TAX`	Tax applied to an order.
`ORDER_PAYMENT_TYPE`	How a customer pays for an order.
`ORDER_LOCATION_ID`	The location Id an order was placed in.
`ORDER_LOCATION_NAME`	The location name an order was placed in.
`ORDER_LOCATION_TYPE`	The location type an order was placed in.
`ORDER_TOTAL`	The order total.
`GIFT_PURCHASE`	If the product purchased is intended to be a gift.
`CURRENCY`	The currency used to purchase the product.
`CUSTOMER_CITY`	The city a customer purchased the product from.
`CUSTOMER_REGION`	Region the customer purchased from.
`CUSTOMER_POSTCODE`	Postal code the customer purchased from.
`CUSTOMER_COUNTRY`	Country the customer purchased from.
`CUSTOMER_STATUS`	If the customer is new, existing, re-engaged, frequent, or another status.
`MONEY1`	A unique money value.
`MONEY2`	A unique money value.
`MONEY3`	A unique money value.
`DATE1`	A custom date value. See ISO 8601.
`DATE2`	A custom date value. See ISO 8601.
`DATE3`	A custom date value. See ISO 8601.
`NUMERIC1`	A custom numeric value.
`NUMERIC2`	A custom numeric value.
`NUMERIC3`	A custom numeric value.
`TEXT1`	A custom text value.
`TEXT2`	A custom text value.
`TEXT3`	A custom text value.
`SITE_CATEGORY`	The category a site was placed in.
`SITE_VERSION`	A website’s version.
`HEAR_ABOUT_US`	How a customer heard about the brand or product.
`NOTE`	A note.
`DERIVED_COUNTRY`	What country the payout adjustment is derived from.
`DERIVED_STATE_REGION`	What state or region the payout adjustment is derived from.
`DERIVED_DEVICE_TYPE`	What device type the payout adjustment is derived from.
`DERIVED_BROWSER`	What browser the payout adjustment is derived from.
`DERIVED_OS`	What operating system the payout adjustment is derived from.
`REFERRAL_TYPE`	How the customer was referred to the product.
`REFERRAL_AD`	Ad associated with the referring action.
`REFERRAL_DEAL`	Deal associated with the referring action.
`REFERRAL_SHARED_ID`	SharedId associated with the referring action.
`REFERRAL_TRAFFIC_CATEGORY`	Traffic category associated with the referring action.
`REFERRAL_TRAFFIC_SOURCE`	Traffic source associated with the referring action.
`REFERRAL_SKU`	SKU code associated with the referring action.
`REFERRAL_URL`	URL associated with the referring action.
`REFERRAL_LANDING_PAGE`	Landing page associated with the referring action.
`REFERRAL_AD_PLACEMENT`	Ad placement associated with the referring action.
`REFERRAL_AD_TYPE`	Ad type associated with the referring action.
`REFERRAL_AD_KEYWORD`	Ad keyword associated with the referring action.
`REFERRAL_AD_CAMPAIGN`	Ad program (formerly known as campaign) associated with the referring action.
`REFERRAL_AD_CAMPAIGN_ID`	Ad program (formerly known as campaign) Id associated with the referring action.
`REFERRAL_AD_GROUP`	Ad group associated with the referring action.
`REFERRAL_AD_GROUP_ID`	Ad group Id associated with the referring action.
`REFERRAL_PARAM1`	Param parameter associated with the referring action.
`REFERRAL_PARAM2`	Param parameter associated with the referring action.
`REFERRAL_PARAM3`	Param parameter associated with the referring action.
`REFERRAL_PARAM4`	Param parameter associated with the referring action.
`REFERRAL_SUB_ACCOUNT_ID`	Sub account Id associated with the referring action.
`REFERRAL_SUB_ACCOUNT_NAME`	Sub account name associated with the referring action.
`REFERRAL_DERIVED_COUNTRY`	Payout adjustment's derived country associated with the referring action.
`REFERRAL_DERIVED_STATE_REGION`	Payout adjustment's derived state or region associated with the referring action.
`REFERRAL_DERIVED_DEVICE_TYPE`	Payout adjustment's derived device type associated with the referring action.
`REFERRAL_DERIVED_BROWSER`	Payout adjustment's derived web browser associated with the referring action.
`REFERRAL_DERIVED_OS`	Payout adjustment's derived operating system associated with the referring action.
`CALLER_COUNTRY`	Country the caller called from.
`CALLED_COUNTRY`	Country of the call recipient.
`CALLED_NUMBER`	Phone number of the call recipient.
`CALL_DURATION`	Duration of the phone call.
`CALL_TALK_DURATION`	Duration of the phone conversation.
`CALL_PHONE_TYPE`	Type of phone the call recipient used.
`CALL_KEY1`	A custom call key.
`CALL_KEY2`	A custom call key.
`CALL_KEY3`	A custom call key.
`CALL_KEY4`	A custom call key.
`CALL_TRAFFIC_SOURCE`	Traffic source associated with the phone call.
`PATH_PARTICIPATION_CHANNELS`	What channels were involved in a customer’s journey.
`PATH_PARTICIPATING_MEDIA`	What partner(s) were involved in a customer’s journey.
`PATH_PARTICIPATING_GROUPS`	What partner groups were involved in a customer’s journey.
`PATH_STEPS`	Amount of steps a customer took on their journey.
`PATH_INTRODUCING_MEDIA`	Partner(s) that started a customer’s journey.
`PATH_INTRODUCING_GROUPS`	Comma-separated list of the partner group(s) that began a customer’s journey.
`PATH_INTRODUCING_CHANNELS`	Comma-separated list of the channel(s) that began a customer’s journey.
`PATH_CLOSING_MEDIA`	Partner that closed a customer journey.
`PATH_CLOSING_GROUPS`	Comma-separated list of the partner group(s) that closed the sale.
`PATH_CLOSING_CHANNELS`	Comma-separated list of channels that closed the sale.
`PATH_MEDIA_COUNT`	How many media pieces were involved in the customer’s journey.
`PATH_IMPACT_PARTNER_COUNT`	How many partners were involved in the customer’s journey.
`PATH_PARTNER_COUNT`	How many partners were involved in a customer’s journey.
`PATH_CHANNEL_COUNT`	How many steps the customer took on their purchase journey.

`Operator` enum

How the Variable is applied.

View possible enum values
`IS`	`Variable` must be `Value`.
`IS_NOT`	`Variable` cannot be `Value`.
`IS_NOT_WHEN_PRESENT`	If `Variable` is present, it cannot be `Value`. Only for string `Values`.
`IS_PRESENT`	If `Variable` is present.
`IS_NOT_PRESENT`	If `Variable` is not present.
`RANGE`	Number range that `Value` can land in. Only for integer `Values`.
`LESS_THAN`	`Variable` must be lower than `Value`. Only for integer `Values`.
`GREATER_THAN`	`Variable` must be greater than `Value`. Only for integer `Values`.
`DATE_RANGE`	`Variable` must land within the date range defined in `Value`.
`DATE_LESS_THAN`	`Variable` must be before the date defined in `Value`.
`DATE_GREATER_THAN`	`Variable`Value.
`WILDCARD`	If the listed character string(s) appear anywhere in `Value`. Only for string `Values`.
`BEGINS_WITH`	If `Value` begins with certain characters. Only for string `Values`.
`ENDS_WITH`	If `Value` ends with certain characters. Only for string `Values`.
`CONTAINS`	If `Value` contains certain characters. Only for string `Values`.
`DOES_NOT_CONTAIN`	If `Value` does not contain certain characters. Only for string `Values`.
`COLLECTION_CONTAINS`	If `Value` is contained within the collection.
`COLLECTION_DOES_NOT_CONTAIN`	If `Value` is not contained in the collection.

`Values` array

What Variable is looking for. Will be empty if Variable: IS_PRESENT or Variable: IS_NOT_PRESENT.

`Direction` enum

How the payout is adjusted.

View possible enum values
`INCREASE`	Raise the payout by a certain percentage.
`DECREASE`	Lower the payout by a certain percentage.
`ADD`	Add a fixed amount to the payout.
`SUBTRACT`	Remove a fixed amount from the payout.

`Amount` decimal

If Direction: "ADD || SUBTRACT", then the fixed amount change will appear.

`Rate` integer

If Direction: "INCREASE || DECREASE", then the percent change will appear.

{
  "Id": "1000.4636.158133.95095059",
  "ActionId": "1000.4636.158133",
  "CampaignId": "1000",
  "ActionTrackerId": "2240",
  "EventCode": "",
  "MediaPartnerId": "10000",
  "State": "PENDING",
  "StateDetail": "",
  "StateDetailDescription": "Action comes in DEFAULT and a locking date has not been set yet",
  "AdId": "506720",
  "Disposition": "IR_BLANK",
  "DeltaPayout": "0.65",
  "DeltaAmount": "16.29",
  "Currency": "USD",
  "Category": "Lego",
  "Sku": "12345",
  "Quantity": "2",
  "CatalogName": "",
  "CatalogCategory": "",
  "CatalogDescription": "",
  "CatalogManufacturer": "",
  "CatalogOriginalFormatCategory": "",
  "CatalogSubCategory": "",
  "UpdateDate": "2020-09-10T10:51:23-07:00",
  "LockingDate": "2020-09-26T00:00:00-07:00",
  "ClearingDate": "2020-09-30T00:00:00-07:00",
  "ActionDate": "2020-09-10T10:42:38-07:00",
  "Oid": "9217374917472",
  "CustomerId": "BCZ2WVSH674563PDPYOTM3AXDQ",
  "CustomerStatus": "",
  "CallerId": "",
  "ContractId": "S-3240326",
  "EventTypeId": "2240",
  "EventTypeName": "Sale",
  "PayoutLevel": "ITEM",
  "DefaultPayoutRate": "2",
  "DefaultPayoutCurrency": "USD",
  "PayoutGroup": {
    "Id": "8034e85e-554b-4b4d-85e0-589568985618",
    "Rank": "1",
    "PayoutRate": "8",
    "Rules": [
      {
        "Variable": "ITEM_CATEGORY_LIST",
        "Operator": "IS",
        "Values": [
          "19564"
        ],
        "MatchedValue": "19564"
      }
    ]
   },
  "PayoutAdjustments": [
    {
      "Id": "8e993fb0-a984-4248-98ca-03baf6196703",
      "Rank": "1",
      "Direction": "INCREASE",
      "Rate": "15",
      "Rules": [
        {
          "Variable": "CUSTOMER_STATUS",
          "Operator": "IS",
          "Values": [
            "NEW"
          ],
          "MatchedValue": "NEW"
        }
      ]
    },
  ],
  "SharedId": "",
  "ActionUri": "/Advertisers/<AccountSid>/Actions/1000.4636.158133",
  "Uri": "/Advertisers/<AccountSid>/ActionUpdates/1000.4636.158133.95095059"
}

🚧Note

Attributes

Id string

ActionId string

CampaignId integer

ActionTrackerId integer

MediaPartnerId integer

State enum

StateDetail string

AdId integer

DeltaPayout decimal

DeltaAmount decimal

Category string

Sku string

Quantity string

CatalogName string

CatalogCategory string

UpdateDate datetime

LockingDate datetime

ClearingDate datetime

ActionDate datetime

Oid string

CustomerId string

CustomerStatus string

SharedId string

ActionUri string

Uri string

More attributes

EventCode string

StateDetailDescription string

Disposition string

Currency currency

CatalogDescription string

CatalogManufacturer string

CatalogOriginalFormatCategory string

CatalogSubCategory string

CallerId string

ContractId string

EventTypeId string

EventTypeName string

PayoutLevel enum

DefaultPayout decimal

DefaultPayoutCurrency enum

PayoutGroup array

Id string

Rank integer

Rules array

Variable enum

Operator enum

Values array

MatchedValue string

Payout decimal

PayoutRate integer

PayoutAdjustments array

Id string

Rules array

Variable enum

Operator enum

Values array

Direction enum

Amount decimal

Rate integer

🚧
Note

`Id` string

`ActionId` string

`CampaignId` integer

`ActionTrackerId` integer

`MediaPartnerId` integer

`State` enum

`StateDetail` string

`AdId` integer

`DeltaPayout` decimal

`DeltaAmount` decimal

`Category` string

`Sku` string

`Quantity` string

`CatalogName` string

`CatalogCategory` string

`UpdateDate` datetime

`LockingDate` datetime

`ClearingDate` datetime

`ActionDate` datetime

`Oid` string

`CustomerId` string

`CustomerStatus` string

`SharedId` string

`ActionUri` string

`Uri` string

`EventCode` string

`StateDetailDescription` string

`Disposition` string

`Currency` currency

`CatalogDescription` string

`CatalogManufacturer` string

`CatalogOriginalFormatCategory` string

`CatalogSubCategory` string

`CallerId` string

`ContractId` string

`EventTypeId` string

`EventTypeName` string

`PayoutLevel` enum

`DefaultPayout` decimal

`DefaultPayoutCurrency` enum

`PayoutGroup` array

`Id` string

`Rank` integer

`Rules` array

`Variable` enum

`Operator` enum

`Values` array

`MatchedValue` string

`Payout` decimal

`PayoutRate` integer

`PayoutAdjustments` array

`Id` string

`Rules` array

`Variable` enum

`Operator` enum

`Values` array

`Direction` enum

`Amount` decimal

`Rate` integer