List ads

Returns a list of all assets available to you.

Parameters

---

Type optional

Only returns assets that match the specified type. Possible enum values are:

• BANNER
• TEXT_LINK
• COUPON

---

CampaignId optional

Only returns assets from the specified campaign (program).

---

DealId optional

Only returns assets from the specified deal.

---

MobileReady optional

If true, only returns assets marked as mobile ready. If false, only returns assets not marked as mobile ready.

---

UpdatedDateStart optional

Filters for assets updated on or after the specified date. Can be used independently of UpdatedDateEnd.
Format YYYY-MM-DDTHH:MM:SSZ

---

UpdatedDateEnd optional

Filters for assets updated before and up to the specified date. Can be used independently of UpdatedDateStart.
Format YYYY-MM-DDTHH:MM:SSZ

---

PageSize optional

The number of records per page. Default is 100, maximum is 5000.

Returns

---

Returns an array of assets up to a limit dictated by PageSize. Each entry in the array is a separate asset. If no assets meet the criteria, the resulting array will be empty. This request should never return an error.

Example request

---

CURL

curl 'https://api.impact.com/Mediapartners/<AccountSID>/Ads' \
  -X GET \
  -u '<AccountSID>:<AuthToken>' \
  -H 'Accept: application/json' \
  -d 'Type=BANNER' \
  -d 'MobileReady=true' \
  -G

Example response

---

JSON

{
  "@page": "1",
  ...
  "Ads": [
    {
      "Id": "123456",
      "Name": "Acme Inc. Ad",
      "Description": "",
      "CampaignId": "1234",
      "CampaignName": "Acme Partner Program",
      "Type": "BANNER",
      "TrackingLink": "https://example.com/c/1299679/515236/8800",
      "LandingPageUrl": "http://www.example.com",
      "AdvertiserId": "9876543",
      "AdvertiserName": "Acme Inc.",
      "Code": "<a href=\"https://example.com/c/1299679/515236/8800\" target=\"_top\" id=\"515236\"><img src=\"//a.impactradius-go.com/display-ad/8800-515236\" border=\"0\" alt=\"\" width=\"442\" height=\"114\"/></a><img height=\"0\" width=\"0\" src=\"https://example.com/i/1299679/515236/8800\" style=\"position:absolute;visibility:hidden;\" border=\"0\" />",
      "IFrameCode": "<iframe id=\"$iradid\" src=\"//a.impactradius-go.com/gen-ad-code/1299679/515236/8800/\" width=\"442\" height=\"114\" scrolling=\"no\" frameborder=\"0\" marginheight=\"0\" marginwidth=\"0\"></iframe>",
      "Width": "442",
      "Height": "114",
      "CreativeUrl": "//a.impactradius-go.com/display-ad/8800-515236",
      "Labels": "",
      "AllowDeepLinking": "false",
      "MobileReady": "true",
      "Language": "ENGLISH",
      "StartDate": "2018-09-12T08:30:49-04:00",
      "EndDate": "",
      "Season": "",
      "TopSeller": "false",
      "SubjectLines": "",
      "FromAddresses": "",
      "UnsubscribeLink": "",
      "DealId": "",
      "DealName": "",
      "DealDescription": "",
      "DealState": "",
      "DealType": "",
      "DealScope": "",
      "DealProducts": [],
      "DealCategories": "",
      "DiscountType": "",
      "DiscountAmount": "",
      "DiscountCurrency": "",
      "DiscountPercent": "",
      "DiscountMaximumPercent": "",
      "DiscountPercentRangeStart": "",
      "DiscountPercentRangeEnd": "",
      "Gift": "",
      "RebateAmount": "",
      "RebateCurrency": "",
      "DealDefaultPromoCode": "",
      "MinimumPurchaseAmount": "",
      "MinimumPurchaseAmountCurrency": "",
      "MaximumSavingsAmount": "",
      "MaximumSavingsCurrency": "",
      "BogoBuyQuantity": "",
      "BogoBuyScope": "",
      "BogoBuyName": "",
      "BogoBuyImageUrl": "",
      "BogoGetQuantity": "",
      "BogoGetScope": "",
      "BogoGetDiscountType": "",
      "BogoGetName": "",
      "BogoGetImageUrl": "",
      "BogoGetDiscountAmount": "",
      "BogoGetDiscountCurrency": "",
      "BogoGetDiscountPercent": "",
      "PurchaseLimitQuantity": "",
      "DealStartDate": "",
      "DealEndDate": "",
      "Uri": "/Mediapartners/<AccountSID>/Ads/123456"	
    },
    {
      ...
    }
  ]
}

Note: The following properties are excluded from the response under certain conditions:

• Code and IFrameCode: Will not be returned when the asset type is COUPON.
• Code: Will also not be returned if the brand has limited the asset to iFrame only.