Action Updates

List action updates

get

Returns a list of action updates, which serve as a changelog for actions. It is recommended to filter by a date range using StartDate and EndDate.

Date filtering constraints (effective 5 August 2024):

• StartDate cannot be more than 3 years in the past.
• The range between StartDate and EndDate cannot exceed 45 days.
• If neither is specified, only the past 7 days are returned.
• If StartDate is specified, EndDate must also be specified.

Recommendation: Use action lifecycle postbacks instead of this endpoint for near-realtime updates.

Authorizations

basicAuth

AuthorizationstringRequired

Use your AccountSID as the username and AuthToken as the password.

Path parameters

AccountSIDstringRequired

Your unique account identifier.

Query parameters

CampaignIdintegerRequired

The ID of the campaign to view action updates for.

Example: 1000

StartDatestring · date-timeOptional

Filters for updates with an UpdateDate on or after this value (ISO 8601 with time component). Must be used with EndDate.

Example: 2024-01-01T00:00:00Z

EndDatestring · date-timeOptional

Filters for updates with an UpdateDate on or before this value (ISO 8601 with time component). Must be used with StartDate.

Example: 2024-01-31T23:59:59Z

Statestring · enumOptional

Filters updates to only those that match the State value passed.

Example: PENDINGPossible values:

ActionDateStartstring · date-timeOptional

Filters for updates with an ActionDate (EventDate) on or after this value (ISO 8601).

Example: 2024-01-01T00:00:00Z

ActionDateEndstring · date-timeOptional

Filters for updates with an ActionDate (EventDate) on or before this value (ISO 8601).

Example: 2024-01-31T23:59:59Z

LockingDateStartstring · date-timeOptional

Filters for updates with a LockingDate on or after this value (ISO 8601).

Example: 2024-01-01T00:00:00Z

LockingDateEndstring · date-timeOptional

Filters for updates with a LockingDate on or before this value (ISO 8601).

Example: 2024-01-31T23:59:59Z

Responses

200

A paginated list of action update objects.

application/json

get/Advertisers/{AccountSID}/ActionUpdates

cURL

curl 'https://api.impact.com/Advertisers/<AccountSID>/ActionUpdates?CampaignId=1000&StartDate=2024-01-01T00:00:00Z&EndDate=2024-01-31T23:59:59Z' \
  -X GET \
  -u '<AccountSID>:<AuthToken>' \
  -H 'Accept: application/json'

200

A paginated list of action update objects.

{
  "ActionUpdates": [
    {
      "Id": "1000.4636.158133.95095059",
      "ActionId": "1000.4636.158133",
      "CampaignId": 1000,
      "ActionTrackerId": 2240,
      "EventTypeId": "2240",
      "EventTypeName": "Sale",
      "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": "Sports",
      "Sku": "12345",
      "Quantity": "2",
      "CatalogName": "",
      "CatalogCategory": "",
      "CatalogDescription": "",
      "CatalogManufacturer": "",
      "CatalogOriginalFormatCategory": "",
      "CatalogSubCategory": "",
      "PayoutLevel": "ITEM",
      "DefaultPayoutRate": "2",
      "ContractId": "S-3240326",
      "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": "",
      "SharedId": "RT-19247423",
      "ActionUri": "/Advertisers/IRyMQiCNtwrt1804207G3t8Pn6NyzfyDw1/Actions/1000.4636.158133",
      "Uri": "/Advertisers/IRyMQiCNtwrt1804207G3t8Pn6NyzfyDw1/ActionUpdates/1000.4636.158133.95095059"
    }
  ]
}

Get action update details

get

Retrieves the details for a specific update to an action by its unique ActionUpdateId.

Authorizations

basicAuth

AuthorizationstringRequired

Use your AccountSID as the username and AuthToken as the password.

Path parameters

AccountSIDstringRequired

Your unique account identifier.

ActionUpdateIdstringRequired

The unique identifier for the action update, obtainable from the list endpoint.

Example: 1000.4636.158133.95095059

Responses

200

An action update object.

application/json

Represents a single modification event in an action's lifecycle. Each time an action changes state or is modified, a new ActionUpdate record is created.

IdstringOptional

Unique identifier for this action update record.

Example: 1000.4636.158133.95095059

ActionIdstringOptional

Unique identifier for the parent action that was updated.

Example: 1000.4636.158133

CampaignIdintegerOptional

Unique identifier for the campaign this action belongs to.

Example: 1000

ActionTrackerIdintegerOptional

Unique identifier for the action tracker (event type).

Example: 2240

EventTypeIdstringOptional

Alias for ActionTrackerId. The unique identifier of the event type.

Example: 2240

EventTypeNamestringOptional

Display name of the event type (action tracker).

Example: Sale

EventCodestringOptional

The event code associated with the action tracker, if configured.

MediaPartnerIdintegerOptional

