API Reference
Start typing to search…

List ads

Returns a list of all ads available to you.

Parameters

Type optional

Only returns ads that match the specified type.

Possible enum values
BANNER
TEXT_LINK
COUPON

CampaignId optional

Only returns ads from the specified campaign (program).

DealId optional

Only returns ads from the specified deal.

MobileReady optional

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

Returns

Returns an array of ads up to a limit dictated by '@pagesize`. Each entry in the array is a separate ad. If no ads meet the criteria, the resulting array will be empty. This request should never return an error.

Example request

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

{
  "@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"	
    },
    {
      ...
    }
  ]
}