The copyDashboard() GraphQL mutation may be used to create a clone of a dashboard.

For information on creating dashboards, see the Creating Dashboards and Widgets documentation page. You may also want to look at the Dashboards & Widgets and Dashboards pages for related information.


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

      id: string!
      targetSearchDomainName: string
      sourceSearchDomainName: string!
      name: string!
   ): CopyDashboardMutation!

The targetSearchDomainName is given a string value with the name of the repository or view to which the dashboard to be copied. For the sourceSearchDomainName, provide the name of the repository or view to which the dashboard is to be copied. This is required. The name is the name the copied dashboard should have.

Returned Datatypes

The returned datatype CopyDashboardMutation has its own parameter:

Table: CopyDashboardMutation

dashboardDashboardyes The dashboard to copy (see Dashboard Table).

[a] Some arguments may be required, as indicated in this column. For some fields, this column indicates that a result will always be returned for it.