Dashboard Macro Reference
This article lists the supported dashboard macros. For more information about the macros, see Dashboard Macros.
- Source examples are examples of what can be typed into an embedded web content widget or text box.
- Target examples are examples of macro outputs, or the sorts of dynamic workspace values that can replace a certain type of macro.
In GoodData, terms workspace and project denote the same entity. For example, project ID is exactly the same as workspace ID. See Find the Workspace ID.
HOST_NAME
| Description | The URL of the currently used domain |
| Can be used in | Embedded web content widgets only |
| Syntax | %HOST_NAME% |
| Source example | %HOST_NAME% |
| Target example | secure.gooddata.com |
CURRENT_PROJECT_HASH
| Description | The ID of the currently selected workspace |
| Can be used in | Embedded web content widgets only |
| Syntax | %CURRENT_PROJECT_HASH% |
| Source example | %CURRENT_PROJECT_HASH% |
| Target example | e863ii0azrnng2zt4fuu81ifgqtyeoj21 |
CURRENT_DASHBOARD_URI
| Description | The URI of the currently selected dashboard (in encoded form) |
| Can be used in | Embedded web content widgets only |
| Syntax | %CURRENT_DASHBOARD_URI% |
| Source example | %CURRENT_DASHBOARD_URI% |
| Target example | %2Fgdc%2Fmd%2Fe863ii0azrnng2zt4fuu81ifgqtyeoj21%2Fobj%2F1952 |
CURRENT_DASHBOARD_TAB_URI
| Description | The identifier of the currently selected dashboard tab |
| Can be used in | Embedded web content widgets only |
| Syntax | %CURRENT_DASHBOARD_TAB_URI% |
| Source example | %CURRENT_DASHBOARD_TAB_URI% |
| Target example | 85f6945b672d |
CURRENT_USER_EMAIL_MD5
| Description | The MD5-hashed email address of the current user |
| Can be used in | Embedded web content widgets only |
| Syntax | %CURRENT_USER_EMAIL_MD5% |
| Source example | %CURRENT_USER_EMAIL_MD5% |
| Target example | 02b658338e9d004709a94c8b3b46f01b3 |
DATE_FILTER_VALUE
| Description | The value that is currently selected in a date filter |
| Can be used in | Embedded web content widgets and text boxes |
| Syntax |
|
| Source example | %DATE_FILTER_VALUE(closed.date,FROM)% |
| Target example | 2010-10-28 |
FILTER_VALUE
| Description | The URI of the value that is currently selected in an attribute filter (in encoded format) This macro returns a single filter value and does not support multiple values selected in the filter simultaneously. |
| Can be used in | Embedded web content widgets only |
| Syntax |
|
| Source example | %FILTER_VALUE(attr.education)% |
| Target example | %2Fgdc%2Fmd%2Fe863ii0azrnng2zt4fuu81ifgqtyeoj21%2Fobj%2F263%2Felements%3Fid%3D30 |
FILTER_TITLE
| Description | The value that is currently selected in an attribute filter If multiple values are selected in the attribute filter, the values are returned separated by comma. |
| Can be used in | Embedded web content widgets and text boxes |
| Syntax |
|
| Source example | %FILTER_TITLE(attr.education)% |
| Target example | Consulting, Tech, Telecom |
VARIABLE_VALUE
| Description | The value that is currently selected in a variable filter
|
| Can be used in | Embedded web content widgets only |
| Syntax |
|
| Source example |
Use the URL of the GoodData's Amazon S3 bucket and not your workspace URL when using the |
| Target example | Consulting, Tech, Telecom |
URL_PARAM
| Description | The value of a URL parameter in the current dashboard URL This macro could be useful when your dashboard is externally filtered by HTTP parameter filters and contains embedded web content that you want to filter by the same values. To pass the parameter filter values through to the embedded web content, add the macro to the code in the embedded web content widget. Once the widget is saved, the macro is dynamically replaced by the current value of the parameter from the dashboard URL. |
| Can be used in | Embedded web content widgets and text boxes |
| Syntax |
|
| Source example | %URL_PARAM(project)% |
| Target example | Sales_Management |