URL Suffixes & Query Strings
Last Updated: 01 Jul 2020
There are a number of URL suffixes and query strings that you can use in Matrix to either make the page be presented in a certain way, or to perform some type of action.
The table below lists all of the available suffixes and query strings that are available. Note that some of these are only available under certain conditions (such as what permission access you have) and some also depend on the version of Squiz Matrix you are on.
Suffixes
Suffixes are strings that can be added to the end of a URL, either on the root of the site domain or on a particular page URL. For example, https://www.example.com/_admin or https://www.example.com/page/_admin
| Suffix | Description |
|---|---|
/_admin | Access the Admin interface of the Squiz matrix system. If entered on a particular page URL, the Admin interface will also attempt to load the asset under that URL by default. |
/_edit | Access the Edit mode interface of a specific site or page. |
/_login | Access the login screen for a particular site or page. This can be used either when you are already logged in or when you are un-authenticated. |
/_editplusapi | The URL of the Edit+ API JavaScript file. This is used by the Edit+ extension to make web service calls to power the interface functionality. |
/_nocache | Use this to serve the page without Matrix cache. This will also force Matrix to send a Cache-Control: no-store, no-cache header to ensure the page doesn't get cached in any accelerator cache or the user's browser cache. Note that this will not re-populate the cache with the un-cached content, use /_recache for that. |
/_noproxycache | Similar to the /_nocache suffix, except it won't force Matrix to generate a fresh page with no Matrix cache. It will just make sure that Matrix sends a Cache-Control: no-store, no-cache header when viewing the page. |
/_recache | This has the same affect as /_nocache, but it will also re-prime the internal Matrix cache for that particular page. This means that if you then visit the page again without a suffix, you will see a fresh copy of the page. |
/_performance | Access Performance Mode, on the current page. This will show you all the assets that were used to build the current page and how many internal PHP requests were made in doing so. |
Query Strings
Query strings are usually used with a parameter and value combination and can be used in conjunction with URL suffixes. Some query strings also don't need a value however and simply just consist of the parameter.
| Query String | Description |
|---|---|
?SQ_ACTION=view_live | Show the Live version of an asset that is currently in a Safe Edit type status. |
?SQ_ACTION=diff | Show the difference between the Live version of an asset and its Safe Edit version, highlighting which bits of the content has been added and removed. |
?SQ_ACTION=login&FORCE_BACKUP_LOGIN=1 | Show the backup login screen to log in to the Squiz Matrix system. |
?SQ_ACTION=logout | Instantly log out of the Squiz Matrix system. |
?force=true | Used on OAuth 2 Token assets to force the generation of a new access token. |
?SQ_ASSET_CONTENTS | Show the contents of the page without any Design applied. You can add asset IDs to this URL parameter to specify the content containers to print for example: ?SQ_ASSET_CONTENTS=111,222. Note that you can't specify a container that is being nested in the current page. |
?SQ_ASSET_CONTENTS_RAW | Show the contents of the page without any Design or Paint Layout applied. You can also pass individual content container IDs to this parameter, similar to the ?SQ_ASSET_CONTENTS parameter. |
?SQ_DISABLE_SERVER_JS | Disables all JavaScript using the runat="server" method from running on the server. You must have write access to the content component for this query string to work. See the Server Side JavaScript documentation for more details about this query string. |
?SQ_VIEW_SERVER_JS | View the full output of the JavaScript code sent to the JavaScript engine in Matrix. Use this query string to help with debugging your frontend JavaScript code. See the Server Side JavaScript documentation for more details about this query string. |
?SQ_PAINT_LAYOUT=1234 | View the current page with a particular Paint Layout applied where 1234 is the asset ID of the Paint Layout. |
?SQ_PAINT_LAYOUT_NAME=custom_name | View the current page with a Paint Layout applied based on the custom paint layout name setting on the Paint Layouts screen of the asset. |
?SQ_DESIGN_NAME=custom_name | View the current page with a Design applied based on the custom design name setting on the Settings screen of the asset. |