The program object holds information for your programs. You can retrieve a program's object as well as list all program objects.

Attributes

`Id` integer

Unique identifier for the object referred to as the impact.com Program Id.

`Name` string

Name of the program.

`State` enum

State of the program.

View possible enum values
`ACTIVE`	Program is currently active.
`AWAITING_REVIEW`	Program is awaiting review by impact.com.
`CANCELLED`	Program was cancelled before it began.
`CLOSED`	Program was closed by impact.com.
`DEACTIVATED`	Program was deactivated by an account user.
`DELINQUENT`	Program is past due on payments to either impact.com or its partner(s).
`REJECTED`	Program was rejected by impact.com.
`SETUP`	Program is getting set up and will be available soon.
`SETUP_COMPLETE`	Program is set up and is awaiting approval.

`Categories` object

Categories, subcategories, and additional categories that the program is contained in.

View child attributes

`PrimaryCategory` enum

Program's primary impact.com marketplace category.

View possible enum values
`Apparel, Shoes & Accessories`
`Apps & Downloads`
`Art & Entertainment`
`Auto & Recreational Vehicles`
`B2B, Services & Office Supplies`
`Baby, Kids & Toys`
`Charitable Organizations`
`Computers & Electronics`
`Dating & Romance`
`Education`
`Financial, Insurance & Legal Services`
`Flowers, Gifts, Food & Drink`
`Home & Garden`
`Internet Services`
`Marketplace`
`Organic & Eco-Friendly`
`Pharmacy, Health & Beauty`
`Pets`
`Special Occasions, Seasonal & Events`
`Sports, Outdoor & Fitness`
`Suscriptions & Services`
`Travel`

`PrimarySubCategories` array

Program's impact.com marketplace subcategories.

Apparel, Shoes & Accessories subcategories

View possible enum values
`Bags & Accessories`
`Jewelry & Watches`
`Luxury`
`Mens Apparel`
`Shoes`
`Specialty Sizes`

Apps & Downloads subcategories

View possible enum values
`Apps`
`Books & Newsstand`
`Games`
`Movie & TV`
`Shopping`
`Themes, Code, Graphics, Video & More`

Art & Entertainment subcategories

View possible enum values
`Art & Craft Supplies`
`Art & Photography`
`Books & Magazines`
`Collectibles & Hobbies`
`Entertainment & Activities`
`Movies & Music`
`Tickets & Shows`

Auto & Recreational Vehicles subcategories

View possible enum values
`Automobiles & Auto Services`
`Parts & Accessories`
`Recreational Vehicles`

B2B, Services & Office Supplies subcategories

View possible enum values
`B2B`
`Career`
`Supplies & Furniture`

Baby, Kids & Toys subcategories

View possible enum values
`Baby Essentials`
`Baby & Kids Home`
`Clothing & Accessories`
`Educational`
`Games/Toys`

Charitable Organizations subcategories

View possible enum values
`Charitable Causes`
`Disaster Relief`

Computers & Electronics subcategories

View possible enum values
`Accessories & Peripherals`
`Computers`
`Consumer Electronics`
`Gaming`
`Mobile Services & Telecommunications`
`Software`

Dating & Romance subcategories

View possible enum values
`Online Dating`
`Romance`

Education subcategories

View possible enum values
`College`
`Learning`
`Textbooks & Supplies`

Financial, Insurance & Legal Services subcategories

View possible enum values
`Credit Cards, Reporting & Repair`
`Insurance`
`Legal`
`Loans & Financial Services`
`Real Estate`
`Tax`

Flowers, Gifts, Food & Drink subcategories

View possible enum values
`Flowers`
`Food & Drink`
`Gifts & Stationary`
`Gourmet`
`Wine & Spirits`

Home & Garden subcategories

View possible enum values
`Bed & Bath`
`Furniture & Home Decor`
`Home Improvement`
`Household Essentials & Services`
`Kitchen & Dining`
`Patio & Garden`