Unique identifier for the partner credited for this action.

Example: 10000

Statestring · enumOptional

The state of the action at the time of this update.

Example: PENDINGPossible values:

StateDetailstringOptional

A short code providing additional detail about the action's state (e.g., PAID, OVERDUE).

StateDetailDescriptionstringOptional

A plain-text description of the StateDetail code.

Example: Action comes in DEFAULT and a locking date has not been set yet

AdIdintegerOptional

Unique identifier for the ad creative that drove the winning click.

Example: 506720

DispositionstringOptional

The disposition code applied to this update (e.g., IR_BLANK, ORDER_UPDATE).

Example: IR_BLANK

DeltaPayoutnumberOptional

The change in payout value recorded by this update.

Example: 0.65

DeltaAmountnumberOptional

The change in sale amount recorded by this update.

Example: 16.29

CurrencystringOptional

Three-letter ISO 4217 currency code for monetary values in this update.

Example: USD

CategorystringOptional

Product category of the item associated with this update.

Example: Sports

SkustringOptional

SKU of the item associated with this update.

Example: 12345

QuantitystringOptional

Quantity of the item at the time of this update.

Example: 2

CatalogNamestringOptional

Name of the product catalog entry associated with the item, if applicable.

CatalogCategorystringOptional

Category from the product catalog entry, if applicable.

CatalogDescriptionstringOptional

Description from the product catalog entry, if applicable.

CatalogManufacturerstringOptional

Manufacturer from the product catalog entry, if applicable.

CatalogOriginalFormatCategorystringOptional

Original format category from the product catalog entry, if applicable.

CatalogSubCategorystringOptional

Sub-category from the product catalog entry, if applicable.

PayoutLevelstringOptional

Indicates whether the payout is calculated at the order level or item level (e.g., ORDER, ITEM).

Example: ITEM

DefaultPayoutRatestringOptional

The default payout rate defined in the event type settings.

Example: 2

ContractIdstringOptional

The unique identifier for the contract (partnership agreement) associated with this action.

Example: S-3240326

UpdateDatestring · date-timeOptional

Timestamp of when this update was recorded.

Example: 2020-09-10T10:51:23-07:00

LockingDatestring · date-timeOptional

Date after which the action can no longer be modified.

Example: 2020-09-26T00:00:00-07:00

ClearingDatestring · date-time · nullableOptional

Date when the commission is scheduled to clear.

Example: 2020-09-30T00:00:00-07:00

ActionDatestring · date-timeOptional

Timestamp of the original conversion event.

Example: 2020-09-10T10:42:38-07:00

OidstringOptional

Your unique identifier for the order associated with the parent action.

Example: 9217374917472

CustomerIdstringOptional

Your unique, non-PII identifier for the customer.

Example: BCZ2WVSH674563PDPYOTM3AXDQ

CustomerStatusstringOptional

The customer status label at the time of this update.

SharedIdstringOptional

The Shared ID value from the winning click.

Example: RT-19247423

ActionUristring · uri-referenceOptional

URI reference to the parent action object.

Example: /Advertisers/IRyMQiCNtwrt1804207G3t8Pn6NyzfyDw1/Actions/1000.4636.158133

Uristring · uri-referenceOptional

Unique URI reference to this action update object.

Example: /Advertisers/IRyMQiCNtwrt1804207G3t8Pn6NyzfyDw1/ActionUpdates/1000.4636.158133.95095059

get/Advertisers/{AccountSID}/ActionUpdates/{ActionUpdateId}

cURL

curl 'https://api.impact.com/Advertisers/<AccountSID>/ActionUpdates/1000.4636.158133.95095059' \
  -X GET \
  -u '<AccountSID>:<AuthToken>' \
  -H 'Accept: application/json'

200

An action update object.

{
  "Id": "1000.4636.158133.95095059",
  "ActionId": "1000.4636.158133",
  "CampaignId": 1000,
  "ActionTrackerId": 2240,
  "EventTypeId": "2240",
  "EventTypeName": "Sale",
  "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": "Sports",
  "Sku": "12345",
  "Quantity": "2",
  "CatalogName": "",
  "CatalogCategory": "",
  "CatalogDescription": "",
  "CatalogManufacturer": "",
  "CatalogOriginalFormatCategory": "",
  "CatalogSubCategory": "",
  "PayoutLevel": "ITEM",
  "DefaultPayoutRate": "2",
  "ContractId": "S-3240326",
  "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": "",
  "SharedId": "RT-19247423",
  "ActionUri": "/Advertisers/IRyMQiCNtwrt1804207G3t8Pn6NyzfyDw1/Actions/1000.4636.158133",
  "Uri": "/Advertisers/IRyMQiCNtwrt1804207G3t8Pn6NyzfyDw1/ActionUpdates/1000.4636.158133.95095059"
}