API Reference

The tracking value request object

The tracking value request object holds information about a tracking value request, like a partner's request for a promo code. You can retrieve, approve, and reject a tracking value request, as well as list all tracking value requests.

Attributes

Id string

Unique identifier for the object referred to as the Tracking Value Request Object.

CampaignId integer

Id of the program (formerly known as campaign) that received the request.

CampaignName string

Name of the program (formerly known as campaign) that received the request.

MediaPartnerId integer

Id of the partner (formerly known as media partner) that sent the request.

MediaPartnerName string

Name of the partner (formerly known as media partner) that sent the request.

RequestType optional

What kind of tracking value the partner requested.

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

PromoCodes array

Array of information about the requested promo code. Will be empty unless RequestType: "PROMOCODE_TRACKING".

View child attributes

Id string

Id of the promo code.

RequestedPromoCode string

What the partner wants the promo code to be.

ApprovedPromoCode string

Promo code you have approved the partner to use.

CreditPolicy enum

How the credited partner is chosen.

View possible enum values
ALWAYSThe promo code's assigned partner will always be credited with the sale.
INVOLVEDThe promo code's assigned partner will be credited with the sale if they were involved in the conversion path.
WINNERThe promo code's assigned partner will be credited with the sale if they drove the winning referral in the conversion path.

MatchMode enum

How the promo code matches how the consumer uses it to how it is listed with impact.com. Required if RequestType: "PROMOCODE_TRACKING".

View possible enum values
LIEXACT match type. When a customer enters a promo code on a store page, it must exactly match how it was entered in impact.com to be tracked.
REREGEX match type. When a customer enters a promo code on a store page, it must match the regular expression of how the promo code was entered in impact.com to be tracked. Learn more about regular expression. Test a regular expression.

UniqueUrls array

Array of information about the requested unique URL. Will be empty unless RequestType: "BRANDED_URL_TRACKING".

View child attributes

Id string

Id of the unique URL.

Url string

The unique URL assigned to the partner.

PhoneNumbers array

Array of information about the requested tracking phone number. Will be empty unless RequestType: "PHONE_NUMBER_TRACKING".

View child attributes

Id string

Id of the tracking phone number.

AssignedPhoneNumberId string

Id of the phone number assigned to the partner.

AssignedPhoneNumber string

Tracking phone number that partners can use in their marketing efforts.

State enum

What state the tracking value request is in.

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

DatePlaced datetime

Date and time the partner submitted the tracking value request. See ISO 8601.

DateNeeded datetime

Date and time the partner needs the tracking value request by. See ISO 8601.

DateCompleted datetime

Date and time the tracking value request was completed. Will be empty if not completed. See ISO 8601.

Uri string

Tracking value request's direct URI to view only one specific request.

More Attributes

View more attributes

NumberRequested integer

Number of requested tracking values.

AdditionalInstructions string

Any additional instructions the partner has for the request.

ProcessingComments string

Any comments you have about the request that came up during processing.

DealId integer

Id of the associated deal. Will be empty if no deal is associated with the request.

Name string

Name of the associated deal. Will be empty if no deal is associated with the request.

Description string

Description of the associated deal, like information about it or what it does. Will be empty if no deal is associated with the request.

DealState enum

What state the associated deal is in. Will be empty if no deal is associated with the request.

View possible enum values
ACTIVEDeal is currently active.
EXPIREDDeal is not currently active.
PENDINGDeal is currently waiting for approval.

DealType enum

What the associated deal does. Will be empty if no associated deal.

View possible enum values
GENERAL_SALEDeal applies a general discount to the products identified in `DealScope`.
FREE_SHIPPINGDeal applies free shipping to the order.
GIFT_WITH_PURCHASEA gift will come with the order.
REBATEA rebate will be available to the customer upon purchase.
BOGODeal will apply a buy-one-get-one deal to the order.

DealScope enum

To what extent the deal applies to the store.

View possible enum values
CATEGORYDeal applies to a category of products.
ENTIRE_STOREDeal applies to the entire store.
PRODUCTDeal only applies to a specific product or a specific group of products.

Products array

If DealScope: "PRODUCT", then an array of product info objects appears. Child attributes will also appear.

View child attributes

ProductName string

Product's name.

ProductImageURL string

URL that leads to the product's image.

ProductBeforePriceAmount integer

Product's price prior to the deal applying.

ProductBeforePriceCurrency string