Internet Services subcategories

View possible enum values
`CDN Service`
`Internet Service Provider`
`Server Hosting`
`Templates, Fonts, Add-ons & more`
`Website Hosting`

Marketplace subcategories

View possible enum values
`Auctions`
`Creative Digital Assets`
`Handmade Goods`

Organic & Eco-Friendly subcategories

View possible enum values
`Apparel & Accessories`
`Food & Gifts`
`Health & Beauty`
`Home & Garden`

Pets subcategories

View possible enum values
`Pet Services`
`Pet Supplies`

Pharmacy, Health & Beauty subcategories

View possible enum values
`Cosmetics & Skin Care`
`Diet & Nutrition`
`First Aid & Pharmacy`
`Fragrance`
`Spa & Personal Grooming`
`Vision`

Special Occasions, Seasonal & Events subcategories

View possible enum values
`Fall`
`Spring`
`Summer`
`Winter`
`Party & Party Supplies`

Sports, Outdoor & Fitness subcategories

View possible enum values
`Sports Apparel & Accessories`
`Sports & Exercise Equipment`
`Outdoors & Recreation`

Subscriptions & Services subcategories

View possible enum values
`Apparel, Shoes & Accessories`
`Bath & Beauty`
`Food & Beverages`
`Gifts & Services`
`Home, Pet & Garden`
`Images`
`Sports & Outdoor`

Travel subcategories

View possible enum values
`Accommodations`
`Bath & Beauty`
`Food & Beverages`
`Gifts & Services`
`Images`
`Sports & Outdoor`
`Transportation`

`AdditionalCategory` enum

Another primary impact.com marketplace category that the program is listed in.

View possible enum values
`Apparel, Shoes & Accessories`
`Apps & Downloads`
`Art & Entertainment`
`Auto & Recreational Vehicles`
`B2B, Services & Office Supplies`
`Baby, Kids & Toys`
`Charitable Organizations`
`Dating & Romance`
`Computers & Electronics`
`Education`
`Financial, Insurance & Legal Services`
`Flowers, Gifts, Food & Drink`
`Home & Garden`
`Internet Services`
`Marketplace`
`Organic & Eco-Friendly`
`Pharmacy, Health & Beauty`
`Pets`
`Special Occasions, Seasonal & Events`
`Sports, Outdoor & Fitness`
`Suscriptions & Services`
`Travel`

`AdditionalSubCategories` array

Array of enums that represent a program's additional impact.com marketplace subcategories.

Apparel, Shoes & Accessories subcategories

View possible enum values
`Bags & Accessories`
`Jewelry & Watches`
`Luxury`
`Mens Apparel`
`Shoes`
`Specialty Sizes`

Apps & Downloads subcategories

View possible enum values
`Apps`
`Books & Newsstand`
`Games`
`Movie & TV`
`Shopping`
`Themes, Code, Graphics, Video & More`

Art & Entertainment subcategories

View possible enum values
`Art & Craft Supplies`
`Art & Photography`
`Books & Magazines`
`Collectibles & Hobbies`
`Entertainment & Activities`
`Movies & Music`
`Tickets & Shows`

Auto & Recreational Vehicles subcategories

View possible enum values
`Automobiles & Auto Services`
`Parts & Accessories`
`Recreational Vehicles`

B2B, Services & Office Supplies subcategories

View possible enum values
`B2B`
`Career`
`Supplies & Furniture`

Baby, Kids & Toys subcategories

View possible enum values
`Baby Essentials`
`Baby & Kids Home`
`Clothing & Accessories`
`Educational`
`Games/Toys`

Charitable Organizations subcategories

View possible enum values
`Charitable Causes`
`Disaster Relief`

Computers & Electronics subcategories

View possible enum values
`Accessories & Peripherals`
`Computers`
`Consumer Electronics`
`Gaming`
`Mobile Services & Telecommunications`
`Software`

