API Reference

List all action updates

Returns a list of the action updates your campaign has recorded. The action updates are returned by creation date, with the most recently created action updates appearing first.

The recommended way to use this resource is to retrieve a list of ActionUpdates based on the UpdateDate value—use StartDate and EndDate to specify a date range, and the endpoint will only return action updates that were last updated within that range.

Warning: 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.

Note: On 5 August 2024 these changes were implemented to ensure data integrity and optimize API performance:

  • Queries for Actions or ActionUpdates cannot have a StartDate exceeding 3 years in the past.
  • A query’s StartDate and EndDate cannot be more than 45 days apart.
  • If no StartDate and EndDate parameters are specified, only records for the past 7 days will be returned.
  • If StartDate is specified, EndDate must be specified as well, or the query will return an error.
  • The new default page size is 20,000 records per page when PageSize isn’t specified.
  • If specified, the smallest PageSize value is 2,000 records.
  • If the total record count exceeds 10 times the page size, an error message will prompt you to either adjust either the PageSize or the StartDate or EndDate, to ensure the response won’t contain more than 10 pages.

Parameters

CampaignId optional

Specify which campaign you wish to view action updates for.

StartDate optional

Filters out all action updates that have an UpdateDate value that is on or after the specified date. Can be sent in along with EndDate as a replacement for ActionDateStart.

EndDate optional

Filters out all action updates that have an UpdateDate value that is on or before the specified date. Can be sent in along with StartDate as a replacement for ActionDateEnd.

State optional

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

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.

ActionDateStart optional

Filters out all action updates that have an EventDate on or after this value.

ActionDateEnd optional

Filters out all action updates that have an EventDate on or before this value.

LockingDateStart optional

Filters out all action updates that have a LockingDate on or after this value. Can be sent in along with LockingDateStart as a replacement for ActionDateStart.

LockingDateEnd optional

Filters out all action updates that have a LockingDate on or before this value. Can be sent in along with LockingDateEnd as a replacement for ActionDateEnd.

Returns

An array of action updates objects up to a limit dictated by PageSize. Each entry in the array is a separate action updates object. If no actions meet the criteria, the resulting array will be empty. This request should never return an error.

Example request

curl 'https://api.impact.com/Mediapartners/<AccountSID>/ActionUpdates' \
  -X GET \
  -u '<AccountSID>:<AuthToken>' \
  -H 'Accept: application/json' \
  -d 'StartDate=2024-01-01T00:00:00Z' \
  -d 'EndDate=2024-01-31T00:00:00Z' \
  -G

Example response

{
  "@page": "1",
  ...
  "ActionUpdates": [
    {
      "Id": "1000.1234.56789.10111213",
      "ActionId": "1000.1234.56789",
      "CampaignId": "1000",
      "ActionTrackerId": "10000",
      "EventCode": "",
      "State": "PENDING",
      "StateDetail": "",
      "StateDetailDescription": "Action comes in DEFAULT and a locking date has not been set yet",
      "AdId": "123456",
      "ReportingState": "IR_BLANK",
      "DeltaPayout": "0.26",
      "DeltaAmount": "17.29",
      "Currency": "USD",
      "Category": "Sports",
      "Sku": "123ABC456",
      "Quantity": "1",
      "CatalogName": "",
      "CatalogCategory": "",
      "CatalogDescription": "",
      "CatalogManufacturer": "",
      "CatalogOriginalFormatCategory": "",
      "CatalogSubCategory": "",
      "UpdateDate": "2024-04-25T02:07:45-04:00",
      "LockingDate": "2024-05-16T00:00:00-04:00",
      "ClearingDate": "2024-05-16T00:00:00-04:00",
      "ActionDate": "2024-04-24T19:50:23-04:00",
      "Oid": "O987654",
      "SubId1": "Blog",
      "SubId2": "Website",
      "SubId3": "",
      "PaystubId": "116142",
      "ContractId": "S-7751552",
      "EventTypeId": "10000",
      "EventTypeName": "Sale",
      "PayoutLevel": "ORDER",
      "DefaultPayout": "5.00",
      "DefaultPayoutCurrency": "USD",
      "SharedId": "",
      "ActionUri": "/Mediapartners/<AccountSID>/Actions/1000.1234.56789",
      "Uri": "/Mediapartners/<AccountSID>/ActionUpdates/1000.1234.56789.10111213"
    },
    {
      ...
    }
  ]
}