Action Updates

List all action updates

get

Returns a list of action updates (a changelog of modifications) for the campaign. Action updates are returned by creation date, with the most recently created updates appearing first.

The recommended approach is to filter by StartDate and EndDate to retrieve updates within a specific range.

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 list 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 together with EndDate. Cannot be more than 3 years in the past, and the range cannot exceed 45 days.

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 together with StartDate.

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

Responses

200

An array of action update objects.

application/json

get/Advertisers/{AccountSID}/ActionUpdates

HTTPcURLJavaScriptPython

GET /Advertisers/{AccountSID}/ActionUpdates?CampaignId=1 HTTP/1.1
Host: api.impact.com
Authorization: Basic username:password
Accept: */*

200

An array of action update objects.

{
  "ActionUpdates": [
    {
      "Id": "1000.4636.158133.95095059",
      "ActionId": "1000.4636.158133",
      "State": "PENDING",
      "DeltaPayout": 0.88,
      "DeltaAmount": 21.99,
      "UpdateDate": "2020-09-10T10:51:23-07:00",
      "Uri": "/Advertisers/IRyMQiCNtwrt1804207G3t8Pn6NyzfyDw1/ActionUpdates/1000.4636.158133.95095059"
    }
  ]
}

Retrieve an action update

get

Retrieves the details for a specific update record using 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

Returns an action update object.

application/json

Represents a single modification event in an action's lifecycle. Acts as a changelog entry.

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

Statestring · enumOptional

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

Example: PENDINGPossible values:

DeltaPayoutnumberOptional

The change in the Payout value recorded by this update.

Example: 0.88

DeltaAmountnumberOptional

The change in the Amount (sale amount) value recorded by this update.

Example: 21.99

UpdateDatestring · date-timeOptional

Timestamp of when this update was recorded.

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

UristringOptional

Unique URI reference to this action update object.

Example: /Advertisers/IRyMQiCNtwrt1804207G3t8Pn6NyzfyDw1/ActionUpdates/1000.4636.158133.95095059

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

HTTPcURLJavaScriptPython

GET /Advertisers/{AccountSID}/ActionUpdates/{ActionUpdateId} HTTP/1.1
Host: api.impact.com
Authorization: Basic username:password
Accept: */*

200

Returns an action update object.

{
  "Id": "1000.4636.158133.95095059",
  "ActionId": "1000.4636.158133",
  "State": "PENDING",
  "DeltaPayout": 0.88,
  "DeltaAmount": 21.99,
  "UpdateDate": "2020-09-10T10:51:23-07:00",
  "Uri": "/Advertisers/IRyMQiCNtwrt1804207G3t8Pn6NyzfyDw1/ActionUpdates/1000.4636.158133.95095059"
}