Dating & Romance subcategories

View possible enum values
`Online Dating`
`Romance`

Education subcategories

View possible enum values
`College`
`Learning`
`Textbooks & Supplies`

Financial, Insurance & Legal Services subcategories

View possible enum values
`Credit Cards, Reporting & Repair`
`Insurance`
`Legal`
`Loans & Financial Services`
`Real Estate`
`Tax`

Flowers, Gifts, Food & Drink subcategories

View possible enum values
`Flowers`
`Food & Drink`
`Gifts & Stationary`
`Gourmet`
`Wine & Spirits`

Home & Garden subcategories

View possible enum values
`Bed & Bath`
`Furniture & Home Decor`
`Home Improvement`
`Household Essentials & Services`
`Kitchen & Dining`
`Patio & Garden`

Internet Services subcategories

View possible enum values
`CDN Service`
`Internet Service Provider`
`Server Hosting`
`Templates, Fonts, Add-ons & more`
`Website Hosting`

Marketplace subcategories

View possible enum values
`Auctions`
`Creative Digital Assets`
`Handmade Goods`

Organic & Eco-Friendly subcategories

View possible enum values
`Apparel & Accessories`
`Food & Gifts`
`Health & Beauty`
`Home & Garden`

Pets subcategories

View possible enum values
`Pet Services`
`Pet Supplies`

Pharmacy, Health & Beauty subcategories

View possible enum values
`Cosmetics & Skin Care`
`Diet & Nutrition`
`First Aid & Pharmacy`
`Fragrance`
`Spa & Personal Grooming`
`Vision`

Special Occasions, Seasonal & Events subcategories

View possible enum values
`Fall`
`Spring`
`Summer`
`Winter`
`Party & Party Supplies`

Sports, Outdoor & Fitness subcategories

View possible enum values
`Sports Apparel & Accessories`
`Sports & Exercise Equipment`
`Outdoors & Recreation`

Subscriptions & Services subcategories

View possible enum values
`Apparel, Shoes & Accessories`
`Bath & Beauty`
`Food & Beverages`
`Gifts & Services`
`Home, Pet & Garden`
`Images`
`Sports & Outdoor`

Travel subcategories

View possible enum values
`Accommodations`
`Bath & Beauty`
`Food & Beverages`
`Gifts & Services`
`Images`
`Sports & Outdoor`
`Transportation`

`ShortDescription` string

Initial description of the program when viewed in the marketplace. Max 100 characters.

`LongDescription` string

Description found on the program's marketplace brand card. Max 250 characters.

`ListInMarketplace` boolean

Whether the program can be viewed in the marketplace or not.

`DisplayServicingAgency` boolean

Whether partners can view the program's management agency. Will be false if the program is not managed by an agency.

`Rating` integer

Program's star rating.

`SearchKeywords` string

Comma-separated list of SEO keywords used to find the program in the marketplace.

`ShippingRegions` array

An array of countries representing the global regions this program services.

View possible country values

