Domo
App Vendor: Domo
App Category: Analytics & SIEM
Connector Version: 1.0.0
API Version: v1.0
About App
Domo provides a large suite of enterprise-grade tools that help organizations unlock business value from their data.
The Domo app is configured with Orchestrate to perform the following actions:
Action Name | Description |
|---|---|
Abort Stream Execution | This action aborts a stream execution. |
Commit Stream Execution | This action commits stream execution to import a combined set of data parts that have been successfully uploaded. |
Create Datasets | This action creates a dataset in Domo. |
Create Stream | This action creates a stream in Domo. |
Create Stream Execution | This action sends a request for a dataset to be uploaded by creating an execution. |
Export Data | This action exports the data from a dataset in your Domo instance. |
Generic Action | This is a generic action to perform any additional use case you want on Domo. |
Get Datasets Details | This action retrieves details of an existing dataset. |
Get Stream Details | This action retrieves the details of an existing stream. |
Get Stream Execution | This action gets details of a stream execution. |
Import Data | This action imports data into a dataset in your Domo instance. |
List Datasets | This action gets a list of all datasets in your Domo instance. |
List Stream Executions | This action gets all stream execution objects that meet the filter criteria from the original request. |
List Streams | This action gets a list of all streams for which the user has view permissions. |
Query Dataset | This action performs a search using SQL query on a dataset. |
Search Streams | This action retrieves all stream objects that meet the filter criteria from the original request. |
Upload Data Part in a Stream | This action creates a data part within the stream execution to upload chunks of rows to the dataset. |
Configuration Parameters
The following configuration parameters are required for the Domo app to communicate with the Domo enterprise application. The parameters can be configured by creating instances in the app.
Parameter | Description | Field Type | Required/Optional | Comments |
|---|---|---|---|---|
Client ID | Enter the client ID of the application that will be used to connect to Domo. Example: 09cd25c9-29b3-99ff-b49z-41235465b427 | Text | Required | |
Client Secret | Enter the client secret of the application that will be used to connect to Domo. Example: 12345~123245123245abc~abc1234512345abc | Password | Required | |
Scope | Enter the scope of the instance. Example: data user (This means that you can specify two types of access needed for your application) | Text | Required | To provide an additional layer of security, you must select one of the supported scopes. Allowed values:
|
Verify | Choose your preference to verify SSL while making requests. It is recommended to set this option to yes. If no is passed, it may result in an incorrect establishment of the connection, potentially causing it to become broken. | Boolean | Optional | Default value: true |
Action: Abort Stream Execution
This action aborts a stream execution.
Action Input Parameters
Parameter | Description | Field Type | Required/Optional | Comments |
|---|---|---|---|---|
Stream ID | Enter the ID of the stream. Example: 1 | Integer | Required | You can retrieve this ID using the action List Steams. |
Execution ID | Enter the execution ID. Example: 1 | Integer | Required | You can retrieve this ID using the action List Stream Executions. |
Example Request
[
{
"stream_id": "1",
"execution_id": "1"
}
]Action: Commit Stream Execution
This action commits stream execution to import a combined set of data parts that have been successfully uploaded.
Action Input Parameters
Parameter | Description | Field Type | Required/Optional | Comments |
|---|---|---|---|---|
Stream ID | Enter the ID of the stream to commit. Example: 18 | Integer | Required | You can retrieve this ID using the action List Steams. |
Execution ID | Enter the execution ID to perform the commit. Example: 1 | Integer | Required | You can retrieve this ID using the action List Stream Executions. |
Example Request
[
{
"stream_id": "18",
"execution_id": "1"
}
]Action: Create Datasets
This action creates a dataset in Domo.
Action Input Parameters
Parameter | Description | Field Type | Required/Optional | Comments |
|---|---|---|---|---|
Dataset name | Enter the name of the dataset to be created. Example: "incident" | Text | Required | |
Description | Enter the description for the dataset. Example: "This is for incidents" | Text | Required | |
Columns | Enter the column type and name. Example: $JSON[[{'type':'string', 'name':'md5'},{'type':'string', 'name':'sha256'}]] | Any | Required | |
Rows | Enter the number of rows to be inserted. Example: 2 | Integer | Optional | Default value:0 |
Example Request
[
{
"rows": "2",
"columns": [
{
"type": "String",
"name": "MD5"
},
{
"type": "String",
"name": "sha256"
}
],
"description": "This is for incidents",
"dataset_name": "incidents"
}
]Action: Create Stream
This action is used to create a stream.
Action Input Parameters
Parameter | Description | Field Type | Required/Optional | Comments |
|---|---|---|---|---|
Dataset name | Enter the name of the dataset to be created. Example: "Intel" | Text | Required | |
Description | Enter the description for the dataset. Example: "This is for incidents" | Text | Required | |
Columns | Enter the column type and name. Example: $JSON[[{'type':'string', 'name':'md5'},{'type':'string', 'name':'sha256'}]] | Any | Required | |
Update method | Choose the data import behavior. Example: append | Text | Required | Allowed values:
|
Example Request
[
{
"columns": [
{
"type": "STRING",
"name": "md5"
}
],
"description": "This is for incidents",
"dataset_name": "Intel",
"update_method": "APPEND"
}
]Action: Create Stream Execution
This action sends a request for a dataset to be uploaded by creating an execution. Note that creating an execution on a stream will abort all other executions on that stream. Each stream can only have one active execution at a time.
Action Input Parameters
Parameter | Description | Field Type | Required/Optional | Comments |
|---|---|---|---|---|
Stream ID | Enter the ID of the stream. Example: 1 | Integer | Required | You can retrieve this ID using the action List Steams. |
Example Request
[
{
"stream_id": "18"
}
]Action: Export Data
This action exports the data from a dataset in your Domo instance.
Action Input Parameters
Parameter | Description | Field Type | Required/Optional | Comments |
|---|---|---|---|---|
Dataset ID | Enter the dataset ID to retrieve details. Example: "08a061e2-12a2-4646-b4bc-20beddb403e3" | Text | Required | You can retrieve this ID using the action List Datasets. |
Filename | Enter the filename of the exported CSV. Example: "maths-party.csv" | Text | Optional | |
Include header | Choose true to include the table header. | Boolean | Optional | Allowed values:
|
Example Request
[
{
"dataset_id": " 9a8a7bac-1463-45a4-ac7e-1a2b2d928650",
"include_header": false
}
]Action: Generic Action
This is a generic action to perform any additional use case that you want on Domo.
Action Input Parameters
Parameter | Description | Field Type | Required/Optional | Comments |
|---|---|---|---|---|
HTTP Method | Enter the HTTP method. Example: GET | Text | Required | Allowed values:
|
Endpoint | Enter the endpoint. Example: datasets | Text | Required | |
Query params | Enter the query params. | Key Value | Optional | |
Payload | Enter the payload data. | Key Value | Optional |
Example Request
[
{
"method": "GET",
"endpoint": "datasets"
}
]Action: Get Datasets Details
This action retrieves details of an existing dataset.
Action Input Parameters
Parameter | Description | Field Type | Required/Optional | Comments |
|---|---|---|---|---|
Dataset ID | Enter the dataset ID to retrieve the details. Example: 08a061e2-12a2-4646-b4bc-20beddb403e3 | Text | Required |
Example Request
[
{
"dataset_id": "ef545d2b-b02e-485c-9794-f40a9a35f3a8"
}
]Action: Get Stream Details
This action retrieves the details of an existing stream.
Action Input Parameters
Parameter | Description | Field Type | Required/Optional | Comments |
|---|---|---|---|---|
Stream ID | Enter the ID of the stream to get the details. Example: 1 | Integer | Required | You can retrieve this ID using the action List Steams. |
Fields | Enter the fields to get the details. | Text | Optional | Allowed values: all or {id, dataset, updatemethod, createdat or modifiedat} |
Example Request
[
{
"fields": "All",
"stream_id": "1"
}
]Action: Get Stream Execution
This action gets details of a stream execution.
Action Input Parameters
Parameter | Description | Field Type | Required/Optional | Comments |
|---|---|---|---|---|
Stream ID | Enter the ID of the stream to get the stream execution. Example: 1 | Integer | Required | You can retrieve this ID using the action List Steams. |
Execution ID | Enter the execution ID. Example: 1 | Integer | Required | You can retrieve this ID using the action List Stream Executions. |
Example Request
[
{
"stream_id": "1",
"execution_id": "1"
}
]Action: Import Data
This action imports data into a dataset in your Domo instance. This request will replace the data currently in the dataset.
Action Input Parameters
Parameter | Description | Field Type | Required/Optional | Comments |
|---|---|---|---|---|
Dataset ID | Enter the dataset ID to retrieve details. Example: 08a061e2-12a2-4646-b4bc-20beddb403e3 | Text | Required | |
Data | Enter the data to populate into a dataset. Example: Sample data | Text | Required |
Example Request
[
{
"data": "Sample data",
"dataset_id": "9a8a7bac-1463-45a4-ac7e-1a2b2d928650"
}
]Action: List Datasets
This action gets a list of all datasets in your Domo instance.
Action Input Parameters
Parameter | Description | Field Type | Required/Optional | Comments |
|---|---|---|---|---|
Offset | Enter the offset of the dataset ID to begin listing users within the response. Example: 1 | Integer | Optional | Default value: 0 |
Limit | Enter the number of datasets to return. The API maximum is 50. | Integer | Optional | Default value:50 |
Filter | Enter the namelike keyword matching the name of dataset to filter. Namelike is case insensitive. Example: incident | Text | Optional | |
Sort | Enter the dataset field to sort by. Fields prefixed with a negative sign reverse the sort. Example: -name | Text | Optional |
Example Request
[
{
"offset": 1,
"filter": "incident"
}
]Action: List Stream Executions
This action gets all stream execution objects that meet the filter criteria from the original request.
Action Input Parameters
Parameter | Description | Field Type | Required/Optional | Comments |
|---|---|---|---|---|
Stream ID | Enter the ID of the stream to list executions. Example: 1 | Integer | Required | You can retrieve this ID using the action List Steams. |
Offset | Enter the offset of the stream ID to begin listing users within the response. | Integer | Optional | Default value: 0 |
Limit | Enter the number of streams to return in the list. | Integer | Optional | Default value: 50 Maximum supported value: 500. |
Example Request
[
{
"stream_id": "1"
}
]Action: List Streams
This action gets a list of all streams for which the user has view permissions.
Action Input Parameters
Parameter | Description | Field Type | Required/Optional | Comments |
|---|---|---|---|---|
Offset | Enter the offset of the stream ID to list users within the response. Example: 0 | Integer | Optional | Default value: 0 |
Limit | Enter the number of streams to return in the list. | Integer | Optional | Default value: 50 Maximum supported value: 500 |
Example Request
[
{
"offset": 0
}
]Action: Query Dataset
This action performs a search using SQL query on the dataset.
Action Input Parameters
Parameter | Description | Field Type | Required/Optional | Comments |
|---|---|---|---|---|
Query | Enter the SQL query which you want to perform on the dataset. Example: select * from table | Text | Required | |
Dataset ID | Enter the dataset ID to retrieve details. Example: 08a061e2-12a2-4646-b4bc-20beddb403e3 | Text | Required |
Example Request
[
{
"query": "SELECT * FROM TABLE CO-to-domo",
"dataset_id": "9a8a7bac-1463-45a4-ac7e-1a2b2d928650"
}
]Action: Search Streams
This action retrieves all stream objects that meet the filter criteria.
Action Input Parameters
Parameter | Description | Field Type | Required/Optional | Comments |
|---|---|---|---|---|
Qualifiers ID | Enter the search qualifiers to search by. Example: 1 | Integer | Required | Available values:
|
Fields | Enter the fields to search. Example: all | Text | Optional | Allowed values: all or {id, dataset, updatemethod, createdat or modifiedat} |
Example Request
[
{
"qualifiers_id": "4"
}
]Action: Upload Data Part in a Stream
This action creates a data part within the stream execution to upload chunks of rows to the dataset.
Action Input Parameters
Parameter | Description | Field Type | Required/Optional | Comments |
|---|---|---|---|---|
Stream ID | Enter the ID of the stream to upload data parts. Example: 1 | Integer | Required | You can retrieve this ID using the action Get Stream Details. |
Execution ID | Enter the ID of the stream execution. Example: 1 | Integer | Required | You can retrieve this ID using the action List Stream Executions. |
Part ID | Enter the ID of the data part being used to upload a subset of data within the stream execution. Example: 2 | Integer | Required |
Example Request
[
{
"part_id": "2",
"stream_id": "2",
"execution_id": "1"
}
]