Explores (Deprecated)

Explore API Reference

Retreive all

GEThttps://API_HOST/api/v2/explores

Query parameters

Response

200

List of explores

Body

application/json

id*string

Example: "8aec2615e1c540d2b71129a3a9e5fdc3"

name*string

Example: "order details"

ownerId*string

Example: "85ae22a39ef14788987f5b915938f050"

folderId*string

Example: "6be53896a0604c0d817f638229f83ac9"

scheduled*boolean

Example: true

createTime*number

Example: 1660439099000

updateTime*number

Example: 1660445539000

Request

JavaScriptCurlPython

const response = await fetch('https://API_HOST/api/v2/explores', {
    method: 'GET',
    headers: {},
});
const data = await response.json();

Response

200

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

Retreive

GEThttps://API_HOST/api/v2/explores/{id}

Path parameters

id*string

explore id

Response

200

Details about the explore

Body

application/json

id*string

Example: "8aec2615e1c540d2b71129a3a9e5fdc3"

name*string

Example: "order details"

ownerId*string

Example: "85ae22a39ef14788987f5b915938f050"

folderId*string

Example: "6be53896a0604c0d817f638229f83ac9"

encodedSQL*string

Example: "c2VsZWN0ICogZnJvbSB0ZXN0OTk5"

createTime*number

Example: 1660439099000

updateTime*number

Example: 1660445539000

Request

JavaScriptCurlPython

const response = await fetch('https://API_HOST/api/v2/explores/{id}', {
    method: 'GET',
    headers: {},
});
const data = await response.json();

Response

200

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

Retreive latest success job details

GEThttps://API_HOST/api/v2/explores/{id}/job/latestsuccess

Path parameters

id*string

explore id

Response

200

Details about the latest success job

Body

application/json

startTime*number

Example: 1660439099000

endTime*number

Example: 1660445539000

outputPath*string

Example: "8aec2615e1c540d2b71129a3a9e5fdc3"

Request

JavaScriptCurlPython

const response = await fetch('https://API_HOST/api/v2/explores/{id}/job/latestsuccess', {
    method: 'GET',
    headers: {},
});
const data = await response.json();

Response

200

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

Returns explore result in csv format

GEThttps://API_HOST/api/v2/explores/{id}/download

Path parameters

id*string

explore id

Response

200

Result in CSV format

Headers

Body

text/csv

string

Request

JavaScriptCurlPython

const response = await fetch('https://API_HOST/api/v2/explores/{id}/download', {
    method: 'GET',
    headers: {},
});
const data = await response.json();

Response

200

text