Create a DataSet

Creates a new DataSet in your Domo instance. Once a DataSet has been created, data can be imported into the DataSet.

POST /v1/datasets

Create a DataSet

cURL

curl --request POST \
  --url https://api.domo.com/v1/datasets \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "name": "Leonhard Euler Party",
  "description": "Mathematician Guest List",
  "rows": 0,
  "schema": {
    "columns": [
      {
        "type": "STRING",
        "name": "Friend"
      },
      {
        "type": "STRING",
        "name": "Attending"
      }
    ]
  }
}
'

import requests

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

payload = {
    "name": "Leonhard Euler Party",
    "description": "Mathematician Guest List",
    "rows": 0,
    "schema": { "columns": [
            {
                "type": "STRING",
                "name": "Friend"
            },
            {
                "type": "STRING",
                "name": "Attending"
            }
        ] }
}
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({
    name: 'Leonhard Euler Party',
    description: 'Mathematician Guest List',
    rows: 0,
    schema: {
      columns: [{type: 'STRING', name: 'Friend'}, {type: 'STRING', name: 'Attending'}]
    }
  })
};

fetch('https://api.domo.com/v1/datasets', 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",
  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([
    'name' => 'Leonhard Euler Party',
    'description' => 'Mathematician Guest List',
    'rows' => 0,
    'schema' => [
        'columns' => [
                [
                                'type' => 'STRING',
                                'name' => 'Friend'
                ],
                [
                                'type' => 'STRING',
                                'name' => 'Attending'
                ]
        ]
    ]
  ]),
  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"

	payload := strings.NewReader("{\n  \"name\": \"Leonhard Euler Party\",\n  \"description\": \"Mathematician Guest List\",\n  \"rows\": 0,\n  \"schema\": {\n    \"columns\": [\n      {\n        \"type\": \"STRING\",\n        \"name\": \"Friend\"\n      },\n      {\n        \"type\": \"STRING\",\n        \"name\": \"Attending\"\n      }\n    ]\n  }\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")
  .header("Authorization", "Bearer <token>")
  .header("Content-Type", "application/json")
  .body("{\n  \"name\": \"Leonhard Euler Party\",\n  \"description\": \"Mathematician Guest List\",\n  \"rows\": 0,\n  \"schema\": {\n    \"columns\": [\n      {\n        \"type\": \"STRING\",\n        \"name\": \"Friend\"\n      },\n      {\n        \"type\": \"STRING\",\n        \"name\": \"Attending\"\n      }\n    ]\n  }\n}")
  .asString();

require 'uri'
require 'net/http'

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

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  \"name\": \"Leonhard Euler Party\",\n  \"description\": \"Mathematician Guest List\",\n  \"rows\": 0,\n  \"schema\": {\n    \"columns\": [\n      {\n        \"type\": \"STRING\",\n        \"name\": \"Friend\"\n      },\n      {\n        \"type\": \"STRING\",\n        \"name\": \"Attending\"\n      }\n    ]\n  }\n}"

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

201

{
  "id": "4405ff58-1957-45f0-82bd-914d989a3ea3",
  "name": "Leonhard Euler Party",
  "description": "Mathematician Guest List",
  "rows": 0,
  "columns": 0,
  "schema": {
    "columns": [
      {
        "type": "STRING",
        "name": "Friend"
      },
      {
        "type": "STRING",
        "name": "Attending"
      }
    ]
  },
  "owner": {
    "id": 27,
    "name": "DomoSupport"
  },
  "createdAt": "2016-06-21T17:20:36Z",
  "updatedAt": "2016-06-21T17:20:36Z"
}

Authorizations

Authorization · string · header · required

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

Body

application/json

name · string · required

Name of the DataSet to create

schema · object · required

The current schema associated with this DataSet

Show child attributes

description · string

Description of DataSet to create

Response

201 - application/json

Returns a DataSet object when successful. The returned object will have DataSet attributes based on the information provided when the DataSet was created.

id · string

name · string

description · string

rows · integer

columns · integer

schema · object

Show child attributes

owner · object

Show child attributes

createdAt · string

updatedAt · string