Upsert chart as code

Upsert a chart from code representation

POST /api/v1/projects/{projectUuid}/charts/{slug}/code

Error

A valid request URL is required to generate request examples

200

{
  "results": {
    "charts": [
      {
        "data": {
          "name": "<string>",
          "projectUuid": "<string>",
          "organizationUuid": "<string>",
          "uuid": "<string>",
          "updatedAt": "2023-11-07T05:31:56Z",
          "chartConfig": {
            "config": {
              "comparisonField": "<string>",
              "conditionalFormattings": [
                {
                  "rules": [
                    {
                      "values": [
                        123
                      ],
                      "id": "<string>"
                    }
                  ],
                  "color": "<string>",
                  "target": {
                    "fieldId": "<string>"
                  },
                  "darkColor": "<string>"
                }
              ],
              "comparisonLabel": "<string>",
              "flipColors": true,
              "showComparison": true,
              "showTableNamesInLabel": true,
              "showBigNumberLabel": true,
              "selectedField": "<string>",
              "label": "<string>"
            }
          },
          "spaceUuid": "<string>",
          "dashboardUuid": "<string>",
          "pinnedListUuid": "<string>",
          "pinnedListOrder": 123,
          "slug": "<string>",
          "verification": {
            "verifiedAt": "2023-11-07T05:31:56Z",
            "verifiedBy": {
              "lastName": "<string>",
              "firstName": "<string>",
              "userUuid": "<string>"
            }
          },
          "spaceName": "<string>",
          "colorPaletteUuid": "<string>",
          "tableName": "<string>",
          "metricQuery": {
            "tableCalculations": [
              {
                "displayName": "<string>",
                "name": "<string>",
                "sql": "<string>",
                "format": {
                  "round": 123,
                  "currency": "<string>",
                  "prefix": "<string>",
                  "suffix": "<string>",
                  "custom": "<string>"
                },
                "index": 123
              }
            ],
            "limit": 123,
            "sorts": [
              {
                "descending": true,
                "fieldId": "<string>",
                "pivotValues": [
                  {
                    "value": "<string>",
                    "reference": "<string>"
                  }
                ],
                "nullsFirst": true
              }
            ],
            "filters": {
              "tableCalculations": {
                "or": [
                  {
                    "id": "<string>",
                    "target": {
                      "fieldId": "<string>"
                    },
                    "values": [
                      "<unknown>"
                    ],
                    "settings": "<unknown>",
                    "disabled": true,
                    "required": true,
                    "caseSensitive": true
                  }
                ],
                "id": "<string>"
              },
              "metrics": {
                "or": [
                  {
                    "id": "<string>",
                    "target": {
                      "fieldId": "<string>"
                    },
                    "values": [
                      "<unknown>"
                    ],
                    "settings": "<unknown>",
                    "disabled": true,
                    "required": true,
                    "caseSensitive": true
                  }
                ],
                "id": "<string>"
              },
              "dimensions": {
                "or": [
                  {
                    "id": "<string>",
                    "target": {
                      "fieldId": "<string>"
                    },
                    "values": [
                      "<unknown>"
                    ],
                    "settings": "<unknown>",
                    "disabled": true,
                    "required": true,
                    "caseSensitive": true
                  }
                ],
                "id": "<string>"
              }
            },
            "metrics": [
              "<string>"
            ],
            "dimensions": [
              "<string>"
            ],
            "exploreName": "<string>",
            "metadata": {
              "hasADateDimension": {
                "name": "<string>",
                "label": "<string>",
                "table": "<string>"
              }
            },
            "pivotDimensions": [
              "<string>"
            ],
            "timezone": "<string>",
            "dimensionOverrides": {},
            "metricOverrides": {},
            "customDimensions": [
              {
                "id": "<string>",
                "name": "<string>",
                "table": "<string>",
                "dimensionId": "<string>",
                "binNumber": 123
              }
            ],
            "additionalMetrics": [
              {
                "sql": "<string>",
                "table": "<string>",
                "name": "<string>",
                "label": "<string>",
                "description": "<string>",
                "hidden": true,
                "round": 123,
                "index": 123,
                "filters": [
                  {
                    "id": "<string>",
                    "target": {
                      "fieldRef": "<string>"
                    },
                    "values": [
                      "<unknown>"
                    ],
                    "settings": "<unknown>",
                    "disabled": true,
                    "required": true,
                    "caseSensitive": true
                  }
                ],
                "baseDimensionName": "<string>",
                "uuid": "<string>",
                "percentile": 123,
                "distinctKeys": [
                  "<string>"
                ],
                "formatOptions": {
                  "round": 123,
                  "currency": "<string>",
                  "prefix": "<string>",
                  "suffix": "<string>",
                  "custom": "<string>"
                },
                "baseMetricId": "<string>",
                "timeDimensionId": "<string>",
                "periodOffset": 123
              }
            ]
          },
          "tableConfig": {
            "columnOrder": [
              "<string>"
            ]
          },
          "dashboardName": "<string>",
          "colorPalette": [
            "<string>"
          ],
          "resolvedColorPalette": {
            "source": {},
            "paletteName": "<string>",
            "paletteUuid": "<string>",
            "darkColors": [
              "<string>"
            ],
            "colors": [
              "<string>"
            ]
          },
          "oldUuid": "<string>",
          "spacePath": "<string>",
          "spaceSlug": "<string>",
          "description": "<string>",
          "parameters": {},
          "updatedByUser": {
            "userUuid": "<string>",
            "firstName": "<string>",
            "lastName": "<string>"
          },
          "deletedAt": "2023-11-07T05:31:56Z",
          "deletedBy": {
            "lastName": "<string>",
            "firstName": "<string>",
            "userUuid": "<string>"
          },
          "pivotConfig": {
            "columns": [
              "<string>"
            ]
          }
        }
      }
    ],
    "dashboards": [
      {
        "data": {
          "name": "<string>",
          "projectUuid": "<string>",
          "organizationUuid": "<string>",
          "uuid": "<string>",
          "updatedAt": "2023-11-07T05:31:56Z",
          "versionUuid": "<string>",
          "spaceUuid": "<string>",
          "pinnedListUuid": "<string>",
          "pinnedListOrder": 123,
          "slug": "<string>",
          "dashboardVersionId": 123,
          "verification": {
            "verifiedAt": "2023-11-07T05:31:56Z",
            "verifiedBy": {
              "lastName": "<string>",
              "firstName": "<string>",
              "userUuid": "<string>"
            }
          },
          "tiles": [
            {
              "uuid": "<string>",
              "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
                },
                "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
                },
                "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
                },
                "values": [
                  "<unknown>"
                ],
                "settings": "<unknown>",
                "disabled": true,
                "required": true,
                "caseSensitive": true,
                "lockedTabUuids": [
                  "<string>"
                ],
                "singleValue": true,
                "label": "<string>",
                "tileTargets": {}
              }
            ]
          },
          "spaceName": "<string>",
          "views": 123,
          "firstViewedAt": "<string>",
          "tabs": [
            {
              "hidden": true,
              "order": 123,
              "name": "<string>",
              "uuid": "<string>"
            }
          ],
          "colorPaletteUuid": "<string>",
          "spacePath": "<string>",
          "spaceSlug": "<string>",
          "description": "<string>",
          "parameters": {},
          "updatedByUser": {
            "userUuid": "<string>",
            "firstName": "<string>",
            "lastName": "<string>"
          },
          "config": {
            "isDateZoomDisabled": true,
            "dateZoomGranularities": [],
            "parameterOrder": [
              "<string>"
            ],
            "pinnedParameters": [
              "<string>"
            ],
            "isAddFilterDisabled": true
          },
          "deletedAt": "2023-11-07T05:31:56Z",
          "deletedBy": {
            "lastName": "<string>",
            "firstName": "<string>",
            "userUuid": "<string>"
          }
        }
      }
    ],
    "spaces": [
      {
        "data": {
          "name": "<string>",
          "projectUuid": "<string>",
          "organizationUuid": "<string>",
          "uuid": "<string>",
          "inheritParentPermissions": true,
          "pinnedListUuid": "<string>",
          "pinnedListOrder": 123,
          "slug": "<string>",
          "parentSpaceUuid": "<string>",
          "path": "<string>",
          "appCount": 123,
          "childSpaceCount": 123,
          "dashboardCount": 123,
          "chartCount": 123,
          "deletedBy": {
            "lastName": "<string>",
            "firstName": "<string>",
            "userUuid": "<string>"
          },
          "deletedAt": "2023-11-07T05:31:56Z"
        }
      }
    ],
    "sqlCharts": [
      {
        "data": {
          "spacePath": "<string>",
          "spaceSlug": "<string>",
          "description": "<string>",
          "name": "<string>",
          "projectUuid": "<string>",
          "slug": "<string>",
          "oldUuid": "<string>",
          "uuid": "<string>"
        }
      }
    ]
  }
}

