Hi I am looking for information on hiding fields a...
# gooddata-cloud
c
Hi I am looking for information on hiding fields and metrics using tags in embedded mode
k
Hiding Fields and Metrics Using Tags in Embedded Mode GoodData supports tag-based filtering of the data catalog when embedding the Analytical Designer or Dashboards via iframes. Here's how it works: URL Parameters Two URL parameters control catalog visibility based on tags: These parameters affect Facts, Metrics, Attributes, and date Datasets in the catalog. They do not hide UI controls or existing dashboard widgets. [Embed AD config] [Embed Dashboard config] Example URLs Analytical Designer – show only "sales" or "marketing" tagged items:
Copy code
<host_url>/analyze/embedded/#/<workspace_id>?includeObjectsWithTags=[sales,marketing]
Dashboard – hide items tagged "internal" or "test":
Copy code
<host_url>/dashboards/embedded/#/workspace/<workspace_id>/dashboard/<dashboard_id>?excludeObjectsWithTags=[internal,test]
[Embed AD config] [Embed Dashboard config] Key Behaviors to Know • Parameter precedence: If both
includeObjectsWithTags
and
excludeObjectsWithTags
are present in the URL, only
includeObjectsWithTags
is applied
(the exclude parameter is ignored). [Embed AD config] • Tag name restrictions: Tag names can only contain letters and numbers (
a-zA-Z0-9
). Special characters are not allowed. • Already-used objects: If a metric or attribute is already used in a visualization/KPI, it will still appear in its bucket but won't show in the catalog if filtered out by tags. • Catalog scope only: These parameters only affect the data catalog — they do not hide existing widgets or UI elements on a dashboard. ⚠️ Known Bug with excludeObjectsWithTags There is a confirmed bug: when
excludeObjectsWithTags
is used, objects with no tags at all are also incorrectly excluded
from the catalog, not just those with the specified tag. [Community Slack] Workaround: Add a dummy tag to all metrics/attributes you want to remain visible. This prevents them from being incorrectly excluded. A fix is being investigated but no due date has been provided. Setting Tags on Objects Tags can be set via the entity API (for metrics) or the declarative API (for datasets, attributes, facts, and labels). [Workspace Objects Organization] Example for a metric via the entity API:
Copy code
{
  "data": {
    "attributes": {
      "content": {
        "maql": "..."
      },
      "title": "Revenue",
      "tags": [
        "Revenue metrics"
      ]
    },
    "id": "revenue",
    "type": "metric"
  }
}
> Note: This tag-based filtering is only available in embedded (iframe) mode. When accessing GoodData directly via the portal (non-embedded), all catalog objects are shown regardless of tags. [Community Slack] 👍 0 button 👎 0 button ℹ️ Tip: Mention @kapa.ai in the thread for follow-ups. 👀 Our Support team monitors all messages and will jump in if needed., with interactive elements
j
Hi Chris, Just wanted to confirm here that the bug mentioned by our internal AI is still there. I have mentioned your potential use-case in our internal ticket.
c
how would i format the address so that i can have both showNavigation=true and the excludeObjectsWithTags=[]
j
I believe it should be something like this
Copy code
/workspace/{workspace_id}/dashboard/{dashboard_identifier}?showNavigation=true&excludeObjectsWithTags=[tag1,tag2]
1