> For the complete documentation index, see [llms.txt](https://integrations.impact.com/llms.txt). Markdown versions of documentation pages are available by appending `.md` to page URLs; this page is available as [Markdown](https://integrations.impact.com/brand-api-reference/brand-api-reference-v13/reference/routing-rules/models.md).

# Models

## The RoutingRule object

```json
{"openapi":"3.1.0","info":{"title":"Brand API - Routing Rules","version":"v13"},"components":{"schemas":{"RoutingRule":{"type":"object","properties":{"Id":{"type":"string"},"Name":{"type":"string","description":"Name of the routing rule."},"Condition":{"type":"array","items":{"type":"object","properties":{"SubConditions":{"type":"array","items":{"$ref":"#/components/schemas/SubCondition"}}}},"description":"What triggers the routing rule."},"Action":{"type":"string","enum":["REDIRECT","BLOCK","INTERSTITIAL"],"description":"What traffic will experience if the routing rule is triggered."},"RedirectUrl":{"type":"string","format":"uri"},"Interstitial":{"$ref":"#/components/schemas/Interstitial"},"Rank":{"type":"string","enum":["HIGH","MEDIUM","LOW"],"description":"This determines the specific routing rule's rank in relation to others that have the same conditions."},"State":{"type":"string","enum":["RUNNING","PAUSED","ENDED","ARCHIVED"],"description":"What state of use the routing rule is in."},"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."},"Source":{"type":"string","enum":["GENERIC","AD","COMPLIANCE","TASK"],"description":"From where the routing rule was created."},"DateCreated":{"type":"string","format":"date-time"},"DateLastUpdated":{"type":"string","format":"date-time"},"CreatedBy":{"type":"string","description":"Return routing rules that were created by a specific account user."},"LastUpdatedBy":{"type":"string","description":"Return routing rules that were last updated by a specific account user."},"Uri":{"type":"string","format":"uri-reference"}}},"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","nullable":true,"description":"Body text displayed on the interstitial page."},"RequireUserAcknowledgement":{"type":"boolean","description":"Whether the user must acknowledge before continuing."},"ButtonText":{"type":"string","nullable":true,"description":"Text shown on the acknowledgement button."},"ButtonColor":{"type":"string","nullable":true,"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":{"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."}}}},"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","nullable":true,"description":"Custom CSS for styling the interstitial page."}}}}}}
```

## The SubCondition object

```json
{"openapi":"3.1.0","info":{"title":"Brand API - Routing Rules","version":"v13"},"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 API - Routing Rules","version":"v13"},"components":{"schemas":{"Interstitial":{"type":"object","properties":{"HeaderText":{"type":"string","description":"Header text displayed on the interstitial page."},"BodyText":{"type":"string","nullable":true,"description":"Body text displayed on the interstitial page."},"RequireUserAcknowledgement":{"type":"boolean","description":"Whether the user must acknowledge before continuing."},"ButtonText":{"type":"string","nullable":true,"description":"Text shown on the acknowledgement button."},"ButtonColor":{"type":"string","nullable":true,"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":{"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."}}}},"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","nullable":true,"description":"Custom CSS for styling the interstitial page."}}}}}}
```


---

# Agent Instructions
This documentation is published with GitBook. GitBook is the documentation platform designed so that both humans and AI agents can read, navigate, and reason over technical content effectively. Learn more at gitbook.com.

## 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, and the optional `goal` query parameter:

```
GET https://integrations.impact.com/brand-api-reference/brand-api-reference-v13/reference/routing-rules/models.md?ask=<question>&goal=<endgoal>
```

`ask` is the immediate question: it should be specific, self-contained, and written in natural language.
`goal` is optional and describes the broader end goal you are ultimately trying to accomplish on behalf of the user. GitBook uses it to tailor the answer towards what is most useful for that goal.

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.