API Reference

Retrieve a campaign

Retrieves the details of an existing program (formerly known as a campaign) you've joined. Requires you to pass the unique impact.com CampaignId that was returned when listing programs.

Parameters

There are no parameters.

Example request

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

Example response

{
  "AdvertiserId": "1234567",
  "AdvertiserName": "ACME Inc",
  "AdvertiserUrl": "http://www.acme.com",
  "CampaignId": "12345",
  "CampaignName": "ACMEInc",
  "CampaignUrl": "http://www.ac.me",
  "CampaignDescription": "You can earn commission for promoting my products.",
  "ShippingRegions": [
     "SOUTHAFRICA",
     "UK",
     "US"
  ],
  "CampaignLogoUri": "https://cdn2.impact.com/display-logo-via-campaign/12345.gif",
  "PublicTermsUri": "/Mediapartners/<AccountSID>/Campaigns/12345/PublicTerms",
  "ContractStatus": "Active",
  "ContractUri": "/Mediapartners/<AccountSID>/Campaigns/12345/Contracts/Active",
  "TrackingLink": "https://acmeinc.sjv.io/c/1924609/650971/12345",
  "AllowsDeeplinking": "true",
  "DeeplinkDomains": {
     "DeeplinkDomain": "acme.com"
  },
  "Uri": "/Mediapartners/<AccountSID>/Campaigns/12345"
}