Help Desk

Submit a ticket My Tickets
Welcome
Login

Domo Command Reference

A Connector for Domo for interacting with datasets and other aspects of a Domo instance via the Rest API

Connections

Domo

Connection for Domo via a Domo Client using OAuth2

Inputs

Input Type Detail Notes
Client ID TextField The Client ID of the Domo Client
Client Secret TextField The Client Secret for the Domo Client
Host Domain TextField The host domain for the Domo instance. The default is: api.domo.com

Commands

Create a DataSet

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

Inputs

Input Type Detail Notes
DataSet Properties GroupField The properties for the new DataSet.

Outputs

Output Output Type Notes
DataSet File

Exit Codes

Code Type Detail
0 Success Success
1 Error The command failed to execute
2 Error There was an error authenticating with Domo

Delete a DataSet

Permanently deletes a DataSet from your Domo instance. This can be done for all DataSets, not just those created through the API

Inputs

Input Type Detail Notes
DataSet ID TextField The ID of the DataSet

Outputs

None

Exit Codes

Code Type Detail
0 Success Success
1 Error The command failed to execute
2 Error There was an error authenticating with Domo

Export data from DataSet

Export data from a DataSet in your Domo instance.

Inputs

Input Type Detail Notes
DataSet ID TextField The ID of the DataSet
Include Header BooleanField Include table header

Outputs

Output Output Type Notes
DataSet Data (CSV) File

Exit Codes

Code Type Detail
0 Success Success
1 Error The command failed to execute
2 Error There was an error authenticating with Domo

Get DataSet

Retrieves the details of an existing DataSet

Inputs

Input Type Detail Notes
DataSet ID TextField The ID of the DataSet

Outputs

Output Output Type Notes
DataSet File

Exit Codes

Code Type Detail
0 Success Success
1 Error The command failed to execute
2 Error There was an error authenticating with Domo

Get a Stream

Retrieves the details of an existing stream by ID or by DataSet ID

Inputs

Input Type Detail Notes
DataSet ID TextField If this property is used, the Stream associated with this DataSet ID will be retrieved.
Stream ID TextField If this property is used, the Stream with this ID will be retrieved.

Outputs

Output Output Type Notes
Stream File

Exit Codes

Code Type Detail
0 Success Success
1 Error The command failed to execute
2 Error There was an error authenticating with Domo

Import Data via Stream

Import data into a DataSet using a Stream. This should be used for large amounts of data to be loaded to a DataSet or appending data to a DataSet

Inputs

Input Type Detail Notes
DataSet ID TextField The ID of the DataSet
Data FileField The data to import into the DataSet.
Update Method DropdownField The data import behavior. Append will append the data to the DataSet and Replace will replace all of the data in the DataSet.
Chunk Size (MB) NumberField The size of the chunks in megabytes to be loaded. The higher the number the faster the load will complete, but use a lower number for GroundRunners with limited memory resources.

Outputs

Output Output Type Notes
Records Imported Integer

Exit Codes

Code Type Detail
0 Success Success
1 Error The command failed to execute
2 Error There was an error authenticating with Domo

Import data into DataSet

Import data into a DataSet in your Domo instance. This will replace the data currently in the DataSet

Inputs

Input Type Detail Notes
DataSet ID TextField The ID of the DataSet
Data FileField The data to import into the DataSet.

Outputs

None

Exit Codes

Code Type Detail
0 Success Success
1 Error The command failed to execute
2 Error There was an error authenticating with Domo

List DataSets

Get a list of all DataSets in your Domo instance

Inputs

Input Type Detail Notes
Sort By TextField The DataSet field to sort by. Fields prefixed with a negative sign reverses the sort (i.e. '-name' does a reverse sort by the name of the DataSets)

Outputs

Output Output Type Notes
DataSets File
# of DataSets Integer

Exit Codes

Code Type Detail
0 Success Success
1 Error The command failed to execute
2 Error There was an error authenticating with Domo

List Streams

Get a list of all Streams for which the user has view permissions

Inputs

None

Outputs

Output Output Type Notes
Streams File
# of Streams Integer

Exit Codes

Code Type Detail
0 Success Success
1 Error The command failed to execute
2 Error There was an error authenticating with Domo

Query a DataSet

Queries the data in an existing Domo DataSet

Inputs

Input Type Detail Notes
DataSet ID TextField The ID of the DataSet
SQL Query TextField The SQL query to execute against the DataSet

Outputs

Output Output Type Notes
DataSet Query File

Exit Codes

Code Type Detail
0 Success Success
1 Error The command failed to execute
2 Error There was an error authenticating with Domo

Update a DataSet

Updates the specified DataSet’s metadata by providing values to parameters passed

Inputs

Input Type Detail Notes
Dataset ID TextField The ID of the DataSet
DataSet Properties GroupField The properties for the new DataSet.

Outputs

Output Output Type Notes
DataSet File

Exit Codes

Code Type Detail
0 Success Success
1 Error The command failed to execute
2 Error There was an error authenticating with Domo
B
Brian is the author of this solution article.

Did you find it helpful? Yes No

Send feedback
Sorry we couldn't be helpful. Help us improve this article with your feedback.