v1

latestOpenAPI 3.1.02026-07-241765501.1 MB

Redirect rules

Retrieve redirect rule

🔐 This endpoint requires HTTP authentication (either Basic or Bearer). For authenticating with Bearer token, required scopes are: redirects(r).

Retrieve a redirect rule

get/v1/redirect_rules/{redirect_rule_id}

redirect_rule_idinteger required

keystring required

The key of the index to use.

Example:key_K2pX7vBnU0bgA5xp

cstring

The ID of the client and version that the request is coming from, such as cio-js-2.90.

Example:cio-js-2.90

idinteger required

The identifier for the redirect rule match.

start_timestring date-time

The start time for the redirect rule.

end_timestring date-time

The end time for the redirect rule.

urlstring required

The target URL for redirect the rule.

metadataobject

The metadata for the redirect rule.

last_updatedstring date-time

The last updated time for the redirect rule.

user_segmentsstring[]

A list of user segments for the redirect rule.

{
  "matches": [
    {
      "pattern": "take me here",
      "match_type": "EXACT"
    }
  ]
}