Promote dashboard

Promote dashboard to its upstream project

POST /api/v1/dashboards/{dashboardUuidOrSlug}/promote

Error

A valid request URL is required to generate request examples

200

{
  "results": {
    "name": "<string>",
    "projectUuid": "<string>",
    "organizationUuid": "<string>",
    "uuid": "<string>",
    "pinnedListUuid": "<string>",
    "pinnedListOrder": 123,
    "slug": "<string>",
    "updatedAt": "2023-11-07T05:31:56Z",
    "versionUuid": "<string>",
    "spaceUuid": "<string>",
    "dashboardVersionId": 123,
    "verification": {
      "verifiedAt": "2023-11-07T05:31:56Z",
      "verifiedBy": {
        "lastName": "<string>",
        "firstName": "<string>",
        "userUuid": "<string>"
      }
    },
    "tiles": [
      {
        "uuid": "<string>",
        "type": "saved_chart",
        "x": 123,
        "y": 123,
        "h": 123,
        "w": 123,
        "properties": {
          "savedChartUuid": "<string>",
          "chartSlug": "<string>",
          "chartName": "<string>",
          "belongsToDashboard": true,
          "hideTitle": true,
          "title": "<string>"
        },
        "tabUuid": "<string>"
      }
    ],
    "filters": {
      "tableCalculations": [
        {
          "id": "<string>",
          "target": {
            "tableName": "<string>",
            "fieldId": "<string>",
            "isSqlColumn": true
          },
          "includeNull": true,
          "values": [
            "<unknown>"
          ],
          "settings": "<unknown>",
          "disabled": true,
          "required": true,
          "caseSensitive": true,
          "lockedTabUuids": [
            "<string>"
          ],
          "singleValue": true,
          "label": "<string>",
          "tileTargets": {}
        }
      ],
      "metrics": [
        {
          "id": "<string>",
          "target": {
            "tableName": "<string>",
            "fieldId": "<string>",
            "isSqlColumn": true
          },
          "includeNull": true,
          "values": [
            "<unknown>"
          ],
          "settings": "<unknown>",
          "disabled": true,
          "required": true,
          "caseSensitive": true,
          "lockedTabUuids": [
            "<string>"
          ],
          "singleValue": true,
          "label": "<string>",
          "tileTargets": {}
        }
      ],
      "dimensions": [
        {
          "id": "<string>",
          "target": {
            "tableName": "<string>",
            "fieldId": "<string>",
            "isSqlColumn": true
          },
          "includeNull": true,
          "values": [
            "<unknown>"
          ],
          "settings": "<unknown>",
          "disabled": true,
          "required": true,
          "caseSensitive": true,
          "lockedTabUuids": [
            "<string>"
          ],
          "singleValue": true,
          "label": "<string>",
          "tileTargets": {}
        }
      ]
    },
    "spaceName": "<string>",
    "views": 123,
    "firstViewedAt": "<string>",
    "tabs": [
      {
        "order": 1,
        "name": "<string>",
        "uuid": "<string>",
        "hidden": true
      }
    ],
    "colorPaletteUuid": "<string>",
    "description": "<string>",
    "parameters": {},
    "updatedByUser": {
      "userUuid": "<string>",
      "firstName": "<string>",
      "lastName": "<string>"
    },
    "config": {
      "isDateZoomDisabled": true,
      "dateZoomConfig": {
        "tileTargets": {},
        "controls": [
          {
            "name": "<string>",
            "uuid": "<string>",
            "hidden": true
          }
        ]
      },
      "dateZoomGranularities": [],
      "parameterOrder": [
        "<string>"
      ],
      "pinnedParameters": [
        "<string>"
      ],
      "isAddFilterDisabled": true
    },
    "deletedAt": "2023-11-07T05:31:56Z",
    "deletedBy": {
      "lastName": "<string>",
      "firstName": "<string>",
      "userUuid": "<string>"
    }
  },
  "status": "ok"
}

{
  "error": {
    "name": "<string>",
    "statusCode": 123,
    "data": "<unknown>",
    "message": "<string>"
  },
  "status": "error"
}

Path Parameters

dashboardUuidOrSlug · string · required

uuid or slug for the dashboard to run A resource UUID or its URL slug. Resolve to a real UUID before using as a key.

Query Parameters

projectUuid · string<uuid>

project to resolve a slug in, required when the slug exists in multiple projects (e.g. preview projects) Stringified UUIDv4. See RFC 4112

Pattern: [0-9A-Fa-f]{8}-[0-9A-Fa-f]{4}-4[0-9A-Fa-f]{3}-[89ABab][0-9A-Fa-f]{3}-[0-9A-Fa-f]{12}

Response

200

application/json

Success

results · object · required

Construct a type with the properties of T except for those in type K.

Show child attributes

status · enum<string> · required

Available options: ok