Skip to main content
POST
/
api
/
v2
/
projects
/
{projectUuid}
/
query
/
{queryUuid}
/
download
Download results
curl --request POST \
  --url http://api/v2/projects/{projectUuid}/query/{queryUuid}/download \
  --header 'Content-Type: application/json' \
  --data '
{
  "type": "csv",
  "pivotConfig": {
    "rowTotals": true,
    "columnTotals": true,
    "hiddenMetricFieldIds": [
      "<string>"
    ],
    "columnOrder": [
      "<string>"
    ],
    "metricsAsRows": true,
    "pivotDimensions": [
      "<string>"
    ]
  },
  "onlyRaw": true,
  "showTableNames": true,
  "customLabels": {},
  "columnOrder": [
    "<string>"
  ],
  "hiddenFields": [
    "<string>"
  ],
  "attachmentDownloadName": "<string>"
}
'
{
  "results": {
    "fileUrl": "<string>"
  },
  "status": "ok"
}

Path Parameters

​
projectUuid
string
required
​
queryUuid
string
required

The UUID of the completed async query to download

Body

application/json

From T, pick a set of properties whose keys are in the union K

​
type
enum<string>
Available options:
csv,
image,
jsonl,
s3_jsonl,
xlsx
​
pivotConfig
object
​
onlyRaw
boolean
​
showTableNames
boolean
​
customLabels
object

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

​
columnOrder
string[]
​
hiddenFields
string[]
​
attachmentDownloadName
string

Response

Success

​
results
object
required
  • Option 1
  • Option 2
  • Option 3
​
status
enum<string>
required
Available options:
ok