--- title: "List All Tracking Value Requests" method: GET path: "/Advertisers/{AccountSID}/TrackingValueRequests" tags: ["Tracking Value Requests"] --- # List All Tracking Value Requests `GET /Advertisers/{AccountSID}/TrackingValueRequests` Returns a list of tracking value requests, with options for filtering. ## Path parameters - `AccountSID` string, required ## Query parameters - `CampaignId` integer - `DealId` integer - `MediaPartnerId` integer - `State` 'APPROVED' | 'COMPLETED' | 'DECLINED' | 'NEW' - `RequestType` 'PROMOCODE_TRACKING' | 'BRANDED_URL_TRACKING' | 'PHONE_NUMBER_TRACKING' ## Response `200` A paginated list of tracking value request objects. - object - `TrackingValueRequests` TrackingValueRequest[] — The list of tracking value request objects. - `Id` string — The unique identifier for the tracking value request. - `CampaignId` integer — The ID of the program the request is for. - `CampaignName` string — The display name of the program. - `MediaPartnerId` integer — The unique identifier of the partner making the request. - `MediaPartnerName` string — The display name of the partner. - `RequestType` 'PROMOCODE_TRACKING' | 'BRANDED_URL_TRACKING' | 'PHONE_NUMBER_TRACKING' — The type of tracking value being requested. - `NumberRequested` integer — The number of tracking values requested. - `PromoCodes` PromoCodeRequestDetail[] — Promo code details, when RequestType is PROMOCODE_TRACKING. - `Id` string — The unique identifier for the promo code request item. - `RequestedPromoCode` string — The promo code the partner requested. - `ApprovedPromoCode` string — The promo code that was actually approved. - `CreditPolicy` 'ALWAYS' | 'INVOLVED' | 'WINNER' — How credit is awarded for actions involving this code. - `MatchMode` 'LI' | 'RE' — LI for Exact match, RE for Regex. - `UniqueUrls` UniqueUrlRequestDetail[] — Unique URL details, when RequestType is BRANDED_URL_TRACKING. - `Id` string — The unique identifier for the unique URL request item. - `Url` string, uri — The unique URL itself. - `PhoneNumbers` PhoneNumberRequestDetail[] — Phone number details, when RequestType is PHONE_NUMBER_TRACKING. - `Id` string — The unique identifier for the phone number request item. - `AssignedPhoneNumberId` string — The unique identifier of the assigned phone number. - `AssignedPhoneNumber` string — The phone number that was assigned. - `State` 'APPROVED' | 'COMPLETED' | 'DECLINED' | 'NEW' — The current state of the request. - `DatePlaced` string, date-time — The date and time the request was placed. - `DateNeeded` string, date-time — The date and time the partner needs the request fulfilled by. - `DateCompleted` string, date-time, nullable — The date and time the request was completed, if applicable. - `AdditionalInstructions` string, nullable — Additional instructions from the partner. - `ProcessingComments` string, nullable — Internal processing comments. - `DealId` integer, nullable — Optional ID of a Deal associated with the request. - `DealName` string — Name of the associated deal. Empty if no deal is associated with the request. - `DealDescription` string — Description of the associated deal — information about it or what it does. Empty if no deal is associated with the request. - `DealState` string — What state the associated deal is in. Empty if no deal is associated. Possible values: `ACTIVE` — currently active; `EXPIRED` — not currently active; `PENDING` — waiting for approval. - `DealType` string — What the associated deal does. Empty if no deal is associated. Possible values: `GENERAL_SALE`, `FREE_SHIPPING`, `GIFT_WITH_PURCHASE`, `REBATE`, `BOGO`. - `DealScope` string — To what extent the deal applies. Possible values: `CATEGORY` — applies to a category of products; `ENTIRE_STORE` — applies to the entire store; `PRODUCT` — applies to a specific product or group. - `DealProducts` object[] — If `DealScope` is `PRODUCT`, an array of product info objects. - `ProductName` string — Product's name. - `ProductImageURL` string, uri — URL that leads to the product's image. - `ProductBeforePriceAmount` number — Product's price prior to the deal applying. - `ProductBeforePriceCurrency` string — Product's currency code prior to the deal applying (ISO 4217). - `ProductAfterPriceAmount` number — Product's price after the deal applies. - `ProductAfterPriceCurrency` string — Product's currency code after the deal applies (ISO 4217). - `DealCategories` string — If `DealScope` is `CATEGORY`, a description of the categories the deal applies to. - `DiscountType` string — Type of discount that applies. Possible values: `FIXED` — fixed amount off; `PERCENT` — percentage off; `PERCENT_RANGE` — percent within a range; `PERCENT_MAXIMUM` — maximum percentage off. - `DiscountAmount` number — If `DiscountType` is `FIXED`, the discount amount. - `DiscountCurrency` string — If `DiscountType` is `FIXED`, the currency code of the discount amount (ISO 4217). - `DiscountPercent` number, float — If `DiscountType` is `PERCENT`, the discount percent. - `DiscountMaximumPercent` number, float — If `DiscountType` is `PERCENT_MAXIMUM`, the maximum discount percentage. - `DiscountPercentRangeStart` number, float — If `DiscountType` is `PERCENT_RANGE`, the discount range beginning. - `DiscountPercentRangeEnd` number, float — If `DiscountType` is `PERCENT_RANGE`, the discount range end. - `Gift` string — If `DealType` is `GIFT_WITH_PURCHASE`, the gift's name. - `RebateAmount` number — If `DealType` is `REBATE`, the rebate amount. - `RebateCurrency` string — If `DealType` is `REBATE`, the rebate currency code (ISO 4217). - `DealDefaultPromoCode` string — Default promo code consumers can use to activate the deal when making a purchase. - `MinimumPurchaseAmount` number — Minimum amount the consumer needs to spend for the deal to apply. - `MinimumPurchaseAmountCurrency` string — Currency of the deal's minimum purchase amount (ISO 4217). - `MaximumSavingsAmount` number — Maximum amount a consumer can save when the deal applies. - `MaximumSavingsCurrency` string — Currency of the deal's maximum savings (ISO 4217). - `BogoBuyQuantity` integer — If `DealType` is `BOGO`, the "buy" quantity required. - `BogoBuyScope` string — If `DealType` is `BOGO`, the "buy" scope. Possible values: `PRODUCT`, `CATEGORY`. - `BogoBuyName` string — If `DealType` is `BOGO`, the "buy" product name. - `BogoBuyImageUrl` string, uri — If `DealType` is `BOGO`, the "buy" product image URL. - `BogoGetQuantity` integer — If `DealType` is `BOGO`, the "get" quantity. - `BogoGetScope` string — If `DealType` is `BOGO`, the "get" scope. Possible values: `PRODUCT`, `CATEGORY`. - `BogoGetDiscountType` string — If `DealType` is `BOGO`, the "get" discount type. Possible values: `FREE` — receive the GET item free; `AMOUNT` — receive a specific money amount off; `PERCENT` — receive a percentage off. - `BogoGetName` string — If `DealType` is `BOGO`, the "get" product name. - `BogoGetImageUrl` string, uri — If `DealType` is `BOGO`, the "get" product image URL. - `BogoGetDiscountAmount` number — If `BogoGetDiscountType` is `AMOUNT`, the "get" discount amount. - `BogoGetDiscountCurrency` string — If `BogoGetDiscountType` is `AMOUNT`, the currency of the "get" discount amount. - `BogoGetDiscountPercent` number, float — If `BogoGetDiscountType` is `PERCENT`, the "get" discount percent. - `PurchaseLimitQuantity` integer — If `DealType` is `BOGO`, the maximum quantity of "buy" product purchasable per transaction. `0` means no purchase limit. - `DealStartDate` string, date-time — Date and time the deal begins (ISO 8601). - `DealEndDate` string, date-time — Date and time the deal ends (ISO 8601). - `SynchAdsPromoCodes` boolean — Whether the deal aligns the state and date range of all associated ads and promo codes to the deal's. - `DealRestrictedMediaPartners` string[] — Array of partner names that can use the deal. - `DealRestrictedMediaPartnerGroups` string[] — Array of partner groups that can use the deal. - `Uri` string, uri-reference — The unique reference to this request in the impact.com API. --- [API](https://skmtc.net/impact/apis/brand-api-account-information.md) · [All operations](https://skmtc.net/impact/apis/brand-api-account-information/llms.txt) · [OpenAPI document](https://skmtc-service-staging.skmtc.workers.dev/v1/apis/impact/brand-api-account-information/revisions/c53422ebb833/schema)