Routing Rules

List All Routing Rules

get

Returns a list of existing routing rules for a specific program, with options for filtering.

Path parameters

AccountSIDstringRequired

ProgramIdintegerRequired

The ID of the program to retrieve rules from.

Query parameters

NamestringOptional

Conditionstring · enumOptionalPossible values:

Actionstring · enumOptionalPossible values:

Rankstring · enumOptionalPossible values:

Statestring · enumOptionalPossible values:

Sourcestring · enumOptionalPossible values:

StartDateBeforestring · date-timeOptional

Return routing rules that start before a specific date and time (ISO 8601).

StartDateAfterstring · date-timeOptional

Return routing rules that start after a specific date and time (ISO 8601).

EndDateBeforestring · date-timeOptional

Return routing rules that end before a specific date and time (ISO 8601).

EndDateAfterstring · date-timeOptional

Return routing rules that end after a specific date and time (ISO 8601).

DateLastUpdateBeforestring · date-timeOptional

Return routing rules that were last updated before a specific date and time (ISO 8601).

DateLastUpdatedAfterstring · date-timeOptional

Return routing rules that were last updated after a specific date and time (ISO 8601).

DateCreatedBeforestring · date-timeOptional

Return routing rules that were created before a specific date and time (ISO 8601).

DateCreatedAfterstring · date-timeOptional

Return routing rules that were created after a specific date and time (ISO 8601).

CreatedBystringOptional

Return routing rules that were created by a specific account user.

LastUpdatedBystringOptional

Return routing rules that were last updated by a specific account user.

Responses

200

A paginated list of routing rule objects.

application/json

get/Advertisers/{AccountSID}/Programs/{ProgramId}/BlockRedirectRules

HTTPcURLJavaScriptPython

GET /Advertisers/{AccountSID}/Programs/{ProgramId}/BlockRedirectRules HTTP/1.1
Host: api.impact.com
Accept: */*

200

A paginated list of routing rule objects.

{
  "BlockRedirectRules": [
    {
      "Id": "50000",
      "Name": "Redirect 4",
      "Condition": [
        {
          "SubConditions": [
            {
              "Variable": "IP_ADDRESS",
              "Operator": "CONTAINS",
              "Values": [
                "US"
              ]
            }
          ]
        }
      ],
      "Action": "REDIRECT",
      "RedirectUrl": "http://impact.com",
      "Interstitial": {
        "HeaderText": "Welcome to Acme",
        "BodyText": "Please confirm your details to continue.",
        "RequireUserAcknowledgement": true,
        "ButtonText": "Continue",
        "ButtonColor": "#FF0000",
        "RequireUserInput": true,
        "UserInputs": [
          {
            "Variable": "SHARED_ID",
            "DisplayValue": "Email Address",
            "RegularExpression": "^[^@]+@[^@]+\\.[^@]+$",
            "ErrorMessage": "Please enter a valid email address."
          }
        ],
        "IncludeSkipOption": false,
        "ShowPageAtLeastOnce": true,
        "CoBranded": false,
        "CustomizeCss": false,
        "CustomCss": ""
      },
      "Rank": "HIGH",
      "State": "RUNNING",
      "StartDate": "2026-01-01T00:00:00-08:00",
      "EndDate": "2026-12-31T23:59:59-08:00",
      "Source": "GENERIC",
      "DateCreated": "2019-10-28T17:53:01-04:00",
      "DateLastUpdated": "2019-10-28T17:53:01-04:00",
      "CreatedBy": "ACME Corp",
      "LastUpdatedBy": "ACME Corp",
      "Uri": "/Advertisers/<AccountSID>/Programs/1000/BlockRedirectRules/50000"
    }
  ]
}

Get Routing Rule Details

get

Retrieves the details of an existing routing rule by its unique ID.

Path parameters

AccountSIDstringRequired

ProgramIdintegerRequired

RuleIdintegerRequired

The unique identifier for the routing rule.

Responses

200

A single routing rule object.

application/json

IdstringOptionalExample: 50000

NamestringOptional

Name of the routing rule.

Example: Redirect 4

Actionstring · enumOptional

What traffic will experience if the routing rule is triggered.

Example: REDIRECTPossible values:

RedirectUrlstring · uriOptionalExample: http://impact.com

Rankstring · enumOptional

This determines the specific routing rule's rank in relation to others that have the same conditions.

Example: HIGHPossible values:

Statestring · enumOptional

What state of use the routing rule is in.

Example: RUNNINGPossible values:

StartDatestring · date-time · nullableOptional

The date and time the rule becomes active.

Example: 2026-01-01T00:00:00-08:00

EndDatestring · date-time · nullableOptional

The date and time the rule expires.

Example: 2026-12-31T23:59:59-08:00

Sourcestring · enumOptional

From where the routing rule was created.

Example: GENERICPossible values:

DateCreatedstring · date-timeOptionalExample: 2019-10-28T17:53:01-04:00

DateLastUpdatedstring · date-timeOptionalExample: 2019-10-28T17:53:01-04:00

CreatedBystringOptional

Return routing rules that were created by a specific account user.

Example: ACME Corp

LastUpdatedBystringOptional

Return routing rules that were last updated by a specific account user.

Example: ACME Corp

Uristring · uri-referenceOptionalExample: /Advertisers/<AccountSID>/Programs/1000/BlockRedirectRules/50000

get/Advertisers/{AccountSID}/Programs/{ProgramId}/BlockRedirectRules/{RuleId}

HTTPcURLJavaScriptPython

GET /Advertisers/{AccountSID}/Programs/{ProgramId}/BlockRedirectRules/{RuleId} HTTP/1.1
Host: api.impact.com
Accept: */*

200

A single routing rule object.

{
  "Id": "50000",
  "Name": "Redirect 4",
  "Condition": [
    {
      "SubConditions": [
        {
          "Variable": "IP_ADDRESS",
          "Operator": "CONTAINS",
          "Values": [
            "US"
          ]
        }
      ]
    }
  ],
  "Action": "REDIRECT",
  "RedirectUrl": "http://impact.com",
  "Interstitial": {
    "HeaderText": "Welcome to Acme",
    "BodyText": "Please confirm your details to continue.",
    "RequireUserAcknowledgement": true,
    "ButtonText": "Continue",
    "ButtonColor": "#FF0000",
    "RequireUserInput": true,
    "UserInputs": [
      {
        "Variable": "SHARED_ID",
        "DisplayValue": "Email Address",
        "RegularExpression": "^[^@]+@[^@]+\\.[^@]+$",
        "ErrorMessage": "Please enter a valid email address."
      }
    ],
    "IncludeSkipOption": false,
    "ShowPageAtLeastOnce": true,
    "CoBranded": false,
    "CustomizeCss": false,
    "CustomCss": ""
  },
  "Rank": "HIGH",
  "State": "RUNNING",
  "StartDate": "2026-01-01T00:00:00-08:00",
  "EndDate": "2026-12-31T23:59:59-08:00",
  "Source": "GENERIC",
  "DateCreated": "2019-10-28T17:53:01-04:00",
  "DateLastUpdated": "2019-10-28T17:53:01-04:00",
  "CreatedBy": "ACME Corp",
  "LastUpdatedBy": "ACME Corp",
  "Uri": "/Advertisers/<AccountSID>/Programs/1000/BlockRedirectRules/50000"
}