Possible enum values
`US`
`UK`
`CANADA`
`AUSTRALIA`
`GERMANY`
`FRANCE`
`AFGHANISTAN`
`ALBANIA`
`ALGERIA`
`AMERICANSAMOA`
`ANDORRA`
`ANGOLA`
`ANGUILLA`
`ANTARCTICA`
`ANTIGUABARBUDA`
`ARGENTINA`
`ARMENIA`
`ARUBA`
`AUSTRIA`
`AZERBAIJAN`
`BAHAMAS`
`BAHRAIN`
`BANGLADESH`
`BARBADOS`
`BELARUS`
`BELGIUM`
`BELIZE`
`BENIN`
`BERMUDA`
`BHUTAN`
`BOLIVIA`
`BOSNIAHERZEGOVINA`
`BOTSWANA`
`BRAZIL`
`BRITISHINDIANOCEANTERRITORY`
`BRUNEIDARUSSALAM`
`BULGARIA`
`BURKINAFASO`
`BURUNDI`
`CAMBODIA`
`CAMEROON`
`CAPVERDE`
`CAYMANISLANDS`
`CENTRALAFRICANREPUBLIC`
`CHAD`
`CHILE`
`CHINA`
`CHRISTMASISLAND`
`COCOSISLANDS`
`COLOMBIA`
`COMOROS`
`CONGO`
`DEMOCRATICREPUBLICCONGO`
`COOKISLANDS`
`COSTARICA`
`IVORYCOAST`
`CROATIA`
`CUBA`
`CYPRUS`
`CZECHREPUBLIC`
`DENMARK`
`DIJIBOUTI`
`DOMINICA`
`DOMINICANREPUBLIC`
`ECUADOR`
`EGYPT`
`ELSALVADOR`
`EQUATORIALGUINEA`
`ELSALVADOR`
`ERITREA`
`ESTONIA`
`ETHIOPIA`
`FALKLANDISLANDS`
`FAROEISLANDS`
`FIJI`
`FINLAND`
`FRENCHGUIANA`
`FRENCHPOLYNESIA`
`FRENCHSOUTHERNTERRITORIES`
`GABON`
`GAMBIA`
`GEORGIA`
`GHANA`
`GIBRALTAR`
`GREECE`
`GREENLAND`
`GRENADA`
`GUADELOUPE`
`GUAM`
`GUATEMALA`
`GUERNSEY`
`GUINEA`
`GUINEABISSAU`
`GUYANA`
`HAITI`
`VATICAN`
`HONDURAS`
`HONGKONG`
`HUNGARY`
`ICELAND`
`INDIA`
`INDONESIA`
`IRAN`
`IRAQ`
`IRELAND`
`ISRAEL`
`ITALY`
`JAMAICA`
`JAPAN`
`JORDAN`
`KAZAKHSTAN`
`KENYA`
`KIRIBATI`
`SOUTHKOREA`
`KUWAIT`
`KYRGYZSTAN`
`LAOS`
`LATVIA`
`LEBANON`
`LESOTHO`
`LIBERIA`
`LIBYA`
`LICHTENSTEIN`
`LITHUANIA`
`LUXEMBOURG`
`MACAO`
`MACEDONIA`
`MADAGASCAR`
`MALAWI`
`MALAYSIA`
`MALDIVES`
`MALI`
`MALTA`
`MARSHALLISLANDS`
`MARTINIQUE`
`MAURITANIA`
`MAURITIUS`
`MAYOTTE`
`MEXICO`
`MICRONESIA`
`MOLDOVA`
`MONACO`
`MONGOLIA`
`MONTENEGRO`
`MONTSERRAT`
`MOROCCO`
`MOZAMBIQUE`
`MYANMAR`
`NAMIBIA`
`NAURU`
`NEPAL`
`NETHERLANDS`
`NETHERLANDSANTILLES`
`NEWCALEDONIA`
`NEWZEALAND`
`NICARAGUA`
`NIGER`
`NIGERIA`
`NIUE`
`NORFOLKISLAND`
`NORTHKOREA`
`NORTHERNMARIANAISLANDS`
`NORWAY`
`OMAN`
`PAKISTAN`
`PALAU`
`PALESTINIANTERRITORY`
`PANAMA`
`PAPUANEWGUINEA`
`PARAGUAY`
`PERU`
`PHILIPPINES`
`PITCAIRN`
`POLAND`
`PORTUGAL`
`PUERTORICO`
`QATAR`
`REUNION`
`ROMANIA`
`RUSSIA`
`RWANDA`
`SAINTHELENA`
`SAINTKITTSNEVIS`
`SAINTLUCIA`
`SAINTPIERREMIQUELON`
`SAINTVINCENTGRENADINES`
`SAMOA`
`SANMARINO`
`SAOTOME`
`SAUDIARABIA`
`SENEGAL`
`YOGOSLAVIA`
`SEYCHELLES`
`SIERRALEONE`
`SINGAPORE`
`SLOVAKIA`
`SLOVENIA`
`SOLOMONISLANDS`
`SOMALIA`
`SOUTHAFRICA`
`SPAIN`
`SRILANKA`
`SUDAN`
`SURINAME`
`SVALBARDJANMAYEN`
`SWAZILAND`
`SWEDEN`
`SWITZERLAND`
`SYRIA`
`TAIWAN`
`TAJIKISTAN`
`TANZANIA`
`THAILAND`
`TIMOR`
`TOGO`
`TOKELAU`
`TONGA`
`TRINIDADTOBAGO`
`TUNISIA`
`TURKEY`
`TURKMENISTAN`
`TURKSCAICOSISLANDS`
`TUVALU`
`UGANDA`
`UKRAINE`
`UAE`
`URUGUAY`
`UZBEKISTAN`
`VANUATU`
`VENEZUELA`
`VIETNAM`
`BRITISHVIRGINISLANDS`
`USVIRGINISLANDS`
`WALLISFUTUNA`
`WESTERNSAHARA`
`YEMEN`
`ZAMBIA`
`ZIMBABWE`

