Download CSV from explore

Download CSV from an explore query

POST /api/v1/projects/{projectUuid}/explores/{exploreId}/downloadCsv

Error

A valid request URL is required to generate request examples

200

{
  "results": {
    "jobId": "<string>"
  },
  "status": "ok"
}

Path Parameters

exploreId · string · required

projectUuid · string · required

Body

application/json

tableCalculations · object[] · required

Option 1

Option 2

Show child attributes

limit · number<double> · required

sorts · object[] · required

Show child attributes

filters · object · required

Show child attributes

metrics · string[] · required

dimensions · string[] · required

exploreName · string · required

columnOrder · string[] · required

showTableNames · boolean · required

onlyRaw · boolean · required

metadata · object

Show child attributes

timezone · string

dimensionOverrides · object

Show child attributes

metricOverrides · object

Show child attributes

customDimensions · object[]

Option 1

Option 2

Show child attributes

additionalMetrics · object[]

Show child attributes

pivotConfig · object

Show child attributes

chartName · string

hiddenFields · string[]

customLabels · object

Show child attributes

csvLimit · number<double> | null

Response

200

application/json

Success

results · object · required

Show child attributes

status · enum<string> · required

Available options: ok