# Models

## The RoutingRule object

```json
{"openapi":"3.1.0","info":{"title":"Brand Routing Rules API","version":"v11"},"components":{"schemas":{"RoutingRule":{"type":"object","properties":{"Id":{"type":"string","description":"The unique identifier for the routing rule."},"Name":{"type":"string","description":"Name of the routing rule."},"Condition":{"type":"array","description":"What triggers the routing rule.","items":{"$ref":"#/components/schemas/Condition"}},"Action":{"type":"string","description":"What traffic will experience if the routing rule is triggered.","enum":["REDIRECT","BLOCK","INTERSTITIAL"]},"RedirectUrl":{"type":"string","format":"uri","description":"The destination URL for REDIRECT-type rules."},"Interstitial":{"$ref":"#/components/schemas/Interstitial","description":"Interstitial page configuration for INTERSTITIAL-type rules."},"Rank":{"type":"string","description":"This determines the specific routing rule's rank in relation to others that have the same conditions.","enum":["HIGH","MEDIUM","LOW"]},"State":{"type":"string","description":"What state of use the routing rule is in.","enum":["RUNNING","PAUSED","ENDED","ARCHIVED"]},"Source":{"type":"string","description":"From where the routing rule was created.","enum":["GENERIC","AD","COMPLIANCE","TASK"]},"StartDate":{"type":"string","format":"date-time","nullable":true,"description":"The date and time the rule becomes active."},"EndDate":{"type":"string","format":"date-time","nullable":true,"description":"The date and time the rule expires."},"DateCreated":{"type":"string","format":"date-time","description":"The date and time the rule was created."},"DateLastUpdated":{"type":"string","format":"date-time","description":"The date and time the rule was last updated."},"CreatedBy":{"type":"string","description":"The account user that created the rule."},"LastUpdatedBy":{"type":"string","description":"The account user that last updated the rule."},"Uri":{"type":"string","format":"uri-reference","description":"The unique reference to this routing rule in the impact.com API."}}},"Condition":{"type":"object","properties":{"SubConditions":{"type":"array","description":"A group of sub-conditions that must all be true for this condition to match (AND logic).","items":{"$ref":"#/components/schemas/SubCondition"}}}},"SubCondition":{"type":"object","properties":{"Variable":{"type":"string","description":"The variable to evaluate against.","enum":["IP_ADDRESS","SHARED_ID","COUNTRY","REGION","AD_STATUS","SUB_ID1","SUB_ID2","SUB_ID3","MP_ID","DEVICE_TYPE","REF_URL","LANDING_PAGE","SKU","AD_ID","CURRENT_DATE","RANDOM","MOBILE_FALLBACK"]},"Operator":{"type":"string","description":"How the variable is compared to the values.","enum":["CONTAINS","STARTS_WITH","ENDS_WITH","EQUALS","MATCHES","IP_RANGE","IN","NOT_CONTAINS","NOT_STARTS_WITH","NOT_ENDS_WITH","NOT_EQUALS","NOT_IN","REGEX","LT","GT"]},"Values":{"type":"array","description":"The values the variable is compared to.","items":{"type":"string"}}}},"Interstitial":{"type":"object","properties":{"HeaderText":{"type":"string","description":"Header text displayed on the interstitial page."},"BodyText":{"type":"string","description":"Body text displayed on the interstitial page."},"RequireUserAcknowledgement":{"type":"boolean","description":"Whether the user must acknowledge before continuing."},"ButtonText":{"type":"string","description":"Text shown on the acknowledgement button."},"ButtonColor":{"type":"string","description":"Color of the acknowledgement button."},"RequireUserInput":{"type":"boolean","description":"Whether the user must provide input before continuing."},"UserInputs":{"type":"array","description":"User input fields shown on the interstitial.","items":{"$ref":"#/components/schemas/UserInput"}},"IncludeSkipOption":{"type":"boolean","description":"Whether to include a skip option."},"ShowPageAtLeastOnce":{"type":"boolean","description":"Whether the page must be shown at least once per session."},"CoBranded":{"type":"boolean","description":"Whether the interstitial is co-branded."},"CustomizeCss":{"type":"boolean","description":"Whether custom CSS is used."},"CustomCss":{"type":"string","description":"Custom CSS for styling the interstitial page."}}},"UserInput":{"type":"object","properties":{"Variable":{"type":"string","description":"The variable the user input populates.","enum":["SHARED_ID","SUB_ID1","SUB_ID2","SUB_ID3","PARAM1","PARAM2","PARAM3","CUSTOMER_ID"]},"DisplayValue":{"type":"string","description":"Display label shown to the user."},"RegularExpression":{"type":"string","description":"Validation pattern for the input."},"ErrorMessage":{"type":"string","description":"Error message shown if validation fails."}}}}}}
```

## The Condition object

