Create Export

Initiates an export of a DataSet to an S3 bucket (asynchronous). Only one active export can run per DataSet at a time. Returns previous export info if data hasn’t changed.

POST /api/query/v1/export/{DATASOURCE_ID}

Create Export

cURL

curl --request POST \
  --url https://{instance}.domo.com/api/query/v1/export/{DATASOURCE_ID} \
  --header 'Content-Type: application/json' \
  --header 'X-DOMO-Developer-Token: <api-key>' \
  --data '
{
  "awsAccessKey": "<AWS_KEY>",
  "awsAccessSecret": "<AWS_SECRET>",
  "bucket": "<BUCKET>",
  "path": "<PATH>",
  "region\"": "<REGION>",
  "queryRequest": {
    "includeBOM": true,
    "useCache": true,
    "query": {
      "columns": [
        {
          "column": "Customer ID",
          "exprType": "COLUMN"
        },
        {
          "column": "Date Filled",
          "exprType": "COLUMN"
        }
      ],
      "groupByColumns\"": [],
      "orderByColumns\"": []
    }
  }
}
'

import requests

url = "https://{instance}.domo.com/api/query/v1/export/{DATASOURCE_ID}"

payload = {
    "awsAccessKey": "<AWS_KEY>",
    "awsAccessSecret": "<AWS_SECRET>",
    "bucket": "<BUCKET>",
    "path": "<PATH>",
    "region"": "<REGION>",
    "queryRequest": {
        "includeBOM": True,
        "useCache": True,
        "query": {
            "columns": [
                {
                    "column": "Customer ID",
                    "exprType": "COLUMN"
                },
                {
                    "column": "Date Filled",
                    "exprType": "COLUMN"
                }
            ],
            "groupByColumns"": [],
            "orderByColumns"": []
        }
    }
}
headers = {
    "X-DOMO-Developer-Token": "<api-key>",
    "Content-Type": "application/json"
}

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

print(response.text)

const options = {
  method: 'POST',
  headers: {'X-DOMO-Developer-Token': '<api-key>', 'Content-Type': 'application/json'},
  body: JSON.stringify({
    awsAccessKey: '<AWS_KEY>',
    awsAccessSecret: '<AWS_SECRET>',
    bucket: '<BUCKET>',
    path: '<PATH>',
    'region"': '<REGION>',
    queryRequest: {
      includeBOM: true,
      useCache: true,
      query: {
        columns: [
          {column: 'Customer ID', exprType: 'COLUMN'},
          {column: 'Date Filled', exprType: 'COLUMN'}
        ],
        'groupByColumns"': [],
        'orderByColumns"': []
      }
    }
  })
};

