Skip to main content
GET
/
api
/
public
/
organizations
/
{orgId}
/
dashboards
/
{id}
Get a dashboard
curl --request GET \
  --url https://charts.basedash.com/api/public/organizations/{orgId}/dashboards/{id} \
  --header 'Authorization: Bearer <token>'
{
  "data": {
    "id": "<string>",
    "createdAt": "2023-11-07T05:31:56Z",
    "updatedAt": "2023-11-07T05:31:56Z",
    "name": "<string>",
    "description": "<string>",
    "icon": "<string>",
    "color": "<string>",
    "dashboardFolderId": "<string>",
    "width": "NORMAL",
    "defaultDateRange": "CUSTOM",
    "defaultCustomDateRangeStart": "2023-11-07T05:31:56Z",
    "defaultCustomDateRangeEnd": "2023-11-07T05:31:56Z",
    "defaultGroupByInterval": "HOUR",
    "organizationId": "<string>",
    "tabs": [
      {
        "id": "<string>",
        "createdAt": "2023-11-07T05:31:56Z",
        "updatedAt": "2023-11-07T05:31:56Z",
        "name": "<string>",
        "order": 123,
        "dashboardId": "<string>"
      }
    ]
  }
}

Authorizations

Authorization
string
header
required

API key authentication using Bearer token format: Bearer <basedash_api_key>

Path Parameters

orgId
string
required

Organization ID

id
string
required

Dashboard ID

Response

Dashboard retrieved successfully

data
object
required