Actions

List all actions

get

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

Authorizations

AuthorizationstringRequired

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

Path parameters

AccountSIDstringRequired

Your unique account identifier.

Example: IRyMQiCNtwrt1804207G3t8Pn6NyzfyDw1

Query parameters

CampaignIdstringRequired

The ID of the campaign (program) to list actions for.

Example: 1000

Statestring · enumOptional

Filters actions based on their current state.

Example: PENDINGPossible values:

StartDatestring · date-timeOptional

Filters for actions with a last updated date 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 with EndDate cannot exceed 45 days.

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

EndDatestring · date-timeOptional

Filters for actions with a last updated date 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 objects.

application/json

get/Advertisers/{AccountSID}/Actions

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

200

An array of action objects.

{
  "Actions": [
    {
      "Id": "1000.4636.158133",
      "CampaignId": 1000,
      "CampaignName": "Acme Campaign",
      "ActionTrackerId": 2240,
      "ActionTrackerName": "Sale",
      "MediaPartnerId": 10000,
      "MediaPartnerName": "Acme Partner",
      "State": "PENDING",
      "AdId": 506720,
      "Payout": 0.88,
      "Amount": 21.99,
      "Currency": "USD",
      "EventDate": "2020-09-10T10:42:38-07:00",
      "Oid": "9217374917472",
      "CustomerId": "BCZ2WVSH674563PDPYOTM3AXDQ",
      "Uri": "/Advertisers/IRyMQiCNtwrt1804207G3t8Pn6NyzfyDw1/Actions/1000.4636.158133"
    }
  ]
}

Update an action or item

put

Updates the specified action by setting the values of the parameters passed. Use this endpoint to update high-level action details such as CustomerStatus.

The action can be identified either by ActionId, or by the combination of ActionTrackerId and OrderId.

Note: impact.com allows a maximum of 1,000 modifications per action.

Authorizations

AuthorizationstringRequired

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

Path parameters

AccountSIDstringRequired

Your unique account identifier.

Body

ActionIdstringOptional

Unique identifier for the action. Required unless using ActionTrackerId and OrderId together.

Example: 1000.4636.158133

ActionTrackerIdintegerOptional

Unique identifier for the action tracker (event type). Required with OrderId if ActionId is not used.

Example: 2240

OrderIdstringOptional

Your unique order identifier. Required with ActionTrackerId if ActionId is not used.

Example: 9217374917472

DispositionCodestringOptional

Submit ORDER_UPDATE as the default value for updating an action. Custom disposition codes may also be used if configured.

Default: ORDER_UPDATEExample: ORDER_UPDATE

CustomerStatusstringOptional

A new custom status for the customer associated with the action (e.g., NEW, EXISTING).

Example: NEW

SkustringOptional

The SKU of the line item to update. For bulk updates use indexed params (Sku, Sku2, Sku3, etc.).

Example: 12345

QuantityintegerOptional

The new absolute quantity for the item. For bulk updates use indexed params (Quantity, Quantity2, etc.).

Example: 2

AmountnumberOptional

The new total sale amount for the order or item. Setting to 0 on a tracked action with a non-zero amount will reverse the action.

Example: 19.99

ReasonstringOptional

Required. A valid reason code for the modification. Default reason codes: ORDER_UPDATE, ITEM_RETURNED, CONS_FRAUD, CONS_ERROR, ORDER_ERROR, PUB_ACT_DISPUTE, ADV_ACT_DISPUTE, NOT_COMPLIANCE_TERMS, ITEM_OUT_OF_STOCK, TEST_ACTION, PARTNER_NOT_ACTIVE, CREDITED_DIFFERENT_MP, OTHER.

Example: ORDER_UPDATE

Responses

200

Request queued successfully.

application/json

Returned when a modification or reversal request has been accepted and queued for processing.

StatusstringOptional

Indicates the status of the request. A successful submission returns QUEUED.

Example: QUEUED

QueuedUristringOptional

The URI of the API submission record, which can be used to track the status of the queued request.

Example: /Advertisers/IRyMQiCNtwrt1804207G3t8Pn6NyzfyDw1/APISubmissions/A-4632dba3-2211-4615-a62d-6e121ddcdfa1

put/Advertisers/{AccountSID}/Actions