```json
{"openapi":"3.1.0","info":{"title":"Brand Routing Rules API","version":"v11"},"components":{"schemas":{"Condition":{"type":"object","properties":{"SubConditions":{"type":"array","description":"A group of sub-conditions that must all be true for this condition to match (AND logic).","items":{"$ref":"#/components/schemas/SubCondition"}}}},"SubCondition":{"type":"object","properties":{"Variable":{"type":"string","description":"The variable to evaluate against.","enum":["IP_ADDRESS","SHARED_ID","COUNTRY","REGION","AD_STATUS","SUB_ID1","SUB_ID2","SUB_ID3","MP_ID","DEVICE_TYPE","REF_URL","LANDING_PAGE","SKU","AD_ID","CURRENT_DATE","RANDOM","MOBILE_FALLBACK"]},"Operator":{"type":"string","description":"How the variable is compared to the values.","enum":["CONTAINS","STARTS_WITH","ENDS_WITH","EQUALS","MATCHES","IP_RANGE","IN","NOT_CONTAINS","NOT_STARTS_WITH","NOT_ENDS_WITH","NOT_EQUALS","NOT_IN","REGEX","LT","GT"]},"Values":{"type":"array","description":"The values the variable is compared to.","items":{"type":"string"}}}}}}}
```

## The SubCondition object

```json
{"openapi":"3.1.0","info":{"title":"Brand Routing Rules API","version":"v11"},"components":{"schemas":{"SubCondition":{"type":"object","properties":{"Variable":{"type":"string","description":"The variable to evaluate against.","enum":["IP_ADDRESS","SHARED_ID","COUNTRY","REGION","AD_STATUS","SUB_ID1","SUB_ID2","SUB_ID3","MP_ID","DEVICE_TYPE","REF_URL","LANDING_PAGE","SKU","AD_ID","CURRENT_DATE","RANDOM","MOBILE_FALLBACK"]},"Operator":{"type":"string","description":"How the variable is compared to the values.","enum":["CONTAINS","STARTS_WITH","ENDS_WITH","EQUALS","MATCHES","IP_RANGE","IN","NOT_CONTAINS","NOT_STARTS_WITH","NOT_ENDS_WITH","NOT_EQUALS","NOT_IN","REGEX","LT","GT"]},"Values":{"type":"array","description":"The values the variable is compared to.","items":{"type":"string"}}}}}}}
```

## The Interstitial object

```json
{"openapi":"3.1.0","info":{"title":"Brand Routing Rules API","version":"v11"},"components":{"schemas":{"Interstitial":{"type":"object","properties":{"HeaderText":{"type":"string","description":"Header text displayed on the interstitial page."},"BodyText":{"type":"string","description":"Body text displayed on the interstitial page."},"RequireUserAcknowledgement":{"type":"boolean","description":"Whether the user must acknowledge before continuing."},"ButtonText":{"type":"string","description":"Text shown on the acknowledgement button."},"ButtonColor":{"type":"string","description":"Color of the acknowledgement button."},"RequireUserInput":{"type":"boolean","description":"Whether the user must provide input before continuing."},"UserInputs":{"type":"array","description":"User input fields shown on the interstitial.","items":{"$ref":"#/components/schemas/UserInput"}},"IncludeSkipOption":{"type":"boolean","description":"Whether to include a skip option."},"ShowPageAtLeastOnce":{"type":"boolean","description":"Whether the page must be shown at least once per session."},"CoBranded":{"type":"boolean","description":"Whether the interstitial is co-branded."},"CustomizeCss":{"type":"boolean","description":"Whether custom CSS is used."},"CustomCss":{"type":"string","description":"Custom CSS for styling the interstitial page."}}},"UserInput":{"type":"object","properties":{"Variable":{"type":"string","description":"The variable the user input populates.","enum":["SHARED_ID","SUB_ID1","SUB_ID2","SUB_ID3","PARAM1","PARAM2","PARAM3","CUSTOMER_ID"]},"DisplayValue":{"type":"string","description":"Display label shown to the user."},"RegularExpression":{"type":"string","description":"Validation pattern for the input."},"ErrorMessage":{"type":"string","description":"Error message shown if validation fails."}}}}}}
```

## The UserInput object

```json
{"openapi":"3.1.0","info":{"title":"Brand Routing Rules API","version":"v11"},"components":{"schemas":{"UserInput":{"type":"object","properties":{"Variable":{"type":"string","description":"The variable the user input populates.","enum":["SHARED_ID","SUB_ID1","SUB_ID2","SUB_ID3","PARAM1","PARAM2","PARAM3","CUSTOMER_ID"]},"DisplayValue":{"type":"string","description":"Display label shown to the user."},"RegularExpression":{"type":"string","description":"Validation pattern for the input."},"ErrorMessage":{"type":"string","description":"Error message shown if validation fails."}}}}}}
```


---

# 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/routing-rules/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.