Dashboard service
Get information about the Coralogix Dashboard catalog.
Overview
The Dashboard service API manages Coralogix dashboards: it lets you create, retrieve, update, delete, and organize dashboards, pin them to favorites, and look up a catalog of every dashboard the caller can see. A dashboard is a JSON payload describing a Layout of Sections, each containing Rows of Widgets, parameterized by Variables and annotated with Annotations. The same payload is consumed by Create and Replace operations and returned by Get.
Copy a dashboard
This use case demonstrates how to duplicate an existing dashboard by retrieving its configuration and posting it as a new dashboard.
Validate a dashboard and return issues
Checks a dashboard definition or an existing dashboard by id and returns validation issues without persisting changes.
Replace a dashboard
Replaces an existing dashboard.
Create a new dashboard
Creates a new dashboard.
Get dashboard catalog
Get a list of all dashboards accessible.
Get a dashboard by URL slug
Returns the dashboard associated with the specified slug.
Get a dashboard
Returns the details of the specified dashboard.
Delete a dashboard
Deletes the dashboard with the specified ID.
Replace the default dashboard
Sets the specified dashboard as the default.
Assign a dashboard to a folder
Assigns the dashboard to a folder.
Add dashboard to favorites
Pins the specified dashboard.
Remove dashboard from favorites
Unpins the specified dashboard.