Query Dataset Versions

POST /v2/datasets/{dataset_id}/versions/query

Query Dataset Versions

cURL

curl --request POST \
  --url https://api.galileo.ai/v2/datasets/{dataset_id}/versions/query \
  --header 'Content-Type: application/json' \
  --header 'Galileo-API-Key: <api-key>' \
  --data '
{
  "sort": {
    "name": "version_index",
    "ascending": true,
    "sort_type": "column"
  }
}
'

import requests

url = "https://api.galileo.ai/v2/datasets/{dataset_id}/versions/query"

payload = { "sort": {
        "name": "version_index",
        "ascending": True,
        "sort_type": "column"
    } }
headers = {
    "Galileo-API-Key": "<api-key>",
    "Content-Type": "application/json"
}

response = requests.post(url, json=payload, headers=headers)

print(response.text)

const options = {
  method: 'POST',
  headers: {'Galileo-API-Key': '<api-key>', 'Content-Type': 'application/json'},
  body: JSON.stringify({sort: {name: 'version_index', ascending: true, sort_type: 'column'}})
};

fetch('https://api.galileo.ai/v2/datasets/{dataset_id}/versions/query', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

<?php

$curl = curl_init();

curl_setopt_array($curl, [
  CURLOPT_URL => "https://api.galileo.ai/v2/datasets/{dataset_id}/versions/query",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "POST",
  CURLOPT_POSTFIELDS => json_encode([
    'sort' => [
        'name' => 'version_index',
        'ascending' => true,
        'sort_type' => 'column'
    ]
  ]),
  CURLOPT_HTTPHEADER => [
    "Content-Type: application/json",
    "Galileo-API-Key: <api-key>"
  ],
]);

$response = curl_exec($curl);
$err = curl_error($curl);

curl_close($curl);

if ($err) {
  echo "cURL Error #:" . $err;
} else {
  echo $response;
}

package main

import (
	"fmt"
	"strings"
	"net/http"
	"io"
)

func main() {

	url := "https://api.galileo.ai/v2/datasets/{dataset_id}/versions/query"

	payload := strings.NewReader("{\n  \"sort\": {\n    \"name\": \"version_index\",\n    \"ascending\": true,\n    \"sort_type\": \"column\"\n  }\n}")

	req, _ := http.NewRequest("POST", url, payload)

	req.Header.Add("Galileo-API-Key", "<api-key>")
	req.Header.Add("Content-Type", "application/json")

	res, _ := http.DefaultClient.Do(req)

	defer res.Body.Close()
	body, _ := io.ReadAll(res.Body)

	fmt.Println(string(body))

}

HttpResponse<String> response = Unirest.post("https://api.galileo.ai/v2/datasets/{dataset_id}/versions/query")
  .header("Galileo-API-Key", "<api-key>")
  .header("Content-Type", "application/json")
  .body("{\n  \"sort\": {\n    \"name\": \"version_index\",\n    \"ascending\": true,\n    \"sort_type\": \"column\"\n  }\n}")
  .asString();

require 'uri'
require 'net/http'

url = URI("https://api.galileo.ai/v2/datasets/{dataset_id}/versions/query")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Post.new(url)
request["Galileo-API-Key"] = '<api-key>'
request["Content-Type"] = 'application/json'
request.body = "{\n  \"sort\": {\n    \"name\": \"version_index\",\n    \"ascending\": true,\n    \"sort_type\": \"column\"\n  }\n}"

response = http.request(request)
puts response.read_body

200

{
  "versions": [
    {
      "version_index": 123,
      "name": "<string>",
      "created_at": "2023-11-07T05:31:56Z",
      "created_by_user": {
        "id": "<string>",
        "email": "<string>",
        "first_name": "<string>",
        "last_name": "<string>"
      },
      "num_rows": 123,
      "column_names": [
        "<string>"
      ],
      "rows_added": 123,
      "rows_removed": 123,
      "rows_edited": 123,
      "columns_added": 123,
      "columns_removed": 123,
      "columns_renamed": 123
    }
  ],
  "starting_token": 0,
  "limit": 100,
  "paginated": false,
  "next_starting_token": 123
}

{
  "detail": [
    {
      "loc": [
        "<string>"
      ],
      "msg": "<string>",
      "type": "<string>",
      "input": "<unknown>",
      "ctx": {}
    }
  ]
}

Authorizations

ClassicAPIKeyHeaderAPIKeyHeaderOAuth2PasswordBearerHTTPBasic

Galileo-API-Key · string · header · required

Path Parameters

dataset_id · string<uuid4> · required

Query Parameters

starting_token · integer · default: 0

limit · integer · default: 100

Body

application/json

sort · DatasetVersionIndexSort · object | null

Show child attributes

Response

200

application/json

Successful Response

versions · DatasetVersionDB · object[] · required

Show child attributes

starting_token · integer · default: 0

limit · integer · default: 100

paginated · boolean · default: false

next_starting_token · integer | null