Returns a list of the actions your campaign has recorded. Actions are returned by creation date, with the most recently created actions appearing first.
Note: On 5 August 2024 these changes were implemented to ensure data integrity and optimize API performance:
- Queries for
Actions
orActionUpdates
cannot have aStartDate
exceeding 3 years in the past. - A query’s
StartDate
andEndDate
cannot be more than 45 days apart. - If no
StartDate
andEndDate
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 theStartDate
orEndDate
, to ensure the response won’t contain more than 10 pages.
Parameters
CampaignId
required
CampaignId
requiredAppend this value as a query string parameter to list all actions for a given campaign (or program).
State
optional
State
optionalFilters all actions based on their state value.
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. |
StartDate
optional
StartDate
optionalFilters out all actions that have a last updated date on or after this value. Can be sent in along with EndDate
to express a range.
Note: State transitions (e.g., from Pending to Approved) are not considered updates and will not be filtered by StartDate
. We recommend using LockingDateStart
or referencing the LockingDate
value returned in the action object.
EndDate
optional
EndDate
optionalFilters out all actions that have a last updated date on or before this value. Can be sent in along with StartDate
to express a range. If using EndDate
, you must also use StartDate
.
Note: State transitions (e.g., from Pending to Approved) are not considered updates and will not be filtered by EndDate
. We recommend using LockingDateEnd
or referencing the LockingDate
value returned in the action object.
ActionDateStart
optional
ActionDateStart
optionalFilters out all actions that have an EventDate
on or after this value. Can be sent in along with ActionDateEnd
to express a range. Can be sent in as a replacement for StartDate
or LockingDateStart
.
ActionDateEnd
optional
ActionDateEnd
optionalFilters out all actions that have an EventDate
on or before this value. Can be sent in along with ActionDateStart
to express a range. Can be sent in as a replacement for EndDate
or LockingDateEnd
. If using ActionDateEnd
, you must also use ActionDateStart
.
LockingDateStart
optional
LockingDateStart
optionalFilters out all actions that have a LockingDate
on or after this value. Can be sent in along with LockingDateEnd
to express a range. Can be sent in as a replacement for StartDate
or ActionDateStart
.
LockingDateEnd
optional
LockingDateEnd
optionalFilters out all actions that have a LockingDate
on or before this value. Can be sent in along with LockingDateStart
to express a range. Can be sent in as a replacement for EndDate
or ActionDateEnd
. If using LockingDateEnd
, you must also use LockingDateStart
.
Returns
An array of action 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 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>/Actions' \
-X GET \
-u '<AccountSID>:<AuthToken>' \
-H 'Accept: application/json' \
-d 'CampaignId=1017' \
-d 'ActionDateStart=2020-09-01T00:00:00Z' \
-d 'ActionDateEnd=2020-09-05T00:00:00Z'
Example response
{
"@page": "1",
...,
"Actions": [
{
"Id": "1000.4636.158133",
"CampaignId": "1000",
"CampaignName": "Acme Campaign",
"ActionTrackerId": "2240",
"ActionTrackerName": "Sale",
"EventCode": "",
"MediaPartnerId": "39787",
"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"
},
{...}
]
}