https://www.gooddata.ai/ logo
Join Slack
Powered by
Can API provide a listing of private dashboards un...
# gooddata-cloud
a
Can API provide a listing of private dashboards under every organization
k
Yes, the API can provide a listing of dashboards along with their private/public status, but it works at the workspace level (not organization level directly). Here's how: Identifying Private Dashboards via API You can call the analytical dashboards entity endpoint with the 
metaInclude=accessInfo
parameter to get private status information for each dashboard: For all dashboards in a workspace:
Copy code
GET /api/v1/entities/workspaces/{workspaceId}/analyticalDashboards?metaInclude=accessInfo
For a specific dashboard:
Copy code
GET /api/v1/entities/workspaces/{workspaceId}/analyticalDashboards/{objectId}?metaInclude=accessInfo
The response will include a 
meta
object for each dashboard indicating whether it is private:
Copy code
{
  "meta": {
    "accessInfo": {
      "private": true
    }
  }
}
[Identify Private Dashboards] Organization-Wide Listing The API operates at the workspace level, so to get private dashboards across an entire organization, you would need to iterate over each workspace and call the endpoint for each one. [Get all Dashboards] Notes • By default, newly created dashboards are private (only accessible to the creator and users with 
Workspace.MANAGE
permission). [Share Dashboards] • The default page size is 20 results. If you have more dashboards, use the 
size
query parameter (e.g., 
?size=100
) to retrieve more at once. [Community Slack] • Dashboard sharing is not a security feature — for data access control, use Workspace Data Filters or User Data Filters instead. [Share Dashboards] 👍 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.
Yes, the GoodData API can provide a listing of dashboards along with their private/public status, but it works at the workspace level, not across the entire organization in a single call. How to Identify Private Dashboards via API You can use the 
metaInclude=accessInfo
query parameter on the analytical dashboards endpoint to retrieve private status information: For all dashboards in a workspace:
Copy code
GET /api/v1/entities/workspaces/{workspaceId}/analyticalDashboards?metaInclude=accessInfo
For a specific dashboard:
Copy code
GET /api/v1/entities/workspaces/{workspaceId}/analyticalDashboards/{objectId}?metaInclude=accessInfo
The response will include a 
meta
object for each dashboard indicating whether it is private:
Copy code
{
  "meta": {
    "accessInfo": {
      "private": true
    }
  }
}
[Identify Private Dashboards] Organization-Wide Listing There is no single API call to retrieve private dashboards across all workspaces in an organization simultaneously. You would need to iterate over each workspace and call the endpoint per workspace. [Get all Dashboards] Pagination Note Keep in mind that the endpoint returns paginated results (default page size is 20). You may need to use the 
size
parameter to increase the number of results returned per call (e.g., 
?size=100
). [Slack: listing dashboards] 👍 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.
m
Hi Abhijeet, I would just like to confirm our AI Assistants findings - There is no single API call to retrieve private dashboards across all workspaces in your organization. This can only be done on the workspace level, as outlined here: [Get all Dashboards]
a
As an admin can I access these private dashboards from GD poratl to fix issues if any.
m
As an “Admin” user, you have the highest level of permissions, granting the 
adminUser
complete access to view and modify all GoodData projects without the need for additional permissions. More details on permissions can be found here: https://www.gooddata.ai/docs/cloud/manage-organization/manage-permissions/#adminuser
a
@Michael Ullock Is there a way I can fetch url of private dashboards ?
m
You can review the dashboards using the API mentioned in the provided documentation - The response will contain 
meta: { "accessInfo": { "private": "true|false" } }
telling you whether a particular dashboard is private or not: https://www.gooddata.ai/docs/cloud/manage-organization/manage-permissions/set-permissions-for-dashboards/#identify-private-dashboards
a
@kapa.ai, How i can fetch dashboards that are created by the user using Analyse Tab
k
To fetch dashboards created by a specific user, you can use the 
include=createdBy
query parameter on the analytical dashboards endpoint. This will return creator information in the response. Step 1: Fetch Dashboards with Creator Info
Copy code
GET /api/v1/entities/workspaces/{workspaceId}/analyticalDashboards?include=createdBy
The response will include an 
included
section with user details:
Copy code
"included": [
    {
        "id": "123456789-abcdefg",
        "type": "userIdentifier",
        "attributes": {
            "firstname": "Name",
            "lastname": "Lastname",
            "email": "user@example.com"
        }
    }
]
[Get all Dashboards] Step 2: Filter by a Specific User You can also filter dashboards directly by the creator's ID using the 
filter
RSQL parameter:
Copy code
GET /api/v1/entities/workspaces/{workspaceId}/analyticalDashboards?filter=createdBy.id==<userId>&include=createdBy
[Get all Dashboards] Using the Python SDK
Copy code
api_response = api_instance.get_all_entities_analytical_dashboards(
    workspace_id,
    filter="createdBy.id==<userId>",
    include=["createdBy"]
)
[Python SDK EntitiesApi] > Note: If the 
included
section is empty even after adding 
include=createdBy
, it may mean the creator information is not recorded for that dashboard (e.g., dashboards created via API or imported objects may not have a 
createdBy
value). [Slack discussion] 👍 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.
a
@kapa.ai Is there any API which can provide list of visualisation under each workspace?
k
Yes, GoodData provides an API to list all visualization objects under a specific workspace. REST API
Copy code
GET /api/v1/entities/workspaces/{workspaceId}/visualizationObjects
You can use optional parameters such as: • 
filter
 – Filter using RSQL (e.g., 
title==someString
) • 
include
 – Include related entities (e.g., 
facts
, 
attributes
, 
metrics
, 
datasets
) • 
page
 / 
size
 – Pagination (default page size is 20) • 
sort
 – Sorting criteria • 
origin
 – Scope of origin (
ALL
, 
PARENTS
, 
NATIVE
) • 
metaInclude
 – Include meta objects (e.g., 
origin
, 
page
) [Get all Visualization Objects] Python SDK (gooddata-api-client) Using the 
VisualizationObjectApi
or `EntitiesApi`:
Copy code
import gooddata_api_client
from gooddata_api_client.api import visualization_object_api

configuration = gooddata_api_client.Configuration(host="https://your-gooddata-host")

with gooddata_api_client.ApiClient(configuration) as api_client:
    api_instance = visualization_object_api.VisualizationObjectApi(api_client)
    workspace_id = "your_workspace_id"

    api_response = api_instance.get_all_entities_visualization_objects(workspace_id)
    print(api_response)
[VisualizationObjectApi] Higher-Level Python SDK If you're using the 
gooddata-sdk
package, there's a simpler method:
Copy code
from gooddata_sdk import GoodDataSdk

sdk = GoodDataSdk.create("https://your-gooddata-host", "your_token")
visualizations = sdk.visualizations.get_visualizations(workspace_id="your_workspace_id")
[get_visualizations] > Note: Like dashboards, there is no single API call to retrieve visualizations across all workspaces at once. You would need to iterate over each workspace and call the endpoint per workspace. 👍 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.
2 Views
Open in Slack
PreviousNext
Powered by