Get SQL charts as code

Gets SQL charts in code representation

GET /api/v1/projects/{projectUuid}/sqlCharts/code

Error

A valid request URL is required to generate request examples

200

{
  "results": {
    "offset": 123,
    "total": 123,
    "spaces": [
      {
        "slug": "<string>",
        "spaceName": "<string>",
        "contentType": "space"
      }
    ],
    "missingIds": [
      "<string>"
    ],
    "sqlCharts": [
      {
        "description": "<string>",
        "name": "<string>",
        "limit": 123,
        "slug": "<string>",
        "config": {
          "type": "vertical_bar",
          "metadata": {
            "version": 123
          },
          "display": {
            "stack": true,
            "legend": {},
            "series": {},
            "yAxis": [
              {
                "position": "<string>",
                "label": "<string>"
              }
            ],
            "xAxis": {
              "dateFormat": "<string>",
              "label": "<string>"
            }
          },
          "fieldConfig": {
            "y": [
              {
                "reference": "<string>"
              }
            ],
            "stack": true,
            "sortBy": [
              {
                "reference": "<string>",
                "pivotValues": [
                  {
                    "value": "<string>",
                    "reference": "<string>"
                  }
                ],
                "nullsFirst": true
              }
            ],
            "groupBy": [
              {
                "reference": "<string>"
              }
            ],
            "x": {
              "reference": "<string>"
            }
          }
        },
        "sql": "<string>",
        "spaceSlug": "<string>",
        "version": 123,
        "downloadedAt": "2023-11-07T05:31:56Z",
        "updatedAt": "2023-11-07T05:31:56Z",
        "contentType": "sql_chart"
      }
    ]
  },
  "status": "ok"
}

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

Path Parameters

projectUuid · string · required

Query Parameters

ids · string[]

offset · number<double>

Response

200

application/json

Success

results · object · required

Show child attributes

status · enum<string> · required

Available options: ok