The Search macro searches your Confluence site based on search terms specified in the macro code, and displays the results on the wiki page.

On this page:

Usage with the Macro Browser

To insert the search macro into a page using the Macro Browser,

  1. Open your desired Confluence page, then click the 'Edit' button. The 'Edit Page' mode opens.
  2. Next, click the Macro Browser icon on the editor toolbar. The Macro Browser will open in the middle of the screen.
  3. In the Macro Browser, type the name of your desired macro into the search box at the top right of the window. Macros with a matching name will appear in the centre pane. Click on the desired macro to see its options screen. Here, you can set the macro parameters then click 'insert' to put the macro into the page.

Once you've found the search macro and have added the required parameter values, click 'insert' to add it to your page.

Usage with the Wiki Markup Editor

In the example below, we assume that you want to search for all pages and other content types which contain the term 'my_query'.

What you need to type

What you will get

{search:query=my_query}

Found 0 search result(s) for my_query.

Parameters

Parameters are settings for Confluence macros that allow the user to control their content or presentation. The table below lists relevant parameters for this macro.

(info) Parameter names are displayed differently in the macro browser interface and in wiki markup. Below, parameter names used in the macro browser are indicated in Bold text, while their equivalents in wiki markup are indicated in (bracketed) text. If the latter is not shown, then in wiki markup, the parameter's name should be omitted and only its value should be added immediately after the colon symbol (:).

Parameter

Required?

Default

Description

Search Terms
(query)

yes

none

The search terms which this macro will use to generate its results.

You can refine your search query by using operators such as 'AND' and 'OR'. For example:

  • In the macro browser Search Terms entry box: my_query1 AND my_query2

  • In wiki markup editor: {search:query=my_query1 AND my_query2}

    For more information, take a look at the documentation on the Confluence search syntax.

Maximum Number of Results
(maxLimit)

no

10

Set a limit to the number of search results displayed.

Restrict to this Space Key
(spacekey)

no

all

Specify the key of the space you want to search in. Note that this is case sensitive.

Content Type
(type)

no

all

Specify the content type. The content types are: page, comment, blogpost, attachment, userinfo (the content of user profiles only), spacedesc (the content of space descriptions only) and mail.

Last Modified
(lastModified)

no

all

Specify a period of time in weeks, days, hours and/or minutes, to see the content modified within that time frame. For example:

  • 2h 35m
  • 3d 30m
    These are the values you can use:
  • w = weeks
  • d = days
  • h = hours
  • m = minutes
    If no time category is specified, Confluence assumes minutes.
    If you specify more than one time period (e.g. weeks and days), the periods must be separated by a space and they can come in any order.
    The time categories are not case sensitive e.g. '4d' is the same as '4D'.

Restrict to this Username
(contributor)

no

all

Specify the username of a Confluence user, to show only content created or updated by that user.

1. Setting a limit to the number of search results displayed

Display a maximum of 20 results.

{search:query=my_query|maxLimit=20}

2. Specifying the key of the space you want to search

Global space: Search within the Doctemp space only.

{search:query=my_query|spacekey=Doctemp}

Personal space: Search within jsmith's space only.

{search:query=my_query|spacekey=~jsmith}

3. Specifying the content type

Search within comments only.

{search:query=my_query|type=comment}

4. Specifying a time period in which the content was last modified

Search for content modified in the last one week and two days.

{search:query=my_query|lastModified=1w 2d}

5. Limiting the search results to content created or modified by a specific user

Search within content created or updated by jsmith only.

{search:query=my_query|contributor=jsmith}

Permissions

When a user views the page containing the Search macro, the search results will show only pages and other content types for which the user has 'View' permission.

RELATED TOPICS

Livesearch Macro
Searching Confluence
Working with Macros

Take me back to the Confluence User Guide.

Except where otherwise noted, content in this space is licensed under a Creative Commons Attribution 2.5 Australia License.