`Resources` object

Links that partners can select to learn more about the program or brand.

View child attributes

`CompanyHomepage` string

Brand's web homepage.

`ExampleLandingPage` string

Example web page that the program's ad could send traffic to.

`InformationPage` string

Web page that partners can go to, to learn more about the program or brand.

`AdditionalRelatedLinks` array

More links partners can visit to learn about the program or brand.

View child attributes

`LinkType` enum

Related link's link type.

View possible enum values
`URL`	Selecting the related link will direct the partner to a webpage.
`PDF`	Selecting the elated link will download a PDF.

`LinkDisplayName` string

The link's hyperlinked text. The partner will select this text to go to the linked web page or download the PDF.

`LinkUrl` string

The URL path leading to the related link. This is the destination page or link to download the PDF.

`CompanyContacts` array

Contact information that partners can use to contact the brand.

View child attributes

`FirstName` string

Brand representative's first name.

`LastName` string

Brand representative's last name.

`EmailAddress` string

Brand representative's email address.

`PhoneNumber` string

Brand representative's phone number.

`GiftCardPayouts` boolean

If the program pays out on actions that were paid for with a gift card.

`TrademarkBidding` boolean

If the program allows partners to bid on using the brand's trademarked terms in marketing materials.

`ThirdPartyImpressionPixel` string

Any third-party tracking pixels used by the brand.

`MobileReadyAds` boolean

If the program's ads can be used on mobile browsers.

`DisplayFutureAds` boolean

If partners can view ads that cannot yet be used.

`PromoCodeTracking` boolean

If the program utilizes promo code tracking.

`TrackingDomain` string

Program's unique tracking link.

`SiteDefinition` string

Where the tracking domain points to.

`ImpressionTracking` boolean

If the program tracks ad impressions.

`ViewThroughCrediting` boolean

If the program tracks view-through conversions.

`IdentityMatching` enum

How the program matches traffic and conversion identities, usually across devices. Consumer data is hashed before it reaches impact.com.

View possible enum values
`NONE`	impact.com will not use consumer data to match traffic to conversions. Not recommended.
`ACCOUNT`	Utilize consumer data only within your account.
`IR_CONSORTIUM`	Utilizes all consumer data across brands to match traffic and consumer identities.

`GatewayTrackingSettings` object

Program's gateway tracking details.

View child attributes

`DefaultLandingPage` string

Default landing page of any given ad in the program.

`MediaPartnerTrackingTemplate` string

Parameters that are automatically appended to all landing pages for partners.

`CampaignTrackingTemplate` string

