Skip to main content
 print this page

Create a dashboard

POST 

/dashboards

Registers a new dashboard with metadata and optional widgets. A valid role_id with dashboards.fullaccess is required. On success the creator is granted AccessType owner, and the response includes DashboardId (UUID), CustomUrlPath ({CurrentSlug}-{CustomId}, for example SalesOverview-3c4d5e6f), and a success Message. DashboardId is generated server-side when omitted from the body. This Lambda maps InvalidInputException to HTTP 422, UnauthorizedUserException (resource ACL) to HTTP 401, RequestValidationError to HTTP 400, and unhandled/GenericFailure to HTTP 500. Widgets may be omitted (defaults to an empty list). QuickSight widgets must include Configuration.QuicksightDashboardId.Value set to an existing QuickSight dashboard ID (else DASH-1007 / DASH-1006). Insights widgets validate caller access to Configuration.ResourcesList.Value entries. Not idempotent: each successful call creates a new dashboard.

Request

Responses

Dashboard created. Message is "Dashboard registration completed successfully." Body includes DashboardId and CustomUrlPath.

Response Headers
    Access-Control-Allow-Origin
    Access-Control-Allow-Methods
    Access-Control-Allow-Headers