API Reference
Start typing to search…

List all programs

Returns a list of the programs (formerly known as campaigns) you've signed up to, sorted by CampaignId.

Parameters

InsertionOrderStatus optional enum

Displays all programs depending on the status of their contract (formerly known as Insertion Order).

Possible enum values
ActiveContract is currently active.
ExpiredContract has expired.

Returns

Returns an array of campaign objects up to a limit dictated by @pagesize. Each entry in the array is a separate program. If no programs meet the criteria, the resulting array will be empty. This request should never return an error.

Example request

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

Example response

{
  "@page": "1",
  "@numpages": "1",
  "@pagesize": "100",
  "@total": "2",
  "@start": "0",
  "@end": "1",
  "@uri": "/Mediapartners/<AccountSID>/Campaigns",
  "@firstpageuri": "/Mediapartners/<AccountSID>/Campaigns?PageSize=100&Page=1",
  "@previouspageuri": "",
  "@nextpageuri": "",
  "@lastpageuri": "/Mediapartners/<AccountSID>/Campaigns?PageSize=100&Page=1",
  "Campaigns": [
     {
        "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": "/display-logo-via-campaign/logo.jpg",
        "PublicTermsUri": "/Mediapartners/<AccountSID>/Campaigns/12345/PublicTerms",
        "ContractStatus": "Active",
        "ContractUri": "/Mediapartners/<AccountSID>/Campaigns/12345/Contracts/Active",
        "TrackingLink": "https: //breenatestadv.sjv.io/c/1924609/650971/12345",
        "AllowsDeeplinking": "true",
        "DeeplinkDomains": {
           "DeeplinkDomain": "example.com"
        },
        "Uri": "/Mediapartners/<AccountSID>/Campaigns/12345"
     },
     {
        "AdvertiserId": "1234567",
        "AdvertiserName": "ACME Inc",
        "AdvertiserUrl": "http: //www.acmeinc.com",
        "CampaignId": "12344",
        "CampaignName": "ACME Inc",
        "CampaignUrl": "http: //www.ac.me",
        "CampaignDescription": "ACME Advertising",
        "ShippingRegions": {
           "ShippingRegion": "US"
        },
        "CampaignLogoUri": "/display-logo-via-campaign/logo.jpg",
        "PublicTermsUri": "/Mediapartners/<AccountSID>/Campaigns/12344/PublicTerms",
        "ContractStatus": "Active",
        "ContractUri": "/Mediapartners/<AccountSID>/Campaigns/12344/Contracts/Active",
        "TrackingLink": "https: //acmeinc.sjv.io/c/1924609/771766/12344",
        "AllowsDeeplinking": "false",
        "DeeplinkDomains": [],
        "Uri": "/Mediapartners/<AccountSID>/Campaigns/12344"
     }
  ]
}