Ads | Integrations Hub

Endpoints for retrieving ads and their associated code or tracking links.

List Ads

get

Returns a list of all ads available to you.

Path parameters

AccountSIDstringRequired

Unique identifier for the partner account.

Query parameters

Typestring · enumOptional

Filters ads by type.

Possible values:

CampaignIdintegerOptional

Filters ads by the campaign (brand program) they belong to.

DealIdintegerOptional

Filters ads by the deal associated with them.

MobileReadybooleanOptional

Filters ads by whether they are optimized for mobile devices.

UpdatedDateStartstring · date-timeOptional

Filters for ads updated on or after this date.

UpdatedDateEndstring · date-timeOptional

Filters for ads updated on or before this date.

Responses

200

A list of ad objects.

application/json

get/Mediapartners/{AccountSID}/Ads

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

200

A list of ad objects.

{
  "Ads": [
    {
      "Id": "3061348",
      "Name": "Capsule Home Spring Promo",
      "Description": "Spring promotion for the Capsule Home product line. Seasonal pricing on minimalist storage solutions.",
      "CampaignId": "27154",
      "CampaignName": "Capsule Corp",
      "Type": "BANNER",
      "TrackingLink": "https://capsulecorp.pxf.io/c/1924609/3061348/27154",
      "LandingPageUrl": "https://www.capsulecorp.holdings/spring",
      "AdvertiserId": "1804207",
      "AdvertiserName": "Acme Corporation",
      "Code": "<a href=\"https://capsulecorp.pxf.io/c/1924609/3061348/27154\" target=\"_top\" id=\"3061348\"><img src=\"//a.impactradius-go.com/display-ad/27154-3061348\" border=\"0\" alt=\"\" width=\"674\" height=\"678\"/></a>",
      "IFrameCode": "<iframe id=\"iframe_414\" src=\"//a.impactradius-go.com/gen-ad-code/1924609/3061348/27154/\" width=\"674\" height=\"678\" scrolling=\"no\" frameborder=\"0\" marginheight=\"0\" marginwidth=\"0\"></iframe>",
      "Width": "674",
      "Height": "678",
      "CreativeUrl": "//a.impactradius-go.com/display-ad/27154-3061348",
      "Labels": "",
      "AllowDeepLinking": "true",
      "MobileReady": "true",
      "Language": "ENGLISH",
      "StartDate": "2026-03-01T00:00:00-08:00",
      "EndDate": "2026-05-31T23:59:59-07:00",
      "Season": "SPRING",
      "TopSeller": "false",
      "SubjectLines": "",
      "FromAddresses": "",
      "UnsubscribeLink": "",
      "DealId": "92812",
      "DealName": "Capsule Home Spring Sale",
      "DealDescription": "25% off all Capsule Home products for spring.",
      "DealState": "ACTIVE",
      "DealType": "GENERAL_SALE",
      "DealScope": "ENTIRE_STORE",
      "DealPublic": "true",
      "DealProducts": [
        {
          "ProductName": "Capsule Storage Box",
          "ProductImageURL": "https://www.capsulecorp.holdings/products/storage.jpg",
          "ProductBeforePriceAmount": 100,
          "ProductBeforePriceCurrency": "USD",
          "ProductAfterPriceAmount": 75,
          "ProductAfterPriceCurrency": "USD"
        }
      ],
      "DealCategories": "",
      "DiscountType": "PERCENT",
      "DiscountAmount": "",
      "DiscountCurrency": "",
      "DiscountPercent": 25,
      "DiscountMaximumPercent": "",
      "DiscountPercentRangeStart": "",
      "DiscountPercentRangeEnd": "",
      "Gift": "",
      "RebateAmount": "",
      "RebateCurrency": "",
      "DealDefaultPromoCode": "SPRING25",
      "MinimumPurchaseAmount": 50,
      "MinimumPurchaseAmountCurrency": "USD",
      "MaximumSavingsAmount": 100,
      "MaximumSavingsCurrency": "USD",
      "BogoBuyQuantity": "",
      "BogoBuyScope": "",
      "BogoBuyName": "",
      "BogoBuyImageUrl": "",
      "BogoGetQuantity": "",
      "BogoGetScope": "",
      "BogoGetDiscountType": "",
      "BogoGetName": "",
      "BogoGetImageUrl": "",
      "BogoGetDiscountAmount": "",
      "BogoGetDiscountCurrency": "",
      "BogoGetDiscountPercent": "",
      "PurchaseLimitQuantity": "",
      "DealStartDate": "2026-03-01T00:00:00-08:00",
      "DealEndDate": "2026-05-31T23:59:59-07:00",
      "DealDateCreated": "",
      "DealDateLastUpdated": "",
      "Uri": "/Mediapartners/<AccountSID>/Ads/3061348"
    }
  ]
}

