Query a DataSet

Queries the data in an existing Domo DataSet

POST /v1/datasets/query/execute/{dataset_id}

Query a DataSet

cURL

curl --request POST \
  --url https://api.domo.com/v1/datasets/query/execute/{dataset_id} \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "sql": "SELECT * FROM table"
}
'

import requests

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

payload = { "sql": "SELECT * FROM table" }
headers = {
    "Authorization": "Bearer <token>",
    "Content-Type": "application/json"
}

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

print(response.text)

const options = {
  method: 'POST',
  headers: {Authorization: 'Bearer <token>', 'Content-Type': 'application/json'},
  body: JSON.stringify({sql: 'SELECT * FROM table'})
};

fetch('https://api.domo.com/v1/datasets/query/execute/{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/query/execute/{dataset_id}",
  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([
    'sql' => 'SELECT * FROM table'
  ]),
  CURLOPT_HTTPHEADER => [
    "Authorization: Bearer <token>",
    "Content-Type: application/json"
  ],
]);

$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.domo.com/v1/datasets/query/execute/{dataset_id}"

	payload := strings.NewReader("{\n  \"sql\": \"SELECT * FROM table\"\n}")

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

	req.Header.Add("Authorization", "Bearer <token>")
	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.domo.com/v1/datasets/query/execute/{dataset_id}")
  .header("Authorization", "Bearer <token>")
  .header("Content-Type", "application/json")
  .body("{\n  \"sql\": \"SELECT * FROM table\"\n}")
  .asString();

require 'uri'
require 'net/http'

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

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

request = Net::HTTP::Post.new(url)
request["Authorization"] = 'Bearer <token>'
request["Content-Type"] = 'application/json'
request.body = "{\n  \"sql\": \"SELECT * FROM table\"\n}"

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

200

{
  "datasource": "ce79d23f-ef7d-4318-9787-ebde54a8c5b4",
  "columns": [
    "Description",
    "% of Inventory Value",
    "Cost",
    "Total Inventory Value",
    "_BATCH_ID_",
    "_BATCH_LAST_RUN_"
  ],
  "metadata": [
    {
      "type": "STRING",
      "dataSourceId": "ce79d23f-ef7d-4318-9787-ebde54a8c5b4",
      "maxLength": -1,
      "minLength": -1,
      "periodIndex": 0
    },
    {
      "type": "DOUBLE",
      "dataSourceId": "ce79d23f-ef7d-4318-9787-ebde54a8c5b4",
      "maxLength": -1,
      "minLength": -1,
      "periodIndex": 0
    },
    {
      "type": "LONG",
      "dataSourceId": "ce79d23f-ef7d-4318-9787-ebde54a8c5b4",
      "maxLength": -1,
      "minLength": -1,
      "periodIndex": 0
    },
    {
      "type": "LONG",
      "dataSourceId": "ce79d23f-ef7d-4318-9787-ebde54a8c5b4",
      "maxLength": -1,
      "minLength": -1,
      "periodIndex": 0
    },
    {
      "type": "DOUBLE",
      "dataSourceId": "ce79d23f-ef7d-4318-9787-ebde54a8c5b4",
      "maxLength": -1,
      "minLength": -1,
      "periodIndex": 0
    },
    {
      "type": "DATETIME",
      "dataSourceId": "ce79d23f-ef7d-4318-9787-ebde54a8c5b4",
      "maxLength": -1,
      "minLength": -1,
      "periodIndex": 0
    }
  ],
  "rows": [
    [
      "Maintenance",
      0.0035,
      35000,
      10000000,
      410,
      "2019-03-19T18:49:02"
    ],
    [
      "Labor",
      0.007,
      70000,
      10000000,
      410,
      "2019-03-19T18:49:02"
    ],
    [
      "Utilities",
      0.0087,
      87000,
      10000000,
      410,
      "2019-03-19T18:49:02"
    ],
    [
      "Space",
      0.025,
      250000,
      10000000,
      410,
      "2019-03-19T18:49:02"
    ]
  ],
  "numRows": 4,
  "numColumns": 6,
  "fromcache": true
}

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

Body

application/json

sql · string · required

Response

200 - application/json

Returns data from the DataSet based on your SQL query.

datasource · string

columns · string[]

metadata · object[]

Show child attributes

rows · string[]

numRows · integer

numColumns · integer

fromcache · boolean