API Reference

Retrieve an ad

Retrieves the details of an existing ad. Requires you to pass the unique impact.com Ad Id for the ad.

Parameters

No parameters.

Returns

Returns an ad object if a valid identifier is provided. Returns an error for invalid identifiers.

Example Request

curl 'https://api.impact.com/Advertisers/<AccountSID>/Ads/892081' \
  -X GET \
  -u '<AccountSid>:<AuthToken>' \
  -H 'Accept: application/json'

Example Response

{
  "Id": "892081",
  "Name": "Summer Sale 2020 250x250",
  "Description": "Our best deals this summer creative.",
  "CampaignId": "1000",
  "CampaignName": "Acme Campaign",
  "AdType": "BANNER",
  "LandingPage": "http://www.test.com/6234652",
  "MobileFallbacks": {
        "ANDROID": "56789",
        "IOS": "12345"
   },
  "CustomAdServingUrl": "",
  "AdCodeTemplate": "",
  "IabAdUnit": "CUSTOM",
  "ThirdPartyServableAdCreativeHeight": "250",
  "ThirdPartyServableAdCreativeWidth": "250",
  "BannerAlternativeTag": "summersale",
  "LinkText": "",
  "CouponLinkName": "",
  "CouponAllowCustomPromoCode": "",
  "GetHtmlCodeType": "HTML_AND_IFRAME",
  "CustomisationCharge": "0.00",
  "Labels": "sale,US",
  "AllowDeepLinking": "true",
  "MobileReady": "true",
  "PhoneTracking": "false",
  "PromoCodeTracking": "false",
  "Language": "ENGLISH",
  "LimitedTimeStartDate": "2020-09-16T17:01:28-07:00",
  "LimitedTimeEndDate": "",
  "RestrictedMediaPartners": [],
  "RestrictedMediaPartnerGroups": ["Content"],
  "Season": "SUMMER",
  "TopSeller": "true",
  "DealId": "85433",
  "DealName": "Summer Sale 2020",
  "DealDescription": "The end of summer sale with great discounts and the best items",
  "DealState": "PENDING",
  "DealType": "GENERAL_SALE",
  "DealScope": "CATEGORY",
  "DealProducts": [],
  "DealCategories": "Legos,Dolls",
  "DiscountType": "PERCENT",
  "DiscountAmount": "",
  "DiscountCurrency": "",
  "DiscountPercent": "10",
  "DiscountMaximumPercent": "",
  "DiscountPercentRangeStart": "",
  "DiscountPercentRangeEnd": "",
  "Gift": "",
  "RebateAmount": "",
  "RebateCurrency": "",
  "DealDefaultPromoCode": "SUMMERSALE20",
  "MinimumPurchaseAmount": "10.00",
  "MinimumPurchaseAmountCurrency": "USD",
  "MaximumSavingsAmount": "100.00",
  "MaximumSavingsCurrency": "USD",
  "BogoBuyQuantity": "0",
  "BogoBuyScope": "",
  "BogoBuyName": "",
  "BogoBuyImageUrl": "",
  "BogoGetQuantity": "0",
  "BogoGetScope": "",
  "BogoGetDiscountType": "",
  "BogoGetName": "",
  "BogoGetImageUrl": "",
  "BogoGetDiscountAmount": "",
  "BogoGetDiscountCurrency": "",
  "BogoGetDiscountPercent": "",
  "PurchaseLimitQuantity": "0",
  "DealStartDate": "2020-09-17T00:00:00-07:00",
  "DealEndDate": "2020-09-30T00:00:00-07:00",
  "SynchAdsPromoCodes": "false",
  "DealRestrictedMediaPartners": [],
  "DealRestrictedMediaPartnerGroups": ["Content"],
  "Uri": "/Advertisers/<AccountSID>/Ads/892081"
}