Overview:
This API allows you to retrieve complete dashboard information when you only have the published dashboard URL.
It is useful when:
- You want to identify the original dashboard linked to a published URL.
- You want project, workspace, or tenant information associated with a published dashboard.
- You need metadata such as dashboardKey, dashboardName, projectName, workspaceName, and tenantName.
Example of Published URL:
https://hosturl/1c62ea0c-97d1-47a3-a34c-6b3876ceb3c6/publishedDashboard/
API Endpoint:
GET /getDashboardDetailsbyPublishedURL/{publishedUrlId}
For above Publsihed URL, the publishedUrlId is : 1c62ea0c-97d1-47a3-a34c-6b3876ceb3c6
Final URL:
https://hosturl_backend/getDashboardDetailsbyPublishedURL/1c62ea0c-97d1-47a3-a34c-6b3876ceb3c6/
Purpose:
This API is used when you have a published dashboard URL and need to access details of the original dashboard inside Rubisight.
It provides key metadata such as:
- Dashboard Name
- Dashboard Key
- Project Name and Key
- Workspace Name and Key
- Tenant Name and Key
- Status and created timestamp
How it Works:
1. Extract the published URL ID from the public dashboard link.
2. Call the API with the ID as the path parameter.
3. The API returns JSON containing dashboard-level and workspace-level details.
Sample API Call:
GET https://<domain>/backend/getDashboardDetailsbyPublishedURL/<publishedUrlId>
Headers:
- No special headers required unless authentication is enabled in your environment.
Sample Response:
The response includes important fields such as:
{
"status": "Active",
"createdAt": "2025-11-20 11:12:20",
"validity": 1,
"dashboardKey": "9433169c-11ed-4be0-9823-6ab4859a7b6d",
"dashboardName": "Published URL Dashboard",
"projectKey": "c104d10c-addc-46ba-9cf9-a3d4041fd751",
"projectName": "Project 1",
"workspaceKey": "cb09dd72-d76c-4c8e-a34a-8fae13887ac",
"workspaceName": "swpan_4.1_1",
"tenantKey": "0e8e0091-ebcf-47be-a094-23b9ee6fbe9e",
"tenantName": "PE1"
}
Key Fields Explained:
dashboardKey
- Unique identifier of the original dashboard.
dashboardName
- Name of the dashboard inside Rubisight.
projectKey / projectName
- Identifies the project where the dashboard exists.
workspaceKey / workspaceName
- Identifies the workspace under which the project is created.
tenantKey / tenantName
- Identifies the tenant owning the dashboard.
status
- Indicates if the published dashboard link is active.
validity
- Shows if the URL is still valid.
When to Use This API:
- When a user only has a public/published URL and needs to locate the actual dashboard inside Rubisight.
- When external applications need to map public dashboards to internal dashboard IDs.
Important Notes:
- This API does not return user permissions; it only returns dashboard metadata.
- The published URL must be valid and active for the API to return results.
- If the published URL has expired, the API may return empty results or an inactive status.
Summary:
The “Get Dashboard Details by Published URL” API is a convenient way to trace a published dashboard back to its original dashboard, project, workspace, and tenant. It provides quick access to all required metadata based on the published URL ID.