Retrieve DataSet Details

Retrieves the details of an existing DataSet.

GET /v1/datasets/{dataset_id}

Retrieve DataSet Details

cURL

curl --request GET \
  --url https://api.domo.com/v1/datasets/{dataset_id} \
  --header 'Authorization: Bearer <token>'

import requests

url = "https://api.domo.com/v1/datasets/{dataset_id}"

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

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

print(response.text)

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

fetch('https://api.domo.com/v1/datasets/{dataset_id}', 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.domo.com/v1/datasets/{dataset_id}",
  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.domo.com/v1/datasets/{dataset_id}"

	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.domo.com/v1/datasets/{dataset_id}")
  .header("Authorization", "Bearer <token>")
  .asString();

require 'uri'
require 'net/http'

url = URI("https://api.domo.com/v1/datasets/{dataset_id}")

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

{
  "id": "08a061e2-12a2-4646-b4bc-20beddb403e3",
  "name": "Timeline Feed",
  "description": "Important",
  "rows": 1,
  "columns": 6,
  "schema": {
    "columns": [
      {
        "type": "STRING",
        "name": "Name"
      }
    ]
  },
  "createdAt": "2015-12-10T07:06:14Z",
  "updatedAt": "2016-02-29T20:56:20.567Z",
  "pdpEnabled": false,
  "policies": [
    {
      "id": 8,
      "type": "user",
      "name": "Only Show Attendees",
      "filters": [
        {
          "column": "Attending",
          "values": [
            "TRUE"
          ],
          "operator": "EQUALS",
          "not": false
        }
      ],
      "users": [
        27
      ],
      "groups": []
    }
  ]
}

Authorizations

Authorization · string · header · required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Path Parameters

dataset_id · string · required

The ID of the DataSet

Response

200

application/json

Returns a DataSet object if a valid dataset_id was provided. When requesting, if the dataset_id is related to a DataSet that has been deleted, a subset of the DataSet's information will be returned, including a deleted property, which will be true.

id · string

name · string

description · string

rows · integer

columns · integer

schema · object

Show child attributes

createdAt · string

updatedAt · string

pdpEnabled · boolean

policies · object[]

Show child attributes