Skip to main content

system.mes.dashboard.getDashboardByUrl

Description

Retrieves a Dashboard by its URL for the current authenticated user. Public dashboards (no owner) are also considered. If the user isn’t authenticated or the dashboard isn’t found for that user, this call throws an error.

Syntax

system.mes.dashboard.getDashboardByUrl(url)

Parameters

ParameterTypeNullableDescription
urlStringFalseThe URL slug of the dashboard to retrieve.

Returns

Returns a JSON representation of the dashboard. See getDashboard for the field list.

Code Examples

db = system.mes.dashboard.getDashboardByUrl('production-overview')
print(db)