Retrieve an Ad

get

Retrieves the details of an existing ad using its unique ID.

Path parameters

AccountSIDstringRequired

Unique identifier for the partner account.

IdstringRequired

Unique identifier for the ad.

Responses

200

The ad object.

application/json

IdstringOptional

Unique identifier for the ad (the impact.com Ad ID).

Example: 3061348

NamestringOptional

Display name of the ad.

Example: Capsule Home Spring Promo

DescriptionstringOptional

Additional information about the ad, visible to partners.

Example: Spring promotion for the Capsule Home product line. Seasonal pricing on minimalist storage solutions.

CampaignIdintegerOptional

Unique identifier for the brand's program (campaign) that the ad is associated with.

Example: 27154

CampaignNamestringOptional

Display name of the brand's program (campaign) that the ad is associated with.

Example: Capsule Corp

Typestring · enumOptional

The kind of ad.

Example: BANNERPossible values:

TrackingLinkstring · uriOptional

The ad's impact.com tracking link, unique to your partner account.

Example: https://capsulecorp.pxf.io/c/1924609/3061348/27154

LandingPageUrlstring · uriOptional

The URL the tracking link redirects to (the brand's landing page).

Example: https://www.capsulecorp.holdings/spring

AdvertiserIdintegerOptional

Unique identifier assigned by impact.com to the brand's advertiser account.

Example: 1804207

AdvertiserNamestringOptional

Display name of the brand in impact.com.

Example: Acme Corporation

CodestringOptional

The ad's HTML code with the tracking link embedded. Use the /Code endpoint to retrieve this with optional tracking parameters.

Example:

<a href="https://capsulecorp.pxf.io/c/1924609/3061348/27154" target="_top" id="3061348"><img src="//a.impactradius-go.com/display-ad/27154-3061348" border="0" alt="" width="674" height="678"/></a>

IFrameCodestringOptional

The ad's iframe code. Use the /IFrameCode endpoint to retrieve this with optional tracking parameters.

Example:

<iframe id="iframe_414" src="//a.impactradius-go.com/gen-ad-code/1924609/3061348/27154/" width="674" height="678" scrolling="no" frameborder="0" marginheight="0" marginwidth="0"></iframe>

WidthintegerOptional

For image ads, the width of the ad image in pixels.

Example: 674

HeightintegerOptional

For image ads, the height of the ad image in pixels.

Example: 678

CreativeUrlstringOptional

Direct URL to the ad's creative asset (image, etc.).

Example: //a.impactradius-go.com/display-ad/27154-3061348

LabelsstringOptional

Labels assigned to the ad by the brand.

AllowDeepLinkingbooleanOptional

Whether the ad allows deep linking. If true, you can override the landing page URL via the landingPage parameter. If false, the landing page cannot be changed.

Example: true

MobileReadybooleanOptional

Whether the ad is optimized for mobile devices.

Example: true

Languagestring · enumOptional

The language the ad is hosted in.

Example: ENGLISHPossible values:

StartDatestring · date-timeOptional

The date and time the ad becomes active (ISO 8601). For ads without a start date, this is the date it was added to impact.com.

Example: 2026-03-01T00:00:00-08:00

EndDatestring · date-timeOptional

The date and time the ad expires (ISO 8601). Empty if the ad has no end date.

Example: 2026-05-31T23:59:59-07:00

Seasonstring · enumOptional

The seasonal promotional theme of the ad, if applicable.

Example: SPRINGPossible values:

TopSellerbooleanOptional

Whether the ad promotes a top-selling item.

Example: false

SubjectLinesstringOptional

For email ads, the subject line of the email.

FromAddressesstringOptional

For email ads, the sender address of the email.

UnsubscribeLinkstring · uriOptional

For email ads, the unsubscribe link included in the email.

DealIdintegerOptional

Unique identifier for the deal associated with the ad.

Example: 92812

DealNamestringOptional

Display name of the deal associated with the ad.

Example: Capsule Home Spring Sale

DealDescriptionstringOptional

Additional information about the deal associated with the ad.

Example: 25% off all Capsule Home products for spring.

DealStatestring · enumOptional

The current state of the deal associated with the ad.

Example: ACTIVEPossible values:

DealTypestring · enumOptional

How the deal is applied to the items in the ad.

Example: GENERAL_SALEPossible values:

DealScopestring · enumOptional

The scope of the deal — whether it applies to a specific product, category, or the entire store.

Example: ENTIRE_STOREPossible values:

DealPublicbooleanOptional

Whether the deal associated with the ad is publicly visible.

Example: true

DealCategoriesstringOptional

If DealScope is CATEGORY, a comma-separated list of product categories the deal applies to.

DiscountTypestring · enumOptional

The type of discount applied when the deal is activated.

Example: PERCENTPossible values:

DiscountAmountnumber · decimalOptional

If DiscountType is FIXED, the fixed discount amount.

DiscountCurrencystringOptional

If DiscountType is FIXED, the ISO 4217 currency code for DiscountAmount.

DiscountPercentnumber · floatOptional

If DiscountType is PERCENT, the discount percentage.

Example: 25

DiscountMaximumPercentnumber · floatOptional

If DiscountType is PERCENT_MAXIMUM, the maximum discount percentage a customer can receive.

DiscountPercentRangeStartnumber · floatOptional

If DiscountType is PERCENT_RANGE, the lowest discount percentage a customer can receive.

DiscountPercentRangeEndnumber · floatOptional

If DiscountType is PERCENT_RANGE, the highest discount percentage a customer can receive.

GiftstringOptional

If DealType is GIFT_WITH_PURCHASE, the name of the product to be gifted.

RebateAmountnumber · decimalOptional

If DealType is REBATE, the rebate amount.

RebateCurrencystringOptional

If DealType is REBATE, the ISO 4217 currency code for RebateAmount.

DealDefaultPromoCodestringOptional

The default promo code for the associated deal.

Example: SPRING25

MinimumPurchaseAmountnumber · decimalOptional

The minimum spend required before the deal is applied.

Example: 50

MinimumPurchaseAmountCurrencystringOptional

ISO 4217 currency code for MinimumPurchaseAmount.

Example: USD

MaximumSavingsAmountnumber · decimalOptional

The maximum amount a customer can save when the deal is applied.

Example: 100

MaximumSavingsCurrencystringOptional

ISO 4217 currency code for MaximumSavingsAmount.

Example: USD

BogoBuyQuantityintegerOptional

If DealType is BOGO, the number of 'buy' items required to activate the deal.

BogoBuyScopestring · enumOptional

If DealType is BOGO, the scope of the 'buy' items.

Possible values:

BogoBuyNamestringOptional

If DealType is BOGO, the name of the 'buy' item(s).

BogoBuyImageUrlstring · uriOptional

If DealType is BOGO, the URL to the 'buy' product's image.

BogoGetQuantityintegerOptional

If DealType is BOGO, the number of 'get' items the customer receives a discount on.

BogoGetScopestring · enumOptional

If DealType is BOGO, the scope of the 'get' items.

Possible values:

BogoGetDiscountTypestring · enumOptional

If DealType is BOGO, the type of discount applied to the 'get' items.

Possible values:

BogoGetNamestringOptional

If DealType is BOGO, the name of the 'get' item(s).

BogoGetImageUrlstring · uriOptional

If DealType is BOGO, the URL to the 'get' product's image.

BogoGetDiscountAmountnumber · decimalOptional

If BogoGetDiscountType is AMOUNT, the fixed discount amount taken off the 'get' item's price.

BogoGetDiscountCurrencystringOptional

If BogoGetDiscountType is AMOUNT, the ISO 4217 currency code for BogoGetDiscountAmount.

BogoGetDiscountPercentnumber · floatOptional

If BogoGetDiscountType is PERCENT, the discount percentage taken off the 'get' item's price.

PurchaseLimitQuantityintegerOptional

If DealType is BOGO, the maximum quantity of 'buy' items a customer can purchase at once. A value of 0 means no limit.

DealStartDatestring · date-timeOptional

The date and time the deal begins (ISO 8601).

Example: 2026-03-01T00:00:00-08:00

DealEndDatestring · date-timeOptional

The date and time the deal ends (ISO 8601).

Example: 2026-05-31T23:59:59-07:00

DealDateCreatedstring · date-timeOptional

The date and time the deal was created (ISO 8601).

DealDateLastUpdatedstring · date-timeOptional

The date and time the deal was last updated (ISO 8601).

UristringOptional

Unique reference to the ad object in the impact.com API.

Example: /Mediapartners/<AccountSID>/Ads/3061348

get/Mediapartners/{AccountSID}/Ads/{Id}

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

200

The ad object.

{
  "Id": "3061348",
  "Name": "Capsule Home Spring Promo",
  "Description": "Spring promotion for the Capsule Home product line. Seasonal pricing on minimalist storage solutions.",
  "CampaignId": "27154",
  "CampaignName": "Capsule Corp",
  "Type": "BANNER",
  "TrackingLink": "https://capsulecorp.pxf.io/c/1924609/3061348/27154",
  "LandingPageUrl": "https://www.capsulecorp.holdings/spring",
  "AdvertiserId": "1804207",
  "AdvertiserName": "Acme Corporation",
  "Code": "<a href=\"https://capsulecorp.pxf.io/c/1924609/3061348/27154\" target=\"_top\" id=\"3061348\"><img src=\"//a.impactradius-go.com/display-ad/27154-3061348\" border=\"0\" alt=\"\" width=\"674\" height=\"678\"/></a>",
  "IFrameCode": "<iframe id=\"iframe_414\" src=\"//a.impactradius-go.com/gen-ad-code/1924609/3061348/27154/\" width=\"674\" height=\"678\" scrolling=\"no\" frameborder=\"0\" marginheight=\"0\" marginwidth=\"0\"></iframe>",
  "Width": "674",
  "Height": "678",
  "CreativeUrl": "//a.impactradius-go.com/display-ad/27154-3061348",
  "Labels": "",
  "AllowDeepLinking": "true",
  "MobileReady": "true",
  "Language": "ENGLISH",
  "StartDate": "2026-03-01T00:00:00-08:00",
  "EndDate": "2026-05-31T23:59:59-07:00",
  "Season": "SPRING",
  "TopSeller": "false",
  "SubjectLines": "",
  "FromAddresses": "",
  "UnsubscribeLink": "",
  "DealId": "92812",
  "DealName": "Capsule Home Spring Sale",
  "DealDescription": "25% off all Capsule Home products for spring.",
  "DealState": "ACTIVE",
  "DealType": "GENERAL_SALE",
  "DealScope": "ENTIRE_STORE",
  "DealPublic": "true",
  "DealProducts": [
    {
      "ProductName": "Capsule Storage Box",
      "ProductImageURL": "https://www.capsulecorp.holdings/products/storage.jpg",
      "ProductBeforePriceAmount": 100,
      "ProductBeforePriceCurrency": "USD",
      "ProductAfterPriceAmount": 75,
      "ProductAfterPriceCurrency": "USD"
    }
  ],
  "DealCategories": "",
  "DiscountType": "PERCENT",
  "DiscountAmount": "",
  "DiscountCurrency": "",
  "DiscountPercent": 25,
  "DiscountMaximumPercent": "",
  "DiscountPercentRangeStart": "",
  "DiscountPercentRangeEnd": "",
  "Gift": "",
  "RebateAmount": "",
  "RebateCurrency": "",
  "DealDefaultPromoCode": "SPRING25",
  "MinimumPurchaseAmount": 50,
  "MinimumPurchaseAmountCurrency": "USD",
  "MaximumSavingsAmount": 100,
  "MaximumSavingsCurrency": "USD",
  "BogoBuyQuantity": "",
  "BogoBuyScope": "",
  "BogoBuyName": "",
  "BogoBuyImageUrl": "",
  "BogoGetQuantity": "",
  "BogoGetScope": "",
  "BogoGetDiscountType": "",
  "BogoGetName": "",
  "BogoGetImageUrl": "",
  "BogoGetDiscountAmount": "",
  "BogoGetDiscountCurrency": "",
  "BogoGetDiscountPercent": "",
  "PurchaseLimitQuantity": "",
  "DealStartDate": "2026-03-01T00:00:00-08:00",
  "DealEndDate": "2026-05-31T23:59:59-07:00",
  "DealDateCreated": "",
  "DealDateLastUpdated": "",
  "Uri": "/Mediapartners/<AccountSID>/Ads/3061348"
}

Retrieve an Ad's Code

get

Retrieves the HTML code of an existing ad, with optional tracking parameters appended to the tracking link.

Path parameters

AccountSIDstringRequired

Unique identifier for the partner account.

IdstringRequired

Unique identifier for the ad.

Query parameters

subId1stringOptional

Appends the submitted value as subId1= to the tracking link. Must be URL encoded.

subId2stringOptional

Appends the submitted value as subId2= to the tracking link. Must be URL encoded.

subId3stringOptional

Appends the submitted value as subId3= to the tracking link. Must be URL encoded.

sharedIdstringOptional

Appends the submitted value as sharedId= to the tracking link. Must be URL encoded.

landingPagestring · uriOptional

Overrides the ad's landing page URL if the ad allows deep linking. Must be URL encoded.

Responses

200

The ad's HTML code.

application/json

CodestringOptional

The ad's HTML code with the tracking link embedded.

Example:

<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>

UristringOptional

Unique reference to this resource in the impact.com API.

Example: /Mediapartners/<AccountSID>/Ads/123456/Code

get/Mediapartners/{AccountSID}/Ads/{Id}/Code

GET /Mediapartners/{AccountSID}/Ads/{Id}/Code HTTP/1.1
Host: api.impact.com
Accept: */*

200

The ad's HTML code.

{
  "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>",
  "Uri": "/Mediapartners/<AccountSID>/Ads/123456/Code"
}

Retrieve an Ad's IFrame Code

get

Retrieves the inline frame (iframe) code for an existing ad, with optional tracking parameters appended to the tracking link.

Path parameters

AccountSIDstringRequired

Unique identifier for the partner account.

IdstringRequired

Unique identifier for the ad.

Query parameters

subId1stringOptional

Appends the submitted value as subId1= to the tracking link. Must be URL encoded.

subId2stringOptional

Appends the submitted value as subId2= to the tracking link. Must be URL encoded.

subId3stringOptional

Appends the submitted value as subId3= to the tracking link. Must be URL encoded.

sharedIdstringOptional

Appends the submitted value as sharedId= to the tracking link. Must be URL encoded.

landingPagestring · uriOptional

Overrides the ad's landing page URL if the ad allows deep linking. Must be URL encoded.

Responses

200

The ad's iframe code.

application/json

IFrameCodestringOptional

The ad's iframe code with the tracking link embedded.

Example:

<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>

UristringOptional

Unique reference to this resource in the impact.com API.

Example: /Mediapartners/<AccountSID>/Ads/123456/IFrameCode

get/Mediapartners/{AccountSID}/Ads/{Id}/IFrameCode

GET /Mediapartners/{AccountSID}/Ads/{Id}/IFrameCode HTTP/1.1
Host: api.impact.com
Accept: */*

200

The ad's iframe code.

{
  "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>",
  "Uri": "/Mediapartners/<AccountSID>/Ads/123456/IFrameCode"
}

Retrieve an Ad's Tracking Link

get

Retrieves the tracking link for an existing ad, with optional tracking parameters appended.

Path parameters

AccountSIDstringRequired

Unique identifier for the partner account.

IdstringRequired

Unique identifier for the ad.

Query parameters

subId1stringOptional

Appends the submitted value as subId1= to the tracking link.

subId2stringOptional

Appends the submitted value as subId2= to the tracking link.

subId3stringOptional

Appends the submitted value as subId3= to the tracking link.

sharedIdstringOptional

Appends the submitted value as sharedId= to the tracking link.

landingPagestring · uriOptional

Overrides the ad's landing page URL if the ad allows deep linking.

Responses

200

The ad's tracking link.

application/json

TrackingLinkstring · uriOptional

The ad's tracking link, unique to your partner account.

Example: https://example.com/c/1299679/515236/8800

UristringOptional

Unique reference to this resource in the impact.com API.

Example: /Mediapartners/<AccountSID>/Ads/123456/TrackingLink

get/Mediapartners/{AccountSID}/Ads/{Id}/TrackingLink

GET /Mediapartners/{AccountSID}/Ads/{Id}/TrackingLink HTTP/1.1
Host: api.impact.com
Accept: */*

200

The ad's tracking link.

{
  "TrackingLink": "https://example.com/c/1299679/515236/8800",
  "Uri": "/Mediapartners/<AccountSID>/Ads/123456/TrackingLink"
}

PreviousAds NextModels

Last updated 5 days ago