API Reference

Retrieve an ad

Retrieves the ad with the given ID.

Parameters

No parameters.

Returns

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

Example request

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

Example response

{
  "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": "false",
  "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"	
}