> ## Documentation Index
> Fetch the complete documentation index at: https://docs.open-metadata.org/llms.txt
> Use this file to discover all available pages before exploring further.

# Create a Dashboard

> Create a new dashboard within a dashboard service

# Create a Dashboard

Create a new dashboard within a dashboard service.

## Body Parameters

<ParamField body="name" type="string" required>
  Name of the dashboard. Must be unique within the parent dashboard service.
</ParamField>

<ParamField body="service" type="string" required>
  Fully qualified name of the parent DashboardService (e.g., `sample_superset`).
</ParamField>

<ParamField body="displayName" type="string">
  Human-readable display name for the dashboard.
</ParamField>

<ParamField body="description" type="string">
  Description of the dashboard in Markdown format.
</ParamField>

<ParamField body="sourceUrl" type="string">
  URL of the dashboard in the source system.
</ParamField>

<ParamField body="charts" type="array">
  Array of chart fully qualified names to associate with the dashboard.
</ParamField>

<ParamField body="owners" type="array">
  Array of owner references (users or teams) to assign to the dashboard.

  <Expandable title="properties">
    <ParamField body="id" type="string">
      UUID of the owner entity.
    </ParamField>

    <ParamField body="type" type="string">
      Type of owner entity (e.g., `user`, `team`).
    </ParamField>

    <ParamField body="name" type="string">
      Name of the owner entity.
    </ParamField>
  </Expandable>
</ParamField>

<ParamField body="domain" type="string">
  Fully qualified name of the domain to assign for governance purposes.
</ParamField>

<ParamField body="tags" type="array">
  Array of classification tags to apply to the dashboard.

  <Expandable title="properties">
    <ParamField body="tagFQN" type="string" required>
      Fully qualified name of the tag.
    </ParamField>

    <ParamField body="labelType" type="string">
      Type of label (e.g., `Manual`, `Derived`, `Propagated`).
    </ParamField>

    <ParamField body="state" type="string">
      State of the tag (e.g., `Suggested`, `Confirmed`).
    </ParamField>
  </Expandable>
</ParamField>

<ParamField body="extension" type="object">
  Custom property values defined by your organization's metadata schema.
</ParamField>

<RequestExample dropdown>
  ```python POST /v1/dashboards theme={null}
  from metadata.sdk import configure
  from metadata.sdk.entities import Dashboards
  from metadata.generated.schema.api.data.createDashboard import CreateDashboardRequest

  configure(
      host="https://your-company.open-metadata.org/api",
      jwt_token="your-jwt-token"
  )

  request = CreateDashboardRequest(
      name="10",
      displayName="deck.gl Demo",
      service="sample_superset",
      description="Dashboard showcasing deck.gl visualizations",
      sourceUrl="http://localhost:808/superset/dashboard/10/"
  )

  dashboard = Dashboards.create(request)
  print(f"Created: {dashboard.fullyQualifiedName}")
  ```

  ```java POST /v1/dashboards theme={null}
  import static org.openmetadata.sdk.fluent.Dashboards.*;

  // Create using builder pattern
  var dashboard = Dashboards.builder()
      .name("10")
      .displayName("deck.gl Demo")
      .service("sample_superset")
      .description("Dashboard showcasing deck.gl visualizations")
      .sourceUrl("http://localhost:808/superset/dashboard/10/")
      .create();
  ```

  ```bash POST /v1/dashboards theme={null}
  curl -X POST "{base_url}/api/v1/dashboards" \
    -H "Authorization: Bearer {access_token}" \
    -H "Content-Type: application/json" \
    -d '{
      "name": "10",
      "displayName": "deck.gl Demo",
      "service": "sample_superset",
      "description": "Dashboard showcasing deck.gl visualizations",
      "sourceUrl": "http://localhost:808/superset/dashboard/10/"
    }'
  ```
</RequestExample>

<ResponseExample>
  ```json Response theme={null}
  {
    "id": "03fb5cc3-de48-423f-9926-8e192e5de59d",
    "name": "10",
    "displayName": "deck.gl Demo",
    "fullyQualifiedName": "sample_superset.10",
    "description": "Dashboard showcasing deck.gl visualizations",
    "version": 0.1,
    "updatedAt": 1769982666437,
    "updatedBy": "admin",
    "sourceUrl": "http://localhost:808/superset/dashboard/10/",
    "service": {
      "id": "b1e6a71d-7f47-4e5f-8ce0-e6e8a88ec97a",
      "type": "dashboardService",
      "name": "sample_superset",
      "fullyQualifiedName": "sample_superset",
      "deleted": false
    },
    "serviceType": "Superset",
    "href": "http://localhost:8585/api/v1/dashboards/03fb5cc3-de48-423f-9926-8e192e5de59d",
    "deleted": false,
    "owners": [],
    "tags": [],
    "followers": [],
    "votes": {
      "upVotes": 0,
      "downVotes": 0
    },
    "domains": [],
    "charts": []
  }
  ```