Product's currency code prior to the deal applying. See [ISO 4217](https://en.wikipedia.org/wiki/ISO_42170.

ProductAfterPriceAmount integer

Product's price after the deal applies.

ProductAfterPriceCurrency string

Product's currency code after the deal applies

DealCategories array

If Scope: "CATEGORY", then an array of category info appears.

DiscountType enum

Type of deal discount that will apply to the category.

View possible enum values
FIXEDDeal applies a fixed discount to the deal scope.
PERCENTDeal applies a percentage off of the deal scope.
PERCENT_RANGEDeal applies a percent within the percentage range off of the deal scope.
PERCENT_MAXIMUMDeal applies up to a certain percentage off of the deal scope.

DiscountAmount decimal

If DiscountType="FIXED", then the discount amount appears.

DiscountCurrency string

If DiscountType="FIXED", then the discount currency code appears. See ISO 4217.

DiscountPercent percentage

If DiscountType="PERCENT", then the discount percent appears.

DiscountMaximumPercent percentage

If DiscountType="PERCENT_MAXIMUM", then the maximum discount percentage appears.

DiscountPercentRangeStart percentage

If DiscountType="PERCENT_RANGE", then the discount range beginning appears.

DiscountPercentRangeEnd percentage

If DiscountType="PERCENT_RANGE", then the discount range end appears.

Gift string

If Type="GIFT_WITH_PURCHASE", then the gift's name appears.

RebateAmount decimal

If Type="REBATE", then the rebate's amount appears.

RebateCurrency string

If Type="REBATE", then the rebate's currency code appears. See ISO 4217.

DealDefaultPromoCode string

Default promo code consumers can use to activate the deal when making a purchase.

MinimumPurchaseAmount decimal

Minimum amount the consumer needs to spend for the deal to apply.

MinimumPurchaseAmountCurrency string

Currency of the deal's minimum purchase amount. See ISO 4217.

MaximumSavingsAmount integer

Maximum amount a consumer can save when the deal applies.

MaximumSavingsCurrency string

Currency of the deal's maximum purchase savings. See ISO 4217.

BogoBuyQuantity integer

If DealType="BOGO", the "buy" amount appears.

BogoBuyScope enum

if Type="BOGO", the "buy" scope appears. Will be empty if DealType≠BOGO.

View possible enum values
PRODUCTDeal only applies to a specific product or a specific group of products.
CATEGORYDeal applies to a category of products.

BogoBuyName string

If DealType="BOGO", the "buy" product name appears.

BogoBuyImageUrl string

If DealType="BOGO", the "buy" product image URL appears.

BogoGetQuantity integer

If Dealype="BOGO", the "get" amount appears.

BogoGetScope enum

If DealType="BOGO", the "get" scope appears. Will be empty if DealType≠"BOGO".

View possible enum values
PRODUCTDeal only applies to a specific product or a specific group of products.
CATEGORYDeal applies to a category of products.

BogoGetDiscountType enum

If DealType="BOGO", the "get" discount type appears. Will be empty if DealType≠"BOGO".

View possible enum values
FREECustomer will receive the `GET` item for free.
AMOUNTCustomer will receive a specific amount of money off of the `GET` item's cost.
PERCENTCustomer will receive a percent off of the `GET` item's cost.

BogoGetName string

If DealType="BOGO", the "get" product name appears.

BogoGetImageUrl string

If DealType="BOGO", the "get" product image URL appears.

BogoGetDiscountAmount decimal

If BogoGetDiscountType="AMOUNT", the "get" discount amount appears.

BogoGetDiscountCurrency string

If BogoGetDiscountType="AMOUNT", the currency of the "get" discount amount appears.

BogoGetDiscountPercent percentage

If BogoGetDiscountType="PERCENT", the "get" discount percent appears.

PurchaseLimitQuantity integer

If DealType="BOGO", the amount of "buy" product purchasable at once. If 0, no purchase limit.

StartDate datetime

Date and time the deal begins. See ISO 8601.

EndDate datetime

Date and time the deal ends. See ISO 8601.

SynchAdsPromoCodes boolean

Has the value true if the deal aligns the state and date range of all ads and promo codes to the deal's. Has the value false if the deal does not have this.

DealRestrictedMediaPartners array

Array of partner names that can use the deal.

DealRestrictedMediaPartnerGroups array

Array of partner groups that can use the deal.

{
  "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"
    }