Get dataset information

Get dataset metadata for the specified user, namespace, and dataset.

GET /data/{username}/{namespace}/{datasetName}

Get dataset information

cURL

curl --request GET \
  --url https://api.datalinks.com/api/v1/data/{username}/{namespace}/{datasetName} \
  --header 'Authorization: Bearer <token>'

import requests

url = "https://api.datalinks.com/api/v1/data/{username}/{namespace}/{datasetName}"

headers = {"Authorization": "Bearer <token>"}

response = requests.get(url, headers=headers)

print(response.text)

const options = {method: 'GET', headers: {Authorization: 'Bearer <token>'}};

fetch('https://api.datalinks.com/api/v1/data/{username}/{namespace}/{datasetName}', 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.datalinks.com/api/v1/data/{username}/{namespace}/{datasetName}",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "GET",
  CURLOPT_HTTPHEADER => [
    "Authorization: Bearer <token>"
  ],
]);

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

curl_close($curl);

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

package main

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

func main() {

	url := "https://api.datalinks.com/api/v1/data/{username}/{namespace}/{datasetName}"

	req, _ := http.NewRequest("GET", url, nil)

	req.Header.Add("Authorization", "Bearer <token>")

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

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

	fmt.Println(string(body))

}

HttpResponse<String> response = Unirest.get("https://api.datalinks.com/api/v1/data/{username}/{namespace}/{datasetName}")
  .header("Authorization", "Bearer <token>")
  .asString();

require 'uri'
require 'net/http'

url = URI("https://api.datalinks.com/api/v1/data/{username}/{namespace}/{datasetName}")

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

request = Net::HTTP::Get.new(url)
request["Authorization"] = 'Bearer <token>'

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

200

{
  "dataset": {
    "name": "<string>",
    "namespace": "<string>",
    "owner": "<string>",
    "nameWithNamespace": "<string>",
    "user": "<string>"
  },
  "metadata": {
    "columnNames": [
      "id",
      "name",
      "age",
      "department",
      "salary"
    ],
    "rowCount": 1250,
    "dataDescription": "Employee dataset containing demographics and compensation.",
    "schemaDefinition": {
      "id": "unique employee identifier",
      "name": "full employee name",
      "age": "employee age in years",
      "department": "work department",
      "salary": "annual salary in USD"
    }
  }
}

Authorizations

bearerAuthopenId

Authorization · string · header · required

Use a Bearer token for authentication. Submit the token using the Authorization header: Authorization: Bearer <token>.

Path Parameters

namespace · string · required

Namespace for the dataset.

datasetName · string · required

Name of the dataset.

username · string · required

The username associated with the request.

Response

200

application/json

Returns dataset metadata.

dataset · object · required

Show child attributes

metadata · object · required

Show child attributes