Explores (Deprecated)

Explore API Reference

Retreive all

get

/explores

Query parameters
projectIdstring

The project Id from which to retreive. If not given, then default project is used

folderIdstring

The folder Id acc. to which records will be retrieved. If not given, then all explores will be retrieved

limitstring

The number of records to retrieve. If not given, then by default 1000 explores will be fetched.

Responses
curl -L \
  --url 'https://API_HOST/api/v2/explores'
[
  {
    "id": "8aec2615e1c540d2b71129a3a9e5fdc3",
    "name": "order details",
    "ownerId": "85ae22a39ef14788987f5b915938f050",
    "folderId": "6be53896a0604c0d817f638229f83ac9",
    "scheduled": true,
    "createTime": 1660439099000,
    "updateTime": 1660445539000
  }
]

List of explores

Retreive

get

/explores/{id}

Path parameters
idstringrequired

explore id

Responses
curl -L \
  --url 'https://API_HOST/api/v2/explores/{id}'
{
  "id": "8aec2615e1c540d2b71129a3a9e5fdc3",
  "name": "order details",
  "ownerId": "85ae22a39ef14788987f5b915938f050",
  "folderId": "6be53896a0604c0d817f638229f83ac9",
  "encodedSQL": "c2VsZWN0ICogZnJvbSB0ZXN0OTk5",
  "createTime": 1660439099000,
  "updateTime": 1660445539000
}

Details about the explore

Retreive latest success job details

get

/explores/{id}/job/latestsuccess

Path parameters
idstringrequired

explore id

Responses
curl -L \
  --url 'https://API_HOST/api/v2/explores/{id}/job/latestsuccess'
{
  "startTime": 1660439099000,
  "endTime": 1660445539000,
  "outputPath": "8aec2615e1c540d2b71129a3a9e5fdc3"
}

Details about the latest success job

Returns explore result in csv format

get

/explores/{id}/download

Path parameters
idstringrequired

explore id

Responses
curl -L \
  --url 'https://API_HOST/api/v2/explores/{id}/download'
text

Result in CSV format

PreviousCSVUploadsNextFolders

Last updated