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 (in the code example, the request will retrieve all action updates that occurred in January 2021).
Parameters
CampaignId
required
CampaignId
requiredSpecify which campaign you wish to view action updates for.
StartDate
optional
StartDate
optionalFilters 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
EndDate
optionalFilters 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
State
optionalFilters 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
ActionDateStart
optionalFilters out all action updates that have an EventDate
on or after this value.
ActionDateEnd
optional
ActionDateEnd
optionalFilters out all action updates that have an EventDate
on or before this value.
LockingDateStart
optional
LockingDateStart
optionalFilters 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
LockingDateEnd
optionalFilters 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
. The maximum PageSize
for this endpoint is 20,000. 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/Advertisers/<AccountSID>/ActionUpdates' \
-X GET \
-u '<AccountSID>:<AuthToken>' \
-H 'Accept: application/json' \
-d 'CampaignId=1000' \
-d 'StartDate=2021-01-01T00:00:00Z' \
-d 'EndDate=2021-01-31T00:00:00Z'
Example response
{
"@page": "1",
...
"ActionUpdates": [
{
"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",
"SharedId": "",
"ActionUri": "/Advertisers/<AccountSid>/Actions/1000.4636.158133",
"Uri": "/Advertisers/<AccountSid>/ActionUpdates/1000.4636.158133.95095059"
},
{
...
}
]
}