PUT /Advertisers/{AccountSID}/Actions HTTP/1.1
Host: api.impact.com
Authorization: Basic username:password
Content-Type: application/x-www-form-urlencoded
Accept: */*
Content-Length: 202

"ActionId='1000.4636.158133'&ActionTrackerId=2240&OrderId='9217374917472'&DispositionCode='ORDER_UPDATE'&CustomerStatus='NEW'&Sku='12345'&Quantity=2&Amount=19.99&Reason='ORDER_UPDATE'"

200

Request queued successfully.

{
  "Status": "QUEUED",
  "QueuedUri": "/Advertisers/IRyMQiCNtwrt1804207G3t8Pn6NyzfyDw1/APISubmissions/A-4632dba3-2211-4615-a62d-6e121ddcdfa1"
}

Reverse an action

delete

Reverses an action, cancelling any pending payouts to partners.

The action can be identified either by ActionId, or by the combination of ActionTrackerId and OrderId.

Authorizations

AuthorizationstringRequired

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

Path parameters

AccountSIDstringRequired

Your unique account identifier.

Body

ActionIdstringOptional

Unique identifier for the action to reverse. Required unless using ActionTrackerId and OrderId together.

Example: 1000.4636.158133

ActionTrackerIdintegerOptional

Unique identifier for the action tracker (event type). Required with OrderId if ActionId is not used.

Example: 2240

OrderIdstringOptional

Your unique order identifier. Required with ActionTrackerId if ActionId is not used.

Example: 9217374917472

DispositionCodestring · enumRequired

Required. A valid code explaining the reason for the reversal.

Example: ITEM_RETURNEDPossible values:

Responses

200

Reversal queued successfully.

application/json

Returned when a modification or reversal request has been accepted and queued for processing.

StatusstringOptional

Indicates the status of the request. A successful submission returns QUEUED.

Example: QUEUED

QueuedUristringOptional

The URI of the API submission record, which can be used to track the status of the queued request.

Example: /Advertisers/IRyMQiCNtwrt1804207G3t8Pn6NyzfyDw1/APISubmissions/A-4632dba3-2211-4615-a62d-6e121ddcdfa1

delete/Advertisers/{AccountSID}/Actions

DELETE /Advertisers/{AccountSID}/Actions HTTP/1.1
Host: api.impact.com
Authorization: Basic username:password
Content-Type: application/x-www-form-urlencoded
Accept: */*
Content-Length: 114

"ActionId='1000.4636.158133'&ActionTrackerId=2240&OrderId='9217374917472'&DispositionCode='ITEM_RETURNED'"

200

Reversal queued successfully.

{
  "Status": "QUEUED",
  "QueuedUri": "/Advertisers/IRyMQiCNtwrt1804207G3t8Pn6NyzfyDw1/APISubmissions/A-4632dba3-2211-4615-a62d-6e121ddcdfa1"
}

Retrieve an action

get

Retrieves the details of an existing action using its unique ActionId.

Authorizations

AuthorizationstringRequired

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

Path parameters

AccountSIDstringRequired

Your unique account identifier.

ActionIdstringRequired

The unique impact.com identifier for the action.

Example: 1000.4636.158133

Responses

200

Returns an action object.

application/json

Represents a conversion event credited to a partner.

IdstringOptional

Unique impact.com identifier for the action.

Example: 1000.4636.158133

CampaignIdintegerOptional

Unique identifier for the campaign (program) this action belongs to.

Example: 1000

CampaignNamestringOptional

Display name of the campaign.

Example: Acme Campaign

ActionTrackerIdintegerOptional

Unique identifier for the action tracker (event type) that recorded this action.

Example: 2240

ActionTrackerNamestringOptional

Display name of the action tracker (event type).

Example: Sale

MediaPartnerIdintegerOptional

Unique identifier for the partner credited for this action.

Example: 10000

MediaPartnerNamestringOptional

Display name of the credited partner.

Example: Acme Partner

Statestring · enumOptional

Current state of the action.

PENDING: Awaiting locking date or manual approval. Actions that have been modified also carry this state.
APPROVED: Reached its locking date or was manually approved. Will pay out the partner. No further modifications permitted.
REVERSED: Was reversed and will not pay out the partner.

Example: PENDINGPossible values:

AdIdintegerOptional

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

Example: 506720

PayoutnumberOptional

Commission amount to be paid to the partner, in the currency specified by the Currency field.

Example: 0.88

AmountnumberOptional

Revenue amount associated with the action (sale amount), in the currency specified by the Currency field.

