Exception Lists

Endpoints for retrieving exception list details and items.

Retrieve an Exception List

get

Retrieves the details of an existing exception list using its unique ID. The ExceptionListId can be obtained from the Contracts API.

Path parameters

AccountSIDstringRequired

Unique identifier for the partner account.

ExceptionListIdstringRequired

The unique identifier for the exception list.

Responses

200

The exception list object.

application/json

IdstringOptional

Unique identifier for the exception list.

Example: 5001

NamestringOptional

Display name of the exception list.

Example: Wayne Tech SKU Exclusions

Statestring · enumOptional

The current state of the exception list.

Example: ACTIVEPossible values:

CampaignIdstringOptional

Unique identifier for the program this exception list applies to.

Example: 10306

Typestring · enumOptional

The matching basis for this exception list. CATEGORY matches against the conversion's product category value; SKU matches against the conversion's SKU or ProductId value.

Example: SKUPossible values:

CreatedDatestring · date-timeOptional

Date and time the exception list was created (ISO 8601).

Example: 2024-01-15T10:30:00-08:00

DeactivationDatestring · date-timeOptional

Date and time the exception list was deactivated (ISO 8601). Empty if the list is still active.

NumberOfItemsintegerOptional

The number of items in the exception list.

Example: 12

ItemsUristringOptional

API resource path for retrieving the items in this exception list.

Example: /Mediapartners/<AccountSID>/ExceptionLists/5001/Items

UristringOptional

Unique reference to the exception list object in the impact.com API.

Example: /Mediapartners/<AccountSID>/ExceptionLists/5001

get/Mediapartners/{AccountSID}/ExceptionLists/{ExceptionListId}

HTTPcURLJavaScriptPython

GET /Mediapartners/{AccountSID}/ExceptionLists/{ExceptionListId} HTTP/1.1
Host: api.impact.com
Accept: */*

200

The exception list object.

{
  "Id": "5001",
  "Name": "Wayne Tech SKU Exclusions",
  "State": "ACTIVE",
  "CampaignId": "10306",
  "Type": "SKU",
  "CreatedDate": "2024-01-15T10:30:00-08:00",
  "DeactivationDate": "",
  "NumberOfItems": 12,
  "ItemsUri": "/Mediapartners/<AccountSID>/ExceptionLists/5001/Items",
  "Uri": "/Mediapartners/<AccountSID>/ExceptionLists/5001"
}

List Exception List Items

get

Returns a list of all items in a specific exception list. Each item defines a product category or SKU value that triggers an alternate commission rate.

Path parameters

AccountSIDstringRequired

Unique identifier for the partner account.

ExceptionListIdstringRequired

The unique identifier for the exception list whose items are being retrieved.

Responses

200

A list of exception list item objects.

application/json

get/Mediapartners/{AccountSID}/ExceptionLists/{ExceptionListId}/Items

HTTPcURLJavaScriptPython

GET /Mediapartners/{AccountSID}/ExceptionLists/{ExceptionListId}/Items HTTP/1.1
Host: api.impact.com
Accept: */*

200

A list of exception list item objects.

{
  "ExceptionListItems": [
    {
      "Id": "1",
      "ListId": "5001",
      "Name": "Batsuit SKU",
      "Value": "BS-KVL-01",
      "MatchMode": "EQ",
      "CreatedDate": "2024-01-15T10:30:00-08:00",
      "Uri": "/Mediapartners/<AccountSID>/ExceptionLists/5001/Items/1"
    }
  ]
}