Path Parameters

projectUuid · string · required

slug · string · required

Body

application/json

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

name · string · required

Display name of the chart

version · number<double> · required

Schema version for this chart configuration

slug · string · required

Unique identifier slug for this chart

tableName · string · required

The explore/table name this chart queries from

metricQuery · object · required

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

Show child attributes

spaceSlug · string · required

Slug of the space containing this chart

chartConfig · any · required

This AnyType is an alias for any The goal is to make it easier to identify any type in the codebase without having to eslint-disable all the time These are only used on legacy any types, don't use it for new types. This is added on a separate file to avoid circular dependencies.

parameters · object

Parameter values for the chart query

Show child attributes

updatedAt · string<date-time>

Not modifiable by user, but useful to know if it has been updated. Defaults to now if omitted.

verification · object

Detailed verification info (who/when). Read-only; ignored on upload.

Show child attributes

pivotConfig · object

Pivot table configuration

Show child attributes

tableConfig · object

Table configuration. Defaults to empty column order if omitted.

Show child attributes

dashboardSlug · string

Slug of the dashboard this chart belongs to (if any)

contentType · enum<string>

Content type discriminator

Available options: chart

downloadedAt · string<date-time>

Timestamp when this chart was downloaded from Lightdash

verified · boolean

Declarative verification state. true verifies the chart on upload, false unverifies it, undefined leaves the current state untouched. Download sets this to true when the chart is verified.

description · string | null

spaceNames · object

Construct a type with a set of properties K of type T

Show child attributes

force · boolean

publicSpaceCreate · boolean

skipSpaceCreate · boolean

Response

200

application/json

Success

results · object · required

Show child attributes

status · enum<string> · required

Available options: ok