fetch('https://{instance}.domo.com/api/query/v1/export/{DATASOURCE_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://{instance}.domo.com/api/query/v1/export/{DATASOURCE_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([
    'awsAccessKey' => '<AWS_KEY>',
    'awsAccessSecret' => '<AWS_SECRET>',
    'bucket' => '<BUCKET>',
    'path' => '<PATH>',
    'region"' => '<REGION>',
    'queryRequest' => [
        'includeBOM' => true,
        'useCache' => true,
        'query' => [
                'columns' => [
                                [
                                                                'column' => 'Customer ID',
                                                                'exprType' => 'COLUMN'
                                ],
                                [
                                                                'column' => 'Date Filled',
                                                                'exprType' => 'COLUMN'
                                ]
                ],
                'groupByColumns"' => [
                                
                ],
                'orderByColumns"' => [
                                
                ]
        ]
    ]
  ]),
  CURLOPT_HTTPHEADER => [
    "Content-Type: application/json",
    "X-DOMO-Developer-Token: <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://{instance}.domo.com/api/query/v1/export/{DATASOURCE_ID}"

	payload := strings.NewReader("{\n  \"awsAccessKey\": \"<AWS_KEY>\",\n  \"awsAccessSecret\": \"<AWS_SECRET>\",\n  \"bucket\": \"<BUCKET>\",\n  \"path\": \"<PATH>\",\n  \"region\\\"\": \"<REGION>\",\n  \"queryRequest\": {\n    \"includeBOM\": true,\n    \"useCache\": true,\n    \"query\": {\n      \"columns\": [\n        {\n          \"column\": \"Customer ID\",\n          \"exprType\": \"COLUMN\"\n        },\n        {\n          \"column\": \"Date Filled\",\n          \"exprType\": \"COLUMN\"\n        }\n      ],\n      \"groupByColumns\\\"\": [],\n      \"orderByColumns\\\"\": []\n    }\n  }\n}")

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

	req.Header.Add("X-DOMO-Developer-Token", "<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://{instance}.domo.com/api/query/v1/export/{DATASOURCE_ID}")
  .header("X-DOMO-Developer-Token", "<api-key>")
  .header("Content-Type", "application/json")
  .body("{\n  \"awsAccessKey\": \"<AWS_KEY>\",\n  \"awsAccessSecret\": \"<AWS_SECRET>\",\n  \"bucket\": \"<BUCKET>\",\n  \"path\": \"<PATH>\",\n  \"region\\\"\": \"<REGION>\",\n  \"queryRequest\": {\n    \"includeBOM\": true,\n    \"useCache\": true,\n    \"query\": {\n      \"columns\": [\n        {\n          \"column\": \"Customer ID\",\n          \"exprType\": \"COLUMN\"\n        },\n        {\n          \"column\": \"Date Filled\",\n          \"exprType\": \"COLUMN\"\n        }\n      ],\n      \"groupByColumns\\\"\": [],\n      \"orderByColumns\\\"\": []\n    }\n  }\n}")
  .asString();

require 'uri'
require 'net/http'

url = URI("https://{instance}.domo.com/api/query/v1/export/{DATASOURCE_ID}")

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

request = Net::HTTP::Post.new(url)
request["X-DOMO-Developer-Token"] = '<api-key>'
request["Content-Type"] = 'application/json'
request.body = "{\n  \"awsAccessKey\": \"<AWS_KEY>\",\n  \"awsAccessSecret\": \"<AWS_SECRET>\",\n  \"bucket\": \"<BUCKET>\",\n  \"path\": \"<PATH>\",\n  \"region\\\"\": \"<REGION>\",\n  \"queryRequest\": {\n    \"includeBOM\": true,\n    \"useCache\": true,\n    \"query\": {\n      \"columns\": [\n        {\n          \"column\": \"Customer ID\",\n          \"exprType\": \"COLUMN\"\n        },\n        {\n          \"column\": \"Date Filled\",\n          \"exprType\": \"COLUMN\"\n        }\n      ],\n      \"groupByColumns\\\"\": [],\n      \"orderByColumns\\\"\": []\n    }\n  }\n}"

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

200

{
  "bucket": "<string>",
  "compression": "none",
  "errorCode": "<string>",
  "exportFormat": "csv",
  "exportId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "exportStatus": "success",
  "finished": "2023-11-07T05:31:56Z",
  "message": "<string>",
  "started": "2023-11-07T05:31:56Z",
  "urlRowCountMap": {
    "additionalProp1": 0,
    "additionalProp2": 0
  }
}

{
  "errorCode": "<string>",
  "message": "<string>"
}

{
  "errorCode": "<string>",
  "message": "<string>"
}

{
  "errorCode": "<string>",
  "message": "<string>"
}

{
  "errorCode": "<string>",
  "message": "<string>"
}

{
  "errorCode": "<string>",
  "message": "<string>"
}

Authorizations

X-DOMO-Developer-Token · string · header · required

Domo Developer Token for authentication.

Path Parameters

DATASOURCE_ID · string · required

The ID of the Dataset.

Example:

"aa7d9422-9abe-4581-bbf3-4a8cb5d3fc25"

Body

application/json

awsAccessKey · string · required

AWS Access Key ID.

awsAccessSecret · string · required

AWS Secret Access Key.

bucket · string · required

The target S3 bucket name.

path · string · required

The path within the bucket.

region · string · required

The AWS region of the bucket.

queryRequest · object · required

Show child attributes

Response

200

application/json

OK. Export initiated or previous export info returned.

Represents the status of a dataset export.

bucket · string

compression · string

Example:

"none"

errorCode · string | null

exportFormat · string

Example:

"csv"

exportId · string<uuid>

exportStatus · enum<string>

Available options: none, success, running, failed

Example:

"success"

finished · string<date-time>

message · string | null

started · string<date-time>

urlRowCountMap · object

Show child attributes

Example:

{
  "additionalProp1": 0,
  "additionalProp2": 0
}