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\"": []
    }
  }
}
'

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
  }
}

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
}