</ResponseExample>

***

## Returns

Returns the created dashboard object with all specified properties and system-generated fields.

## Response

<ResponseField name="id" type="string">
  Unique identifier for the dashboard (UUID format).
</ResponseField>

<ResponseField name="name" type="string">
  Dashboard name.
</ResponseField>

<ResponseField name="fullyQualifiedName" type="string">
  Fully qualified name in format `service.dashboardName`.
</ResponseField>

<ResponseField name="displayName" type="string">
  Human-readable display name.
</ResponseField>

<ResponseField name="description" type="string">
  Description of the dashboard in Markdown format.
</ResponseField>

<ResponseField name="service" type="object">
  Reference to the parent dashboard service.

  <Expandable title="properties">
    <ResponseField name="id" type="string">
      UUID of the dashboard service.
    </ResponseField>

    <ResponseField name="type" type="string">
      Type of entity (always `dashboardService`).
    </ResponseField>

    <ResponseField name="name" type="string">
      Name of the dashboard service.
    </ResponseField>

    <ResponseField name="fullyQualifiedName" type="string">
      Fully qualified name of the dashboard service.
    </ResponseField>
  </Expandable>
</ResponseField>

<ResponseField name="sourceUrl" type="string">
  URL of the dashboard in the source system.
</ResponseField>

<ResponseField name="serviceType" type="string">
  Type of dashboard service (e.g., Superset, Looker, Tableau, Metabase, PowerBI).
</ResponseField>

<ResponseField name="charts" type="array" optional>
  List of charts associated with the dashboard.
</ResponseField>

<ResponseField name="owners" type="array" optional>
  List of owners assigned to the dashboard.

  <Expandable title="properties">
    <ResponseField name="id" type="string">
      UUID of the owner entity.
    </ResponseField>

    <ResponseField name="type" type="string">
      Type of owner entity (e.g., `user`, `team`).
    </ResponseField>

    <ResponseField name="name" type="string">
      Name of the owner entity.
    </ResponseField>
  </Expandable>
</ResponseField>

<ResponseField name="domains" type="array" optional>
  Domain assignments for governance.
</ResponseField>

<ResponseField name="tags" type="array" optional>
  Classification tags applied to the dashboard.

  <Expandable title="properties">
    <ResponseField name="tagFQN" type="string">
      Fully qualified name of the tag.
    </ResponseField>

    <ResponseField name="labelType" type="string">
      Type of label (e.g., `Manual`, `Derived`, `Propagated`).
    </ResponseField>

    <ResponseField name="state" type="string">
      State of the tag (e.g., `Suggested`, `Confirmed`).
    </ResponseField>
  </Expandable>
</ResponseField>

<ResponseField name="extension" type="object" optional>
  Custom property values defined by your organization's metadata schema.
</ResponseField>

<ResponseField name="version" type="number">
  Version number for the entity (starts at 0.1).
</ResponseField>

***

## Create or Update (PUT)

Use `PUT /v1/dashboards` instead of `POST` to perform an upsert. If a dashboard with the same `fullyQualifiedName` already exists, it will be updated; otherwise, a new dashboard is created. The request body is the same as `POST`.

```bash theme={null}
curl -X PUT "{base_url}/api/v1/dashboards" \
  -H "Authorization: Bearer {access_token}" \
  -H "Content-Type: application/json" \
  -d '{ ... same body as POST ... }'
```

<Note>
  `PUT` will not return a `409` conflict error if the entity already exists -- it will update the existing entity instead.
</Note>

***

## Bulk Create or Update (PUT)

Use `PUT /v1/dashboards/bulk` to create or update multiple dashboards in a single request. The request body is an array of create request objects.

```bash theme={null}
curl -X PUT "{base_url}/api/v1/dashboards/bulk" \
  -H "Authorization: Bearer {access_token}" \
  -H "Content-Type: application/json" \
  -d '[
    { "name": "dashboard_one", "service": "sample_superset" },
    { "name": "dashboard_two", "service": "sample_superset" }
  ]'
```

***

## Error Handling

| Code  | Error Type              | Description                                                    |
| ----- | ----------------------- | -------------------------------------------------------------- |
| `400` | `BAD_REQUEST`           | Invalid request body or missing required fields                |
| `401` | `UNAUTHORIZED`          | Invalid or missing authentication token                        |
| `403` | `FORBIDDEN`             | User lacks permission to create dashboards                     |
| `409` | `ENTITY_ALREADY_EXISTS` | Dashboard with same name already exists in service (POST only) |