API Reference

List all tracking value requests

Returns a list of your tracking value requests.

Parameters

CampaignId optional

A program (formerly known as campaign) Id.

DealId optional

An associated deal Id.

MediaPartnerId optional

A partner (formerly known as media partner) Id.

State optional

State of the tracking value request.

View possible enum values
APPROVEDApproved tracking value request.
COMPLETEDCompleted tracking value request.
DECLINEDDeclined tracking value request.
NEWNew tracking value request.

RequestType optional

What kind of tracking value the partner requested.

View possible enum values
BRANDED_URL_TRACKINGPartner requested a unique tracking URL.
PHONE_NUMBER_TRACKINGPartner requested a trackable phone number.
PROMOCODE_TRACKINGPartner requested a promo code.

Returns

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

Example Request

curl 'https://api.impact.com/Advertisers/<AccountSID>/TrackingValueRequests' \
  -X GET \
  -u '<AccountSID>:<AuthToken>' \
  -H 'Accept: application/json' \
  -d 'CampaignId=1000' \
  -d 'State=NEW' \
  -d 'RequestType=PROMOCODE_TRACKING' \
  -G

Example Response

{
  "@page": "1",
  ...
  "TrackingValueRequests": [
    {
      "Id": "55555",
      "CampaignId": "1000",
      "CampaignName": "ACME Campaign",
      "MediaPartnerId": "10000",
      "MediaPartnerName": "Partner Person",
      "RequestType": "PROMOCODE_TRACKING",
      "NumberRequested": "1",
      "PromoCodes": [
        {
          "Id": "50000",
          "RequestedPromoCode": "Promo Code",
          "ApprovedPromoCode": "Promo Code",
          "CreditPolicy": "ALWAYS",
          "MatchMode": "LI"
          }
        ],
      "UniqueUrls": [],
      "PhoneNumbers": [],
      "State": "NEW",
      "DatePlaced": "2021-01-28T16:23:49-05:00",
      "DateNeeded": "2021-01-31T00:00:00-05:00",
      "DateCompleted": "",
      "AdditionalInstructions": "Some additional instructions.",
      "ProcessingComments": "",
      "DealId": "",
      "DealName": "",
      "DealDescription": "",
      "DealState": "",
      "DealType": "",
      "DealScope": "",
      "DealProducts": [],
      "DealCategories": "",
      "DiscountType": "",
      "DiscountAmount": "",
      "DiscountCurrency": "",
      "DiscountPercent": "",
      "DiscountMaximumPercent": "",
      "DiscountPercentRangeStart": "",
      "DiscountPercentRangeEnd": "",
      "Gift": "",
      "RebateAmount": "",
      "RebateCurrency": "",
      "DealDefaultPromoCode": "",
      "MinimumPurchaseAmount": "",
      "MinimumPurchaseAmountCurrency": "",
      "MaximumSavingsAmount": "",
      "MaximumSavingsCurrency": "",
      "BogoBuyQuantity": "",
      "BogoBuyScope": "",
      "BogoBuyName": "",
      "BogoBuyImageUrl": "",
      "BogoGetQuantity": "",
      "BogoGetScope": "",
      "BogoGetDiscountType": "",
      "BogoGetName": "",
      "BogoGetImageUrl": "",
      "BogoGetDiscountAmount": "",
      "BogoGetDiscountCurrency": "",
      "BogoGetDiscountPercent": "",
      "PurchaseLimitQuantity": "",
      "DealStartDate": "",
      "DealEndDate": "",
      "SynchAdsPromoCodes": "",
      "DealRestrictedMediaPartners": [],
      "DealRestrictedMediaPartnerGroups": [],
      "Uri": "/Advertisers/<AccountSID>/TrackingValueRequests/55555"
    }
  ]
}