Programs

List All Programs

get

Returns a list of all programs for your account, sorted by Program ID.

Path parameters

AccountSIDstringRequired

Query parameters

NamestringOptional

Filter by program name.

Statestring · enumOptional

Filter by program state.

Possible values:

Responses

200

A paginated list of program objects.

application/json

get/Advertisers/{AccountSID}/Campaigns

HTTPcURLJavaScriptPython

GET /Advertisers/{AccountSID}/Campaigns HTTP/1.1
Host: api.impact.com
Accept: */*

200

A paginated list of program objects.

{
  "Campaigns": [
    {
      "Id": 1,
      "Name": "text",
      "State": "ACTIVE",
      "Type": "Performance",
      "Categories": {
        "PrimaryCategory": "text",
        "PrimarySubCategories": [
          "text"
        ],
        "AdditionalCategory": "text",
        "AdditionalSubCategories": [
          "text"
        ]
      },
      "ShortDescription": "text",
      "LongDescription": "text",
      "ListInMarketplace": true,
      "DisplayServicingAgency": true,
      "Rating": 1,
      "SearchKeywords": "text",
      "ShippingRegions": [
        "text"
      ],
      "Resources": {
        "CompanyHomepage": "https://example.com",
        "ExampleLandingPage": "https://example.com",
        "InformationPage": "https://example.com",
        "AdditionalRelatedLinks": [
          {
            "LinkType": "URL",
            "LinkDisplayName": "text",
            "LinkUrl": "https://example.com"
          }
        ]
      },
      "CompanyContacts": [
        {
          "FirstName": "text",
          "LastName": "text",
          "EmailAddress": "[e-mail]",
          "PhoneNumber": "text"
        }
      ],
      "GiftCardPayouts": true,
      "TrademarkBidding": true,
      "ThirdPartyImpressionPixel": "text",
      "MobileReadyAds": true,
      "DisplayFutureAds": true,
      "PromoCodeTracking": true,
      "TrackingDomain": "text",
      "SiteDefinition": "text",
      "ImpressionTracking": true,
      "ViewThroughCrediting": true,
      "IdentityMatching": "NONE",
      "HasStandDownPolicy": true,
      "GatewayTrackingSettings": {
        "DefaultLandingPage": "https://example.com",
        "MediaPartnerTrackingTemplate": "text",
        "CampaignTrackingTemplate": "text",
        "SSLSupport": true,
        "DeepLinking": true,
        "DeepLinkDomains": "text",
        "ThirdPartyGatewayUrl": "https://example.com",
        "ThirdPartyGatewayQueryStringParameters": "text",
        "UniqueClickWindowLength": "1m",
        "UniqueClickWindowType": "FIXED"
      },
      "DirectTrackingSettings": {
        "UnidentifiedName": "text",
        "SessionWindowLength": 1
      },
      "Uri": "/Advertisers/<AccountSID>/Campaigns/1000"
    }
  ]
}

Get Program Details

get

Retrieves the details of an existing program by its unique ID.

Path parameters

AccountSIDstringRequired

CampaignIdintegerRequired

The unique identifier for the program (campaign).

Responses

200

A single program object.

application/json

IdintegerOptional

The unique identifier for the program.

NamestringOptional

The display name of the program.

Statestring · enumOptional

The current state of the program.

Possible values:

Typestring · enumOptional

The classification of the program. This indicates the business model or category the program falls under (e.g., Affiliate, Retail Media, etc.).

Example: PerformancePossible values:

ShortDescriptionstringOptional

A short description of the program.

LongDescriptionstringOptional

A long description of the program.

ListInMarketplacebooleanOptional

Whether the program is listed in the impact.com partner marketplace.

DisplayServicingAgencybooleanOptional

Whether the servicing agency is displayed publicly.

RatingintegerOptional

The program's rating.

SearchKeywordsstringOptional

Keywords used to surface the program in marketplace search.

ShippingRegionsstring[]Optional

Regions where the brand ships.

GiftCardPayoutsbooleanOptional

Whether gift card payouts are enabled.

TrademarkBiddingbooleanOptional

Whether partners are allowed to bid on the brand's trademark terms.

ThirdPartyImpressionPixelstringOptional

A third-party impression tracking pixel.

MobileReadyAdsbooleanOptional

Whether the program supports mobile-ready ads.

DisplayFutureAdsbooleanOptional

Whether to display ads that aren't yet active.

PromoCodeTrackingbooleanOptional

Whether promo code tracking is enabled.

TrackingDomainstringOptional

The tracking domain used for this program.

SiteDefinitionstringOptional

The site definition for the program.

ImpressionTrackingbooleanOptional

Whether impression tracking is enabled.

ViewThroughCreditingbooleanOptional

Whether view-through crediting is enabled.

IdentityMatchingstring · enumOptional

The identity matching strategy.

Possible values:

HasStandDownPolicybooleanOptional

Whether the program has a stand-down policy in place.

Uristring · uri-referenceOptional

The unique reference to this program in the impact.com API.

Example: /Advertisers/<AccountSID>/Campaigns/1000

get/Advertisers/{AccountSID}/Campaigns/{CampaignId}

HTTPcURLJavaScriptPython

GET /Advertisers/{AccountSID}/Campaigns/{CampaignId} HTTP/1.1
Host: api.impact.com
Accept: */*

200

A single program object.

{
  "Id": 1,
  "Name": "text",
  "State": "ACTIVE",
  "Type": "Performance",
  "Categories": {
    "PrimaryCategory": "text",
    "PrimarySubCategories": [
      "text"
    ],
    "AdditionalCategory": "text",
    "AdditionalSubCategories": [
      "text"
    ]
  },
  "ShortDescription": "text",
  "LongDescription": "text",
  "ListInMarketplace": true,
  "DisplayServicingAgency": true,
  "Rating": 1,
  "SearchKeywords": "text",
  "ShippingRegions": [
    "text"
  ],
  "Resources": {
    "CompanyHomepage": "https://example.com",
    "ExampleLandingPage": "https://example.com",
    "InformationPage": "https://example.com",
    "AdditionalRelatedLinks": [
      {
        "LinkType": "URL",
        "LinkDisplayName": "text",
        "LinkUrl": "https://example.com"
      }
    ]
  },
  "CompanyContacts": [
    {
      "FirstName": "text",
      "LastName": "text",
      "EmailAddress": "[e-mail]",
      "PhoneNumber": "text"
    }
  ],
  "GiftCardPayouts": true,
  "TrademarkBidding": true,
  "ThirdPartyImpressionPixel": "text",
  "MobileReadyAds": true,
  "DisplayFutureAds": true,
  "PromoCodeTracking": true,
  "TrackingDomain": "text",
  "SiteDefinition": "text",
  "ImpressionTracking": true,
  "ViewThroughCrediting": true,
  "IdentityMatching": "NONE",
  "HasStandDownPolicy": true,
  "GatewayTrackingSettings": {
    "DefaultLandingPage": "https://example.com",
    "MediaPartnerTrackingTemplate": "text",
    "CampaignTrackingTemplate": "text",
    "SSLSupport": true,
    "DeepLinking": true,
    "DeepLinkDomains": "text",
    "ThirdPartyGatewayUrl": "https://example.com",
    "ThirdPartyGatewayQueryStringParameters": "text",
    "UniqueClickWindowLength": "1m",
    "UniqueClickWindowType": "FIXED"
  },
  "DirectTrackingSettings": {
    "UnidentifiedName": "text",
    "SessionWindowLength": 1
  },
  "Uri": "/Advertisers/<AccountSID>/Campaigns/1000"
}