# Models

## The TrackingValueRequest object

```json
{"openapi":"3.1.0","info":{"title":"Brand Tracking Value Requests API","version":"v11"},"components":{"schemas":{"TrackingValueRequest":{"type":"object","properties":{"Id":{"type":"string","description":"The unique identifier for the tracking value request."},"CampaignId":{"type":"integer","description":"The ID of the program the request is for."},"CampaignName":{"type":"string","description":"The display name of the program."},"MediaPartnerId":{"type":"integer","description":"The unique identifier of the partner making the request."},"MediaPartnerName":{"type":"string","description":"The display name of the partner."},"RequestType":{"type":"string","description":"The type of tracking value being requested.","enum":["PROMOCODE_TRACKING","BRANDED_URL_TRACKING","PHONE_NUMBER_TRACKING"]},"NumberRequested":{"type":"integer","description":"Number of requested tracking values."},"PromoCodes":{"type":"array","description":"Promo code details, when RequestType is PROMOCODE_TRACKING.","items":{"$ref":"#/components/schemas/PromoCodeDetail"}},"UniqueUrls":{"type":"array","description":"Unique URL details, when RequestType is BRANDED_URL_TRACKING.","items":{"type":"object","properties":{"Id":{"type":"string","description":"The unique identifier for the unique URL."},"Url":{"type":"string","description":"The unique URL itself."}}}},"PhoneNumbers":{"type":"array","description":"Phone number details, when RequestType is PHONE_NUMBER_TRACKING.","items":{"type":"object","properties":{"Id":{"type":"string","description":"The unique identifier for the request item."},"AssignedPhoneNumberId":{"type":"string","description":"The unique identifier of the assigned phone number."},"AssignedPhoneNumber":{"type":"string","description":"The phone number that was assigned."}}}},"State":{"type":"string","description":"The current state of the request.","enum":["APPROVED","COMPLETED","DECLINED","NEW"]},"DatePlaced":{"type":"string","format":"date-time","description":"The date and time the request was placed."},"DateNeeded":{"type":"string","format":"date-time","description":"The date and time the partner needs the request fulfilled by."},"DateCompleted":{"type":"string","format":"date-time","nullable":true,"description":"The date and time the request was completed, if applicable."},"AdditionalInstructions":{"type":"string","description":"Any additional instructions the partner has for the request."},"ProcessingComments":{"type":"string","description":"Any comments you have about the request that came up during processing."},"DealId":{"type":"string","description":"Id of the associated deal. Empty if no deal is associated with the request."},"DealName":{"type":"string","description":"Name of the associated deal. Empty if no deal is associated with the request."},"DealDescription":{"type":"string","description":"Description of the associated deal — information about it or what it does. Empty if no deal is associated with the request."},"DealState":{"type":"string","description":"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":{"type":"string","description":"What the associated deal does. Empty if no deal is associated. Possible values: `GENERAL_SALE`, `FREE_SHIPPING`, `GIFT_WITH_PURCHASE`, `REBATE`, `BOGO`."},"DealScope":{"type":"string","description":"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":{"type":"array","description":"If `DealScope` is `PRODUCT`, an array of product info objects.","items":{"type":"object","properties":{"ProductName":{"type":"string","description":"Product's name."},"ProductImageURL":{"type":"string","format":"uri","description":"URL that leads to the product's image."},"ProductBeforePriceAmount":{"type":"number","format":"decimal","description":"Product's price prior to the deal applying."},"ProductBeforePriceCurrency":{"type":"string","description":"Product's currency code prior to the deal applying (ISO 4217)."},"ProductAfterPriceAmount":{"type":"number","format":"decimal","description":"Product's price after the deal applies."},"ProductAfterPriceCurrency":{"type":"string","description":"Product's currency code after the deal applies (ISO 4217)."}}}},"DealCategories":{"type":"string","description":"If `DealScope` is `CATEGORY`, a description of the categories the deal applies to."},"DiscountType":{"type":"string","description":"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":{"type":"number","format":"decimal","description":"If `DiscountType` is `FIXED`, the discount amount."},"DiscountCurrency":{"type":"string","description":"If `DiscountType` is `FIXED`, the currency code of the discount amount (ISO 4217)."},"DiscountPercent":{"type":"number","format":"float","description":"If `DiscountType` is `PERCENT`, the discount percent."},"DiscountMaximumPercent":{"type":"number","format":"float","description":"If `DiscountType` is `PERCENT_MAXIMUM`, the maximum discount percentage."},"DiscountPercentRangeStart":{"type":"number","format":"float","description":"If `DiscountType` is `PERCENT_RANGE`, the discount range beginning."},"DiscountPercentRangeEnd":{"type":"number","format":"float","description":"If `DiscountType` is `PERCENT_RANGE`, the discount range end."},"Gift":{"type":"string","description":"If `DealType` is `GIFT_WITH_PURCHASE`, the gift's name."},"RebateAmount":{"type":"number","format":"decimal","description":"If `DealType` is `REBATE`, the rebate amount."},"RebateCurrency":{"type":"string","description":"If `DealType` is `REBATE`, the rebate currency code (ISO 4217)."},"DealDefaultPromoCode":{"type":"string","description":"Default promo code consumers can use to activate the deal when making a purchase."},"MinimumPurchaseAmount":{"type":"number","format":"decimal","description":"Minimum amount the consumer needs to spend for the deal to apply."},"MinimumPurchaseAmountCurrency":{"type":"string","description":"Currency of the deal's minimum purchase amount (ISO 4217)."},"MaximumSavingsAmount":{"type":"number","format":"decimal","description":"Maximum amount a consumer can save when the deal applies."},"MaximumSavingsCurrency":{"type":"string","description":"Currency of the deal's maximum savings (ISO 4217)."},"BogoBuyQuantity":{"type":"integer","description":"If `DealType` is `BOGO`, the \"buy\" quantity required."},"BogoBuyScope":{"type":"string","description":"If `DealType` is `BOGO`, the \"buy\" scope. Possible values: `PRODUCT`, `CATEGORY`."},"BogoBuyName":{"type":"string","description":"If `DealType` is `BOGO`, the \"buy\" product name."},"BogoBuyImageUrl":{"type":"string","format":"uri","description":"If `DealType` is `BOGO`, the \"buy\" product image URL."},"BogoGetQuantity":{"type":"integer","description":"If `DealType` is `BOGO`, the \"get\" quantity."},"BogoGetScope":{"type":"string","description":"If `DealType` is `BOGO`, the \"get\" scope. Possible values: `PRODUCT`, `CATEGORY`."},"BogoGetDiscountType":{"type":"string","description":"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":{"type":"string","description":"If `DealType` is `BOGO`, the \"get\" product name."},"BogoGetImageUrl":{"type":"string","format":"uri","description":"If `DealType` is `BOGO`, the \"get\" product image URL."},"BogoGetDiscountAmount":{"type":"number","format":"decimal","description":"If `BogoGetDiscountType` is `AMOUNT`, the \"get\" discount amount."},"BogoGetDiscountCurrency":{"type":"string","description":"If `BogoGetDiscountType` is `AMOUNT`, the currency of the \"get\" discount amount."},"BogoGetDiscountPercent":{"type":"number","format":"float","description":"If `BogoGetDiscountType` is `PERCENT`, the \"get\" discount percent."},"PurchaseLimitQuantity":{"type":"integer","description":"If `DealType` is `BOGO`, the maximum quantity of \"buy\" product purchasable per transaction. `0` means no purchase limit."},"DealStartDate":{"type":"string","format":"date-time","description":"Date and time the deal begins (ISO 8601)."},"DealEndDate":{"type":"string","format":"date-time","description":"Date and time the deal ends (ISO 8601)."},"SynchAdsPromoCodes":{"type":"boolean","description":"Whether the deal aligns the state and date range of all associated ads and promo codes to the deal's."},"DealRestrictedMediaPartners":{"type":"array","description":"Array of partner names that can use the deal.","items":{"type":"string"}},"DealRestrictedMediaPartnerGroups":{"type":"array","description":"Array of partner groups that can use the deal.","items":{"type":"string"}},"Uri":{"type":"string","format":"uri-reference","description":"The unique reference to this request in the impact.com API."}}},"PromoCodeDetail":{"type":"object","properties":{"Id":{"type":"string","description":"The unique identifier for the promo code request item."},"RequestedPromoCode":{"type":"string","description":"The promo code the partner requested."},"ApprovedPromoCode":{"type":"string","description":"The promo code that was actually approved."},"CreditPolicy":{"type":"string","description":"How credit is awarded for actions involving this code.","enum":["ALWAYS","INVOLVED","WINNER"]},"MatchMode":{"type":"string","description":"LI for Exact match, RE for Regex.","enum":["LI","RE"]}}}}}}
```

