Search

Search Operators

You can use our search operators to refine your results on the Search page.

By default, all queries will use `AND` when combining multiple operators. 

Below are a complete list of our search operators and their definitions:

Text

The following operators match text -- they can be single words that contain no spaces, or quoted strings that may contain spaces. 

Note: For best results, text strings (such as long Story titles or search phrases) should be in double quotes. For example:

epic:"all your epics are belong to us"
  • epic:text

Search by Epic

  • label:text
  • project:text
  • state:text

Number

The id: operator allows you to search for Stories by Story number.

  • id:number

Search by Story ID

Workflow States

The state: operator can be used with either a Workflow Name (which is text search on workflow state names) or a Workflow ID. 

If you use the Workflow ID, note that it is Team-specific, meaning it will return results only for Stories in a specific team (even if the text-based State name, ex. Unscheduled, is the same across Teams).

In the example below, 500000016 is the Workflow ID for the Unscheduled State in one Team in this Workspace.

If you use the Workflow Name with the operator, state:Unscheduled, it will search across Teams based on the text of the name. You can see that in addition to the search results returned using 500000016, using the name Unscheduled returns results from all Teams in the Workspace. 

Searching across Workflow States

In addition to the state: operator, the following operators search over the different types of workflow states.

Since stories can only have one workflow state, using more than one of these operators can yield no results.

  • is:unstarted
  • is:started
  • is:done

Usernames

Stories that have owners and/or requesters can be found by using either of the following operators (the argument must be a complete username in order to match): 

  • owner:username

Search by Owner

  • requester:usernameDo not include the @ symbol at the beginning of the user name.

Story Types

A story can have one of three types: Feature, Bug, and Chore. A query that contains more than one unique type operator will yield no results.

  • type:feature|bug|chore

Search by Story Type -- Feature

Estimate

For Stories that use an Estimate scale, you can use the following operators. 

  • estimate:integer

Search for Estimated Points

  • is:unestimated - if there is no estimate set

Deadline

  • has:deadline - if a due date is set
  • is:overdue - if the due date is in the past

Relationships

These operators search for Stories that use our Story Relationship feature. 

  • is:blocked - if the story is blocked by another story
  • is:blocker - if the story blocks another story

Child Entities

If a story contains any of the following entities, using these operators will filter the results to include only those stories.

  • has:attachment - only searches for attached files, but not anything pasted or uploaded in comments. 
  • has:comment
  • has:epic
  • has:owner
  • has:task

Archived

In general, archived stories will not rank high in the results.

  •  is:archived 

Inversions

Of note, you can search for the inverse of an operator by adding an ! or - in front of the operator. 

For example, i.e. !has:comment and -has:comment will return Stories with no comments.

Search for Stories without Comments

Search by Date 

You can search for Stories using dates and date ranges in the Search field at the top of the app or on the Search page using the operators below.

Date Formatting

First, it's important to use the correct date formatting in your searches. The format Clubhouse recognizes is 4 digit year-2 digit month-2 digit day: 

YYYY-MM-DD

When searching for a date range, separate your dates with two periods:

YYYY-MM-DD..YYYY-MM-DD

You can make your date range open-ended (or unbounded, in search parlance) by adding an asterisk (*) on one side of the range. 

An asterisk on the left side of the date range would find you all Stories before the specified date:

*..YYYY-MM-DD

And an asterisk on the right side of the date range would find you all Stories after the specified date: 

YYYY-MM-DD..*

You can also search using the terms yesterday and today, as well as tomorrow (but this latter term can only be used when searching for due dates, more on this below).

Please note that numerical date values and date terms currently can't be mixed -- so a search for '2018-04-01..today' wouldn't work, for example.

Date-Based Operators

You can search for Stories that have been created, updated, completed, or moved using a specified date or date range, or the terms yesterday or today.

You can also search for Stories that are (or were) due on a specified date or date range, or using the terms yesterday, today, or tomorrow.

Examples:

  • created:2018-05-22

Search_for_Stories_Created_on_a_Specified_Date.png

  • updated:today

Note: The updated operator will find Stories that have had changes or additions made to it on or within the specific time period (i.e., changes in description, comments, state, due date, Project, Epic, etc.).

Search_for_Stories_Updated_Today.png

  • moved:*..2016-11-17

Note: The moved operator will only find Stories that have changed workflow state (i.e., those which have "moved" to a different workflow state column) on or within a specified time period.

Search_for_Stories_Moved_Using_an_Unbounded_Date_Range.png

  • completed:2018-04-01..2018-05-22

Searching_for_Stories_Completed_in_a_Date_Range.png

  • due:tomorrow

Searching_for_Stories_Due_Tomorrow.png

 

Have more questions? Submit a request

0 Comments

Please sign in to leave a comment.
Powered by Zendesk