Skip to content

Latest commit

 

History

History
20 lines (12 loc) · 1.41 KB

Redirect.md

File metadata and controls

20 lines (12 loc) · 1.41 KB

Redirect

Redirect contains a target that you can redirect users to if their search query matches a certain condition.

Properties

Name Type Description Notes
collectionId String Output only. The ID of the collection that owns this redirect. [optional] [readonly]
condition String A condition expression applied to a search request that determines whether a search is redirected. For example, to redirect if the user's query is `apples`, set condition to `q = 'apples'`.
createTime OffsetDateTime Output only. Time the redirect was created. [optional] [readonly]
disabled Boolean If disabled, the redirect is never triggered. [optional]
id String Output only. The redirect's ID. [optional] [readonly]
target String The target to redirect the user to if their query matches `condition`. For searches performed in a browser, target is usually a URL but it can be any value that your integration can interpret as a redirect. For example, for URLs that you need to resolve at runtime, target might be a URL template string. For apps, target might be a unique identifier used to send the user to the correct view.
updateTime OffsetDateTime Output only. Time the redirect was last updated. [optional] [readonly]