## The PromoCodeDetail object

```json
{"openapi":"3.1.0","info":{"title":"Brand Tracking Value Requests API","version":"v11"},"components":{"schemas":{"PromoCodeDetail":{"type":"object","properties":{"Id":{"type":"string","description":"The unique identifier for the promo code request item."},"RequestedPromoCode":{"type":"string","description":"The promo code the partner requested."},"ApprovedPromoCode":{"type":"string","description":"The promo code that was actually approved."},"CreditPolicy":{"type":"string","description":"How credit is awarded for actions involving this code.","enum":["ALWAYS","INVOLVED","WINNER"]},"MatchMode":{"type":"string","description":"LI for Exact match, RE for Regex.","enum":["LI","RE"]}}}}}}
```

## The StatusResponse object

```json
{"openapi":"3.1.0","info":{"title":"Brand Tracking Value Requests API","version":"v11"},"components":{"schemas":{"StatusResponse":{"type":"object","properties":{"Status":{"type":"string","description":"Indicates whether the operation was successful."},"Uri":{"type":"string","format":"uri-reference","description":"The unique reference to the affected request."}}}}}}
```


---

# Agent Instructions: Querying This Documentation

If you need additional information that is not directly available in this page, you can query the documentation dynamically by asking a question.

Perform an HTTP GET request on the current page URL with the `ask` query parameter:

```
GET https://integrations.impact.com/brand-api-reference/brand-api-reference-v11/reference/tracking-value-requests/models.md?ask=<question>
```

The question should be specific, self-contained, and written in natural language.
The response will contain a direct answer to the question and relevant excerpts and sources from the documentation.

Use this mechanism when the answer is not explicitly present in the current page, you need clarification or additional context, or you want to retrieve related documentation sections.