API Stability Long-Term

The deleteDashboard() GraphQL mutation may be used to delete a dashboard in LogScale.

For more information on dashboards, see the Dashboards & Widgets documentation page.

Syntax

Below is the syntax for the deleteDashboard() mutation field:

graphql
deleteDashboard(
     input: DeleteDashboardInput!
   ): DeleteDashboardMutation!

Below is an example of how this mutation field might be used:

Show:
graphql
mutation {
  deleteDashboard(input:
        { id: "r85CDJn6cfMIVeCPfXHEriM1CB93SD5O" } )
  { dashboard {id} }
}
Example Responses
Show:
json
{
  "data": {
    "deleteDashboard": {
      "dashboard": {
        "id": "r85CDJn6cfMIVeCPfXHEriM1CB93SD5O"
      }
    }
  }
}

Given Datatypes

For the given datatype, DeleteDashboardInput, there's only one parameter that may be given. It's described below:

Table: DeleteDashboardInput

ParameterTypeRequiredDefaultStabilityDescription
Some arguments may be required, as indicated in the Required column. For some fields, this column indicates that a result will always be returned for this column.
Table last updated: Sep 18, 2024
idstringyes Long-TermThe unique identifier of the dashboard.

Returned Datatypes

The returned datatype DeleteDashboardMutation also has only one parameter. However, that one parameter has several sub-parameters from which to choose. Click on the link below to the one parameter to see the table of sub-parameters:

Table: DeleteDashboardMutation

ParameterTypeRequiredDefaultStabilityDescription
Some arguments may be required, as indicated in the Required column. For some fields, this column indicates that a result will always be returned for this column.
Table last updated: Sep 24, 2024
dashboardDashboardyes Long-TermThe dashboard to delete. See Dashboard.