Example: 21.99

CurrencystringOptional

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

Example: USD

EventDatestring · date-timeOptional

Timestamp of when the conversion event occurred.

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

OidstringOptional

Your unique identifier for the order associated with this action.

Example: 9217374917472

CustomerIdstringOptional

Your unique, non-PII identifier for the customer who made the conversion.

Example: BCZ2WVSH674563PDPYOTM3AXDQ

UristringOptional

Unique URI reference to this action object.

Example: /Advertisers/IRyMQiCNtwrt1804207G3t8Pn6NyzfyDw1/Actions/1000.4636.158133

get/Advertisers/{AccountSID}/Actions/{ActionId}

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

200

Returns an action object.

{
  "Id": "1000.4636.158133",
  "CampaignId": 1000,
  "CampaignName": "Acme Campaign",
  "ActionTrackerId": 2240,
  "ActionTrackerName": "Sale",
  "MediaPartnerId": 10000,
  "MediaPartnerName": "Acme Partner",
  "State": "PENDING",
  "AdId": 506720,
  "Payout": 0.88,
  "Amount": 21.99,
  "Currency": "USD",
  "EventDate": "2020-09-10T10:42:38-07:00",
  "Oid": "9217374917472",
  "CustomerId": "BCZ2WVSH674563PDPYOTM3AXDQ",
  "Uri": "/Advertisers/IRyMQiCNtwrt1804207G3t8Pn6NyzfyDw1/Actions/1000.4636.158133"
}

List all items for an action

get

Returns a list of the items within the specified action. The items are returned in the order they were originally recorded. All actions contain at least one item.

Authorizations

AuthorizationstringRequired

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

Path parameters

AccountSIDstringRequired

Your unique account identifier.

ActionIdstringRequired

The unique impact.com identifier for the action.

Example: 1000.4636.158133

Responses

200

An array of action item objects.

application/json

get/Advertisers/{AccountSID}/Actions/{ActionId}/Items

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

200

An array of action item objects.

{
  "ActionItems": [
    {
      "Sku": "12345",
      "ItemName": "Acme Tennis Balls (One Dozen)",
      "Category": "Sports",
      "Quantity": "2",
      "SaleAmount": "19.27",
      "Payout": 0.77,
      "Uri": "/Advertisers/IRyMQiCNtwrt1804207G3t8Pn6NyzfyDw1/Actions/1000.4636.158133/Items/12345"
    }
  ]
}

Retrieve an item from an action

get

Retrieves the details of a specific line item within an action, identified by ActionId and SKU.

Authorizations

AuthorizationstringRequired

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

Path parameters

AccountSIDstringRequired

Your unique account identifier.

ActionIdstringRequired

The unique impact.com identifier for the action.

Example: 1000.4636.158133

SkustringRequired

The SKU or product identifier for the item.

Example: 12345

Responses

200

Returns an action item object.

application/json

Represents a single line item within an action.

SkustringOptional

Stock-keeping unit (SKU) or product identifier for the item.

Example: 12345

ItemNamestringOptional

Display name of the product.

Example: Acme Tennis Balls (One Dozen)

CategorystringOptional

Product category for the item.

Example: Sports

QuantitystringOptional

Number of units of this product in the order.

Example: 2

SaleAmountstringOptional

Revenue amount for this line item.

Example: 19.27

PayoutnumberOptional

Commission amount for this line item.

Example: 0.77

UristringOptional

Unique URI reference to this action item object.

Example: /Advertisers/IRyMQiCNtwrt1804207G3t8Pn6NyzfyDw1/Actions/1000.4636.158133/Items/12345

get/Advertisers/{AccountSID}/Actions/{ActionId}/Items/{Sku}

GET /Advertisers/{AccountSID}/Actions/{ActionId}/Items/{Sku} HTTP/1.1
Host: api.impact.com
Authorization: Basic username:password
Accept: */*

200

Returns an action item object.

{
  "Sku": "12345",
  "ItemName": "Acme Tennis Balls (One Dozen)",
  "Category": "Sports",
  "Quantity": "2",
  "SaleAmount": "19.27",
  "Payout": 0.77,
  "Uri": "/Advertisers/IRyMQiCNtwrt1804207G3t8Pn6NyzfyDw1/Actions/1000.4636.158133/Items/12345"
}

PreviousActions NextAction Updates

Last updated 1 month ago