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

# Create Dashboard

`POST /console/v1/dashboards`

## Request body

- CreateDashboardDto
  - `name` string, required
  - `description` string
  - `defaults` object
    - `date` object
      - `value` integer, required
      - `unit` 'day' | 'week' | 'month', required
    - `granularity` 'auto' | 'daily' | 'weekly' | 'monthly'
  - `widgets` union[]
    - union
      - object
        - `type` 'text', required
        - `title` string, required
        - `content` string, required
        - `width` integer
        - `height` integer
      - object
        - `type` 'header', required
        - `title` string, required
        - `color` string
        - `width` integer
        - `height` integer
      - object
        - `type` 'timeseries', required
        - `title` string, required
        - `description` string
        - `color` string
        - `query` object, required
          - `source` object
            - `type` 'event', required
            - `event_name` string, required
            - `filters` object[]
              - …
          - `sources` object[]
            - `type` 'event', required
            - `event_name` string, required
            - `filters` object[]
              - …
          - `aggregation` object, required
            - `type` unknown, required
            - `property` object
              - …
          - `unit_type` string
          - `group_bys` object[]
            - `key` string, required
            - `column` unknown, required
          - `viz` object
            - `chart_type` unknown, required
        - `width` integer
        - `height` integer
      - object
        - `type` 'funnel', required
        - `title` string, required
        - `description` string
        - `color` string
        - `query` object, required
          - `steps` object[], required
            - `event_name` string, required
            - `filters` object[]
              - …
          - `unit_type` string
          - `conversion_window` object
            - `value` integer, required
            - `unit` 'second' | 'minute' | 'hour' | 'day', required
          - `chart_type` 'conversion-rate' | 'conversions'
        - `width` integer
        - `height` integer

## Response `200`

Create dashboard response

- object
  - `message` string, required — A simple string explaining the result of the operation.
  - `data` object, required — A single result.
    - `id` string, required
    - `dashboard_url` string, required

---

[API](https://skmtc.net/statsig/apis/console-api.md) · [All operations](https://skmtc.net/statsig/apis/console-api/llms.txt) · [OpenAPI document](https://skmtc-service-staging.skmtc.workers.dev/v1/apis/statsig/console-api/revisions/3189f450c93b/schema)