Explores (Deprecated)

Explore API Reference

Retreive all

get

Query parameters

projectIdstringOptional

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

folderIdstringOptional

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

limitstringOptional

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

Responses

200

List of explores

application/json

idstringRequiredExample: 8aec2615e1c540d2b71129a3a9e5fdc3

namestringRequiredExample: order details

ownerIdstringRequiredExample: 85ae22a39ef14788987f5b915938f050

folderIdstringRequiredExample: 6be53896a0604c0d817f638229f83ac9

scheduledbooleanRequiredExample: true

createTimenumberRequiredExample: 1660439099000

updateTimenumberRequiredExample: 1660445539000

get

/explores

HTTPcURLJavaScriptPython

GET /api/v2/explores HTTP/1.1
Host: API_HOST
Accept: */*

200

List of explores

[
  {
    "id": "8aec2615e1c540d2b71129a3a9e5fdc3",
    "name": "order details",
    "ownerId": "85ae22a39ef14788987f5b915938f050",
    "folderId": "6be53896a0604c0d817f638229f83ac9",
    "scheduled": true,
    "createTime": 1660439099000,
    "updateTime": 1660445539000
  }
]

Retreive

get

Path parameters

idstringRequired

explore id

Responses

200

Details about the explore

application/json

idstringRequiredExample: 8aec2615e1c540d2b71129a3a9e5fdc3

namestringRequiredExample: order details

ownerIdstringRequiredExample: 85ae22a39ef14788987f5b915938f050

folderIdstringRequiredExample: 6be53896a0604c0d817f638229f83ac9

encodedSQLstringRequiredExample: c2VsZWN0ICogZnJvbSB0ZXN0OTk5

createTimenumberRequiredExample: 1660439099000

updateTimenumberRequiredExample: 1660445539000

get

/explores/{id}

HTTPcURLJavaScriptPython

GET /api/v2/explores/{id} HTTP/1.1
Host: API_HOST
Accept: */*

200

Details about the explore

{
  "id": "8aec2615e1c540d2b71129a3a9e5fdc3",
  "name": "order details",
  "ownerId": "85ae22a39ef14788987f5b915938f050",
  "folderId": "6be53896a0604c0d817f638229f83ac9",
  "encodedSQL": "c2VsZWN0ICogZnJvbSB0ZXN0OTk5",
  "createTime": 1660439099000,
  "updateTime": 1660445539000
}

Retreive latest success job details

get

Path parameters

idstringRequired

explore id

Responses

200

Details about the latest success job

application/json

startTimenumberRequiredExample: 1660439099000

endTimenumberRequiredExample: 1660445539000

outputPathstringRequiredExample: 8aec2615e1c540d2b71129a3a9e5fdc3

get

/explores/{id}/job/latestsuccess

HTTPcURLJavaScriptPython

GET /api/v2/explores/{id}/job/latestsuccess HTTP/1.1
Host: API_HOST
Accept: */*

200

Details about the latest success job

{
  "startTime": 1660439099000,
  "endTime": 1660445539000,
  "outputPath": "8aec2615e1c540d2b71129a3a9e5fdc3"
}

Returns explore result in csv format

get

Path parameters

idstringRequired

explore id

Responses

200

Result in CSV format

text/csv

Responsestring

get

/explores/{id}/download

HTTPcURLJavaScriptPython

GET /api/v2/explores/{id}/download HTTP/1.1
Host: API_HOST
Accept: */*

200

Result in CSV format

text