Programs

List all programs

get

Returns a list of the programs for your account, sorted by program Id.

Authorizations

basicAuth

AuthorizationstringRequired

Path parameters

AccountSIDstringRequired

The unique identifier for the account.

Query parameters

NamestringOptional

Filter by the name of the program.

Statestring · enumOptional

Filter by the state of the program.

Possible values:

Responses

200

A list of program objects.

application/json

get/Advertisers/{AccountSID}/Campaigns

cURL

curl -L \
  --url 'https://api.impact.com/Advertisers/{AccountSID}/Campaigns' \
  --user '{AccountSID}:{AuthToken}' \
  --header 'Accept: */*'

200

A list of program objects.

{
  "Campaigns": [
    {
      "Id": 1000,
      "Name": "Acme Affiliate Program",
      "State": "ACTIVE",
      "Categories": {
        "PrimaryCategory": "Sports",
        "PrimarySubCategories": [
          "Tennis"
        ],
        "AdditionalCategory": "Apparel",
        "AdditionalSubCategories": [
          "Activewear"
        ]
      },
      "ShortDescription": "Affiliate program for Acme.",
      "LongDescription": "Earn commissions promoting Acme tennis gear.",
      "ListInMarketplace": true,
      "DisplayServicingAgency": false,
      "Rating": 5,
      "SearchKeywords": "tennis,sports,outdoor",
      "ShippingRegions": [
        "US"
      ],
      "Resources": {
        "CompanyHomepage": "https://www.acme.com",
        "ExampleLandingPage": "https://www.acme.com/tennis",
        "InformationPage": "https://partners.acme.com",
        "AdditionalRelatedLinks": [
          {
            "LinkType": "URL",
            "LinkDisplayName": "Partner FAQ",
            "LinkUrl": "https://partners.acme.com/faq"
          }
        ]
      },
      "CompanyContacts": [
        {
          "FirstName": "Account",
          "LastName": "Manager",
          "EmailAddress": "[e-mail]",
          "PhoneNumber": "[phone]"
        }
      ],
      "GiftCardPayouts": true,
      "TrademarkBidding": false,
      "ThirdPartyImpressionPixel": "<script>/* pixel */</script>",
      "MobileReadyAds": true,
      "DisplayFutureAds": true,
      "PromoCodeTracking": true,
      "TrackingDomain": "acme.go2cloud.org",
      "SiteDefinition": "ENTIRE_DOMAIN",
      "ImpressionTracking": true,
      "ViewThroughCrediting": true,
      "IdentityMatching": "NONE",
      "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": "text"
      },
      "Uri": "/Advertisers/<AccountSID>/Campaigns/1000"
    }
  ]
}

Retrieve a program

get

Retrieves the full details of an existing program using its unique ID.

Authorizations

basicAuth

AuthorizationstringRequired

Path parameters

AccountSIDstringRequired

The unique identifier for the account.

CampaignIdintegerRequired

The unique identifier for the program (campaign).

Responses

200

A single program object.

application/json

IdintegerOptional

The unique identifier for the program.

Example: 1000

NamestringOptional

The display name of the program.

Example: Acme Affiliate Program

Statestring · enumOptional

The current state of the program.

Possible values:

ShortDescriptionstringOptional

A short description of the program.

Example: Affiliate program for Acme.

LongDescriptionstringOptional

A long description of the program.

Example: Earn commissions promoting Acme tennis gear.

ListInMarketplacebooleanOptional

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

Example: true

DisplayServicingAgencybooleanOptional

Whether the servicing agency is displayed publicly.

Example: false

RatingintegerOptional

The program's rating.

Example: 5

SearchKeywordsstringOptional

Keywords used to surface the program in marketplace search.

Example: tennis,sports,outdoor

ShippingRegionsstring[]Optional

Regions where the brand ships.

Example: US

GiftCardPayoutsbooleanOptional

Whether gift card payouts are enabled.

Example: true

TrademarkBiddingbooleanOptional

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

Example: false

ThirdPartyImpressionPixelstringOptional

A third-party impression tracking pixel.

Example: <script>/* pixel */</script>

MobileReadyAdsbooleanOptional

Whether the program supports mobile-ready ads.

Example: true

DisplayFutureAdsbooleanOptional

Whether to display ads that aren't yet active.

Example: true

PromoCodeTrackingbooleanOptional

Whether promo code tracking is enabled.

Example: true

TrackingDomainstringOptional

The tracking domain used for this program.

Example: acme.go2cloud.org

SiteDefinitionstringOptional

The site definition for the program.

Example: ENTIRE_DOMAIN

ImpressionTrackingbooleanOptional

Whether impression tracking is enabled.

ViewThroughCreditingbooleanOptional

Whether view-through crediting is enabled.

IdentityMatchingstring · enumOptional

The identity matching strategy.

Possible values:

Uristring · uri-referenceOptional

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

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

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

cURL

curl -L \
  --url 'https://api.impact.com/Advertisers/{AccountSID}/Campaigns/{CampaignId}' \
  --user '{AccountSID}:{AuthToken}' \
  --header 'Accept: */*'

200

A single program object.

{
  "Id": 1000,
  "Name": "Acme Affiliate Program",
  "State": "ACTIVE",
  "Categories": {
    "PrimaryCategory": "Sports",
    "PrimarySubCategories": [
      "Tennis"
    ],
    "AdditionalCategory": "Apparel",
    "AdditionalSubCategories": [
      "Activewear"
    ]
  },
  "ShortDescription": "Affiliate program for Acme.",
  "LongDescription": "Earn commissions promoting Acme tennis gear.",
  "ListInMarketplace": true,
  "DisplayServicingAgency": false,
  "Rating": 5,
  "SearchKeywords": "tennis,sports,outdoor",
  "ShippingRegions": [
    "US"
  ],
  "Resources": {
    "CompanyHomepage": "https://www.acme.com",
    "ExampleLandingPage": "https://www.acme.com/tennis",
    "InformationPage": "https://partners.acme.com",
    "AdditionalRelatedLinks": [
      {
        "LinkType": "URL",
        "LinkDisplayName": "Partner FAQ",
        "LinkUrl": "https://partners.acme.com/faq"
      }
    ]
  },
  "CompanyContacts": [
    {
      "FirstName": "Account",
      "LastName": "Manager",
      "EmailAddress": "[e-mail]",
      "PhoneNumber": "[phone]"
    }
  ],
  "GiftCardPayouts": true,
  "TrademarkBidding": false,
  "ThirdPartyImpressionPixel": "<script>/* pixel */</script>",
  "MobileReadyAds": true,
  "DisplayFutureAds": true,
  "PromoCodeTracking": true,
  "TrackingDomain": "acme.go2cloud.org",
  "SiteDefinition": "ENTIRE_DOMAIN",
  "ImpressionTracking": true,
  "ViewThroughCrediting": true,
  "IdentityMatching": "NONE",
  "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": "text"
  },
  "Uri": "/Advertisers/<AccountSID>/Campaigns/1000"
}