API Reference

Retrieve a program

Retrieves the details of an existing program. Requires you to pass the unique impact.com program Id that was returned when listing programs.

Parameters

No parameters.

Returns

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

Example Request

curl 'https://api.impact.com/Advertisers/<AccountSID>/Campaigns/<CampaignId>' \
  -X GET \
  -u '<AccountSID>:<AuthToken>' \
  -H 'Accept: application/json'

Example Response

{
  "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": "[email protected]",
      "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": "",
    "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"
}