To connect to the data visualization and analytics capabilities of Domo® as part of a chain, add a step that includes a Domo connection command.
To enable these commands, an IT admin first creates a Domo connector.
Create a dataset
To create a new dataset in your Domo instance, use a Create a dataset command. After you create the dataset, you can import data into it.
Properties
| Property |
Detail |
| Dataset properties |
Enter the properties for the new dataset. |
Outputs
| Output |
Output type |
| 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
To permanently delete a dataset from your Domo instance, use a Delete a dataset command. You can delete any dataset, not just those created through the API.
Properties
| Property |
Detail |
| Dataset ID |
Enter the ID of the dataset to delete. |
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
To export the data from a dataset in Domo as a comma-separated values (CSV) file, use an Export data from dataset command.
Properties
| Property |
Detail |
| Dataset ID |
Enter the ID of the dataset to export from. |
| Include header |
To include the table header, check this box. |
Outputs
| Output |
Output type |
| 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
To retrieve details about a dataset in Domo, use a Get dataset command.
Properties
| Property |
Detail |
| Dataset ID |
Enter the ID of the dataset to get details about. |
Outputs
| Output |
Output type |
| 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
To retrieve details about a stream given its ID or its dataset's ID, use a Get a stream command.
Properties
| Property |
Detail |
| Dataset ID |
Enter the ID of the dataset associated with the stream to get details about. |
| Stream ID |
Enter the ID of the stream to get details about. |
Outputs
| Output |
Output type |
| 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
To load or append a large amount of data into a dataset in Domo using a stream, use an Import data via stream command.
Properties
| Property |
Detail |
| Dataset ID |
Enter the ID of the dataset to import into. |
| Data |
Enter the data to import into the dataset. |
| Update method |
Select whether to append the imported data to the dataset or replace all data in the dataset with the import. |
| Chunk size (MB) |
Enter the size of the chunks to load, in megabytes (MB).
Note The higher the chunk size, the faster the import completes. However, use a lower chunk size with GroundRunners with limited memory resources.
|
Outputs
| Output |
Output type |
| 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
To replace all data in a dataset in Domo, use an Import data into dataset command.
Properties
| Property |
Detail |
| Dataset ID |
Enter the ID of the dataset to import into. |
| Data |
Enter 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
To retrieve a list of all datasets in Domo, use a List datasets command.
Properties
| Property |
Detail |
| Sort by |
Enter the dataset field to sort by.
To reverse the sort, prefix the field with a negative sign (-). For example, to reverse sort by the datasets' names, enter -name.
|
Outputs
| Output |
Output type |
| Datasets |
File |
| Number 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
To retrieve a list of all streams the user has permission to view, use a List streams command.
Properties
None
Outputs
| Output |
Output type |
| Streams |
File |
| Number 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
To query the data in a dataset in Domo, use a Query a dataset command.
Properties
| Property |
Detail |
| Dataset ID |
Enter the ID of the dataset to query. |
| SQL query |
Enter the SQL query to execute against the dataset. |
Outputs
| Output |
Output type |
| 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
To update a dataset's metadata given its parameters' values, use an Update a dataset command.
Properties
| Property |
Detail |
| Dataset ID |
Enter the ID of the dataset to update. |
| Dataset properties |
Enter the new properties for the dataset. |
Outputs
| Output |
Output type |
| 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 |