Parameters that are automatically appended to all landing pages for a program.

`SSLSupport` boolean

If traffic will be directed to a secure version of the landing page. The landing page must support SSL for this to be true.

`DeepLinking` boolean

If the program allows partner deeplinking.

`DeepLinkDomains` string

Comma-separated list of the links partners can use to deeplink.

`ThirdPartyGatewayUrl` string

If used, the third-party URL that traffic is directed through. Is empty if not used.

`ThirdPartyGatewayQueryStringParameters` string

Comma-separated list of parameters to be appended to the ThirdPartyGatewayUrl.

`UniqueClickWindowLength` enum

Maximum amount of time between each click in a tracking session before it ends. Default is 30m.

View possible enum values
`1m`	1 minute.
`5m`	5 minutes.
`15m`	15 minutes.
`30m`	30 minutes.
`1h`	1 hour.
`6h`	6 hours.
`12h`	12 hours.
`24h`	24 hours.

`UniqueClickWindowType` enum

Whether the click window is a fixed amount of time or if the time limit resets after each consecutive click.

View possible enum values
`FIXED`	All clicks in a click window must occur within a fixed amount of time.
`ROLLING`	The click window time limit resets after each consecutive click.

`DirectTrackingSettings` object

Program's direct tracking details.

View child attributes

`UnidentifiedName` string

Name of the parameter used to segment and track unidentified traffic.

`SessionWindowLength` integer

Amount of time (in minutes) before an inactive session times out. Default time is 30 minutes.

`Uri` string

The program's direct URI.

{
  "Id": "1000",
  "Name": "Acme Campaign",
  "State": "ACTIVE",
  "Categories": {
    "PrimaryCategory": "B2B, Services & Office Supplies",
    "PrimarySubCategories": [
      "B2B"
    ],
    "AdditionalCategory": "",
    "AdditionalSubCategories": []
    },
  "ShortDescription": "This is a short description.",
  "LongDescription": "This is a long description. Find more words here.",
  "ListInMarketplace": "true",
  "DisplayServicingAgency": "false",
  "Rating": "3",
  "SearchKeywords": "Anvils",
  "ShippingRegions": [
    "United States"
  ],
  "Resources": {
    "CompanyHomepage": "www.acme.com",
    "ExampleLandingPage": "",
    "InformationPage": "",
    "AdditionalRelatedLinks": []
  },
  "CompanyContacts": [
    {
      "FirstName": "Brand",
      "LastName": "Man",
      "EmailAddress": "brand.man@acme.com",
      "PhoneNumber": "+1(805) 123-1234"
    }
  ],
  "GiftCardPayouts": "false",
  "TrademarkBidding": "false",
  "ThirdPartyImpressionPixel": "",
  "MobileReadyAds": "false",
  "DisplayFutureAds": "false",
  "PromoCodeTracking": "true",
  "TrackingDomain": "acme.sjv.io",
  "SiteDefinition": "www.acme.com",
  "ImpressionTracking": "false",
  "ViewThroughCrediting": "false",
  "IdentityMatching": "IR_CONSORTIUM",
  "GatewayTrackingSettings": {
    "DefaultLandingPage": "http://www.acme.com",
    "MediaPartnerTrackingTemplate": "asd=1&foo=4&asf=2&clickid={clickid}",
    "CampaignTrackingTemplate": "",
    "SSLSupport": "true",
    "DeepLinking": "true",
    "DeepLinkDomains": "acme.com/store/forge/anvils/anvil2",
    "ThirdPartyGatewayUrl": "",
    "ThirdPartyGatewayQueryStringParameters": "",
    "UniqueClickWindowLength": "30m",
    "UniqueClickWindowType": "ROLLING"
    },
  "DirectTrackingSettings": {
    "UnidentifiedName": "",
    "SessionWindowLength": ""
    },
  "Uri": "/Advertisers/<AccountSID>/Campaigns/1000"
}