Post apiv1projects sqlrunnersaved - Lightdash

Error

A valid request URL is required to generate request examples

{
  "results": {
    "slug": "<string>",
    "savedSqlUuid": "<string>"
  },
  "status": "ok"
}

POST

/

api

/

v1

/

projects

/

{projectUuid}

/

sqlRunner

/

saved

Error

A valid request URL is required to generate request examples

{
  "results": {
    "slug": "<string>",
    "savedSqlUuid": "<string>"
  },
  "status": "ok"
}

Path Parameters

projectUuid

string

required

the uuid for the project

Body

application/json

the sql chart to create

the sql chart to create

spaceUuid

string

required

config

object

required

Option 1
Option 2
Option 3
Option 4

Show child attributes

config.type

enum<string>

required

Available options:

vertical_bar

config.metadata

object

required

Show child attributes

config.metadata.version

number<double>

required

config.display

object

Show child attributes

config.display.stack

config.display.legend

object

Show child attributes

config.display.legend.align

enum<string>

required

Available options:

start,

center,

end

config.display.legend.position

enum<string>

required

Available options:

top,

bottom,

left,

right

config.display.series

object

Show child attributes

config.display.series.{key}

object

Show child attributes

config.display.series.{key}.whichYAxis

enum<number>

Available options:

0,

1

config.display.series.{key}.valueLabelPosition

enum<string>

Available options:

hidden,

top,

bottom,

left,

right,

inside

config.display.series.{key}.type

Available options:

line

config.display.series.{key}.color

string

config.display.series.{key}.yAxisIndex

number<double>

config.display.series.{key}.format

enum<string>

Available options:

km,

mi,

usd,

gbp,

eur,

jpy,

dkk,

id,

percent

config.display.series.{key}.label

string

config.display.yAxis

object[]

Show child attributes

config.display.yAxis.format

enum<string>

Available options:

km,

mi,

usd,

gbp,

eur,

jpy,

dkk,

id,

percent

config.display.yAxis.position

string

config.display.yAxis.label

string

config.display.xAxis

object

Show child attributes

config.display.xAxis.type

enum<string>

Available options:

time,

category

config.display.xAxis.label

string

config.fieldConfig

object

Show child attributes

config.fieldConfig.y

object[]

required

Show child attributes

config.fieldConfig.y.aggregation

enum<string>

required

Available options:

sum,

count,

avg,

min,

max,

any

config.fieldConfig.y.reference

string

required

config.fieldConfig.stack

config.fieldConfig.sortBy

object[]

Show child attributes

config.fieldConfig.sortBy.direction

enum<string>

required

Available options:

ASC,

DESC

config.fieldConfig.sortBy.reference

string

required

config.fieldConfig.groupBy

object[]

Show child attributes

config.fieldConfig.groupBy.reference

string

required

config.fieldConfig.x

object

Show child attributes

config.fieldConfig.x.type

enum<string>

required

Available options:

time,

category

config.fieldConfig.x.reference

string

required

limit

number<double>

required

sql

string

required

description

string | null

required

name

string

required

slug

string

Response

Success

results

object

required

Show child attributes

results.slug

string

required

results.savedSqlUuid

string

required

status

enum<string>

required

Available options:

ok

Get apiv1projects sqlrunnersaved results job Post apiv1projects sqlrunnerrefresh catalog

⌘I