---
title: "Create Dashboard"
method: POST
path: "/dashboards"
tags: ["Dashboards"]
---

# Create Dashboard

`POST /dashboards`

Posting to the Dashboards endpoint creates a new Dashboard.

## Request body

- Dashboard — The entire Dashboard object, including the definition and metadata.
  - `name` string — Name of the Dashboard.
  - `dashboard` DashboardDefinition — Definition of a Dashboard. This is a non-exhaustive list of properties
    - `name` string — Name of the Dashboard.
    - `dataSources` unknown[] — List of Data Sources.
      - unknown
    - `pages` unknown[] — List of Pages in the Dashboard.
      - unknown
    - `scripts` unknown[] — List of Scripts to run when the Dashboard is loaded.
      - unknown
    - `styles` unknown[] — List of Styles to apply when the Dashboard is loaded.
      - unknown
  - `date` string, date-time — Date/time of the last modification.
  - `deleted` boolean — Indicates whether or not the Dashboard is deleted.
  - `rev` integer — Current revision number of the Dashboard.
  - `tags` string[] — Image URL representing the product.
  - `createdBy` CreatedBy
    - `sAMAccountName` string
    - `name` string
    - `email` string
  - `lastUpdatedBy` LastUpdatedBy
    - `sAMAccountName` string
    - `name` string
    - `email` string
  - `viewers` Viewer[] — If provided, contains the list of users/groups with authorization to view this Dashboard.
    - `sAMAccountName` string — Username of the User.
    - `displayName` string — Display name of the User.
    - `dn` string — LDAP distinguished name.
    - `mail` string — Email address
    - `category` string — Type of account, e.g. user, group
  - `editors` Editor[] — If provided, contains the list of users/groups with authorization to edit this Dashboard.
    - `sAMAccountName` string — Username of the User.
    - `displayName` string — Display name of the User.
    - `dn` string — LDAP distinguished name.
    - `mail` string — Email address
    - `category` string — Type of account, e.g. user, group
  - `visits` integer — If Analytics is enabled, this counter records the total number of visits, or times this Dashboard was loaded. Cannot be set manually.
  - `pageViews` integer — If Analytics is enabled, this counter records the total number of page views, or times a page in this Dashboard was viewed. Each visit may have multiple page views. Cannot be set manually.
  - `likes` string[] — Contains a list of users who 'like' this Dashboard.

## Response `200`

The created Dashboard, including auto-populated fields such as date, rev, etc.

- Dashboard — The entire Dashboard object, including the definition and metadata.
  - `name` string — Name of the Dashboard.
  - `dashboard` DashboardDefinition — Definition of a Dashboard. This is a non-exhaustive list of properties
    - `name` string — Name of the Dashboard.
    - `dataSources` unknown[] — List of Data Sources.
      - unknown
    - `pages` unknown[] — List of Pages in the Dashboard.
      - unknown
    - `scripts` unknown[] — List of Scripts to run when the Dashboard is loaded.
      - unknown
    - `styles` unknown[] — List of Styles to apply when the Dashboard is loaded.
      - unknown
  - `date` string, date-time — Date/time of the last modification.
  - `deleted` boolean — Indicates whether or not the Dashboard is deleted.
  - `rev` integer — Current revision number of the Dashboard.
  - `tags` string[] — Image URL representing the product.
  - `createdBy` CreatedBy
    - `sAMAccountName` string
    - `name` string
    - `email` string
  - `lastUpdatedBy` LastUpdatedBy
    - `sAMAccountName` string
    - `name` string
    - `email` string
  - `viewers` Viewer[] — If provided, contains the list of users/groups with authorization to view this Dashboard.
    - `sAMAccountName` string — Username of the User.
    - `displayName` string — Display name of the User.
    - `dn` string — LDAP distinguished name.
    - `mail` string — Email address
    - `category` string — Type of account, e.g. user, group
  - `editors` Editor[] — If provided, contains the list of users/groups with authorization to edit this Dashboard.
    - `sAMAccountName` string — Username of the User.
    - `displayName` string — Display name of the User.
    - `dn` string — LDAP distinguished name.
    - `mail` string — Email address
    - `category` string — Type of account, e.g. user, group
  - `visits` integer — If Analytics is enabled, this counter records the total number of visits, or times this Dashboard was loaded. Cannot be set manually.
  - `pageViews` integer — If Analytics is enabled, this counter records the total number of page views, or times a page in this Dashboard was viewed. Each visit may have multiple page views. Cannot be set manually.
  - `likes` string[] — Contains a list of users who 'like' this Dashboard.

## Other responses

- `400` — Missing Dashboard name, or Dashboard definition.
- `401` — Authentication required: session key not provided.
- `500` — Server error.

---

[API](https://skmtc.dev/expediagroup/apis/cyclotron-api.md) · [All operations](https://skmtc.dev/expediagroup/apis/cyclotron-api/llms.txt) · [OpenAPI document](https://skmtc-service-production.skmtc.workers.dev/v1/apis/expediagroup/cyclotron-api/revisions/18e751e6bc49/schema)