Skip to main content

Search Redirects

Search Redirects

Route high-intent queries to curated destinations when direct result lists are not ideal.

Audience: Search and merchandising teams controlling query landing behavior.

Critical: Redirect definitions are managed at /api/v1/sites/:siteId/search/analytics/redirects with matchType exact, contains, or regex.

Who This Page Is For

Use this page when specific queries should open curated category pages, campaign pages, or brand pages instead of generic search results.

Quick Start (2-5 Minutes)

1

List redirects

Review existing query routing behavior.

GET /api/v1/sites/:siteId/search/analytics/redirects
2

Create exact redirect

Map one high-intent query to one destination.

{ "queryPattern": "black friday", "matchType": "exact", "redirectUrl": "/collections/black-friday" }
3

Create contains/regex rule

Handle broader phrase families carefully.

{ "queryPattern": "gift", "matchType": "contains", "redirectUrl": "/collections/gifts" }
4

Disable quickly

Set isActive=false to rollback without delete.

PUT /api/v1/sites/:siteId/search/analytics/redirects/:redirectId
5

Delete obsolete rule

Remove stale seasonal redirects.

DELETE /api/v1/sites/:siteId/search/analytics/redirects/:redirectId

Required Fields / Minimum Payload

FieldRequiredTypeUsed by eventsDescription
queryPatternRequiredstringCreate/update redirectPattern compared against incoming search query.
matchTypeOptionalexact | contains | regexCreate/update redirectMatching strategy; default behavior should be explicit in payload.
redirectUrlRequiredstringCreate/update redirectTarget route for matched query.
isActiveOptionalbooleanUpdate redirectUse for safe disable before permanent deletion.

Redirect endpoints

GET    /api/v1/sites/:siteId/search/analytics/redirects
POST   /api/v1/sites/:siteId/search/analytics/redirects
PUT    /api/v1/sites/:siteId/search/analytics/redirects/:redirectId
DELETE /api/v1/sites/:siteId/search/analytics/redirects/:redirectId

Event or Endpoint Decision Matrix

ScenarioUse ThisWhy
One exact query should redirectmatchType=exactMost deterministic and lowest risk.
Phrase family should redirectmatchType=containsCaptures broad intent group quickly.
Complex query patterns neededmatchType=regexAdvanced control for power users.
Need temporary rollbackPUT ... isActive=falseDisables behavior immediately without deleting definition.
Need to retire rule permanentlyDELETE redirectRemoves stale logic from system.

Common Errors and Fixes

Users redirected too often

Cause: contains or regex pattern too broad.

Fix: Tighten queryPattern or switch to exact matching.

Redirect never triggers

Cause: matchType mismatch with query normalization.

Fix: Inspect normalized query and adjust pattern.

Loop-like navigation behavior

Cause: redirectUrl points to route that triggers same search term flow.

Fix: Use terminal destination pages without recursive search logic.

Invalid redirect URL errors

Cause: Malformed target URL string.

Fix: Use valid absolute or application-relative route format.

Production Checklist

  • Exact matching is preferred for high-impact queries.Required
  • Regex rules are documented and reviewed by two people.Required
  • Redirect performance is monitored in search analytics trends.Required
  • Seasonal redirect rules have an expiration plan.Required
  • Rollback path uses isActive toggle before delete.Required

Next Steps