Skip to main content
POST
/
api
/
v1
/
projects
/
{projectUuid}
/
dashboards
/
with-charts
cURL
curl --request POST \
  --url http://api/v1/projects/{projectUuid}/dashboards/with-charts \
  --header 'Content-Type: application/json' \
  --data '
{
  "charts": [
    {
      "description": "<string>",
      "name": "<string>",
      "parameters": {},
      "chartConfig": {
        "config": {
          "comparisonLabel": "<string>",
          "flipColors": true,
          "comparisonFormat": "raw",
          "showComparison": true,
          "showTableNamesInLabel": true,
          "showBigNumberLabel": true,
          "selectedField": "<string>",
          "style": "thousands",
          "label": "<string>"
        },
        "type": "big_number"
      },
      "tableName": "<string>",
      "metricQuery": {
        "metadata": {
          "hasADateDimension": {
            "name": "<any>",
            "label": "<any>",
            "table": "<any>"
          }
        },
        "timezone": "<string>",
        "metricOverrides": {},
        "customDimensions": [
          {
            "id": "<any>",
            "name": "<any>",
            "table": "<any>",
            "type": "<any>",
            "dimensionId": "<any>",
            "binType": "<any>",
            "binNumber": "<any>",
            "binWidth": "<any>",
            "customRange": "<any>"
          }
        ],
        "additionalMetrics": [
          {
            "label": "<any>",
            "type": "<any>",
            "description": "<any>",
            "sql": "<any>",
            "hidden": "<any>",
            "round": "<any>",
            "compact": "<any>",
            "format": "<any>",
            "table": "<any>",
            "name": "<any>",
            "index": "<any>",
            "filters": "<any>",
            "baseDimensionName": "<any>",
            "uuid": "<any>",
            "percentile": "<any>",
            "formatOptions": "<any>"
          }
        ],
        "tableCalculations": [
          {
            "type": "<any>",
            "format": "<any>",
            "displayName": "<any>",
            "name": "<any>",
            "index": "<any>",
            "sql": "<any>"
          }
        ],
        "limit": 123,
        "sorts": [
          {
            "nullsFirst": "<any>",
            "descending": "<any>",
            "fieldId": "<any>"
          }
        ],
        "filters": {
          "tableCalculations": {
            "or": "<any>",
            "id": "<any>"
          },
          "metrics": {
            "or": "<any>",
            "id": "<any>"
          },
          "dimensions": {
            "or": "<any>",
            "id": "<any>"
          }
        },
        "metrics": [
          "<string>"
        ],
        "dimensions": [
          "<string>"
        ],
        "exploreName": "<string>"
      },
      "pivotConfig": {
        "columns": [
          "<string>"
        ]
      },
      "tableConfig": {
        "columnOrder": [
          "<string>"
        ]
      },
      "spaceUuid": "<string>"
    }
  ],
  "spaceUuid": "<string>",
  "description": "<string>",
  "name": "<string>"
}
'
{
  "results": {
    "config": {
      "pinnedParameters": [
        "<string>"
      ],
      "isDateZoomDisabled": true
    },
    "slug": "<string>",
    "access": [
      {
        "inheritedFrom": "organization",
        "inheritedRole": "member",
        "projectRole": "viewer",
        "hasDirectAccess": true,
        "role": "viewer",
        "email": "<string>",
        "lastName": "<string>",
        "firstName": "<string>",
        "userUuid": "<string>"
      }
    ],
    "isPrivate": true,
    "tabs": [
      {
        "order": 123,
        "name": "<string>",
        "uuid": "<string>"
      }
    ],
    "pinnedListOrder": 123,
    "pinnedListUuid": "<string>",
    "firstViewedAt": "2023-11-07T05:31:56Z",
    "views": 123,
    "spaceName": "<string>",
    "spaceUuid": "<string>",
    "updatedByUser": {
      "userUuid": "<string>",
      "firstName": "<string>",
      "lastName": "<string>"
    },
    "parameters": {},
    "filters": {
      "tableCalculations": [
        {
          "values": [
            "<any>"
          ],
          "operator": "isNull",
          "id": "<string>",
          "target": {
            "fallbackType": "string",
            "isSqlColumn": true,
            "tableName": "<string>",
            "fieldId": "<string>"
          },
          "settings": "<any>",
          "disabled": true,
          "required": true,
          "singleValue": true,
          "label": "<string>",
          "tileTargets": {}
        }
      ],
      "metrics": [
        {
          "values": [
            "<any>"
          ],
          "operator": "isNull",
          "id": "<string>",
          "target": {
            "fallbackType": "string",
            "isSqlColumn": true,
            "tableName": "<string>",
            "fieldId": "<string>"
          },
          "settings": "<any>",
          "disabled": true,
          "required": true,
          "singleValue": true,
          "label": "<string>",
          "tileTargets": {}
        }
      ],
      "dimensions": [
        {
          "values": [
            "<any>"
          ],
          "operator": "isNull",
          "id": "<string>",
          "target": {
            "fallbackType": "string",
            "isSqlColumn": true,
            "tableName": "<string>",
            "fieldId": "<string>"
          },
          "settings": "<any>",
          "disabled": true,
          "required": true,
          "singleValue": true,
          "label": "<string>",
          "tileTargets": {}
        }
      ]
    },
    "tiles": [
      {
        "uuid": "<string>",
        "type": "saved_chart",
        "x": 123,
        "y": 123,
        "h": 123,
        "w": 123,
        "tabUuid": "<string>",
        "properties": {
          "chartSlug": "<string>",
          "lastVersionChartKind": "line",
          "chartName": "<string>",
          "belongsToDashboard": true,
          "savedChartUuid": "<string>",
          "hideTitle": true,
          "title": "<string>"
        }
      }
    ],
    "updatedAt": "2023-11-07T05:31:56Z",
    "description": "<string>",
    "name": "<string>",
    "uuid": "<string>",
    "dashboardVersionId": 123,
    "projectUuid": "<string>",
    "organizationUuid": "<string>"
  },
  "status": "ok"
}

Path Parameters

​
projectUuid
string
required

Body

application/json
​
charts
object[]
required
  • Option 1
  • Option 2
​
spaceUuid
string
required
​
name
string
required
​
description
string

Response

Created

​
results
object
required
​
status
enum<string>
required
Available options:
ok