Domo Component
The Domo platform includes a world class data warehouse, robust data pipeline functionality, and visualization engine.
Component key: domo · Changelog ↓Description
Domo provides a large suite of enterprise-grade tools that help organizations unlock business value from their data. The Domo platform includes a world class data warehouse, robust data pipeline functionality, and an industry-leading visualization engine — all while ensuring data is well-governed and secure.
Connections
Domo OAuth Connection
key: oauthGenerating Client ID and Client Secret
To generate a client ID and client secret for your Domo instance, follow these steps:
-
Obtain your Domo Instance Name:
- Your Domo Instance Name is the part of the URL preceding "domo.com." For instance, if your Domo URL is
acmecompany.domo.com, your instance name would beacmecompany.
- Your Domo Instance Name is the part of the URL preceding "domo.com." For instance, if your Domo URL is
-
Log in to the Developer Portal:
- Click on the "Dev Portal Login" link to access the Developer Portal or follow this link https://developer.domo.com/login.
-
Enter Instance Name and User Credentials:
- Provide your Domo Instance Name and user credentials when prompted to log in.
-
Access "Manage Clients" Page:
- After logging in successfully, you will be redirected to the Developer Portal's homepage.
- Click on the "My Account" dropdown, and you will find options to manage clients, create a new one, or logout.
-
Create a New Client:
- Choose the option to create a new client from the "Manage Clients" page.
-
Submit and Obtain Client ID and Secret:
- After submitting the required information, a newly provisioned client ID and client secret will be generated and displayed on the "Manage Clients" page.
Now you have successfully generated a client ID and client secret for your Domo instance. These credentials will be used in the component's OAuth connection.
| Input | Notes | Example |
|---|---|---|
| Client ID | Client Identifier of your Domo app for the API | |
| Client Secret | Client Secret of your Domo app for the API | |
| Scopes | Space separated OAuth permission scopes for the API | data workflow audit buzz user account dashboard |
Data Sources
Select Account
Select a Domo account. | key: accounts | type: picklist
| Input | Notes | Example |
|---|---|---|
| Connection | The Domo connection to use. | |
| Limit | The number of Accounts to return in the list. The default is 50 and the maximum is 500. | 100 |
| Offset | The offset of Accounts to begin the list of Accounts within the response. | 0 |
Select Account Type
Select a Domo account type. | key: accountTypes | type: picklist
| Input | Notes | Example |
|---|---|---|
| Connection | The Domo connection to use. | |
| Limit | The number of Account Types to return in the list. The default is 50 and the maximum is 500. | 100 |
| Offset | The offset of the Account Types to begin list of Account Types within the response. | 0 |
Select DataSet
Select a Domo DataSet from your instance. | key: selectDataSet | type: picklist
| Input | Notes | Example |
|---|---|---|
| Connection | The Domo connection to use. | |
| Limit | The amount of DataSets to return in the list. The default is 50 and the maximum is 50. | 100 |
| Offset | The offset of the DataSet ID to begin list of DataSets within the response. | 0 |
{
"result": [
{
"label": "Leonhard Euler Birthday Bash",
"key": "1"
}
]
}
Select Group
Select a Domo group. | key: groups | type: picklist
| Input | Notes | Example |
|---|---|---|
| Connection | The Domo connection to use. | |
| Limit | The amount of groups to return in the list. The default is 50 and the maximum is 500. | 100 |
| Offset | The offset of the group ID to begin list of groups within the response. | 0 |
Select Page
Select a Domo page. | key: pages | type: picklist
| Input | Notes | Example |
|---|---|---|
| Connection | The Domo connection to use. | |
| Limit | The amount of pages to return in the list. The default is 50 and the maximum is 500. | 100 |
| Offset | The offset of the page ID to begin list of pages within the response. | 0 |
Select Project
Select a Domo project. | key: projects | type: picklist
| Input | Notes | Example |
|---|---|---|
| Connection | The Domo connection to use. |
Select Project List
Select a Domo project list. | key: projectLists | type: picklist
| Input | Notes | Example |
|---|---|---|
| Connection | The Domo connection to use. | |
| Project ID | The ID of the project. | 123 |
Select Stream
Select a Domo stream. | key: streams | type: picklist
| Input | Notes | Example |
|---|---|---|
| Connection | The Domo connection to use. | |
| Limit | The amount of Stream to return in the list. The default is 50 and the maximum is 500. | 100 |
| Offset | The offset of the Stream ID to begin list of users within the response. | 0 |
Select Stream Execution
Select a Domo stream execution. | key: selectStreamExecution | type: picklist
| Input | Notes | Example |
|---|---|---|
| Connection | The Domo connection to use. | |
| Limit | The number of Stream Executions to return in the list. The default is 50 and the maximum is 500. | 100 |
| Offset | The offset of the Stream Execution to begin list within the response. | 0 |
| Stream ID | The ID of the Stream of data being imported into a DataSet. | 67890 |
Select Task
Select a Domo project task. | key: selectTask | type: picklist
| Input | Notes | Example |
|---|---|---|
| Connection | The Domo connection to use. | |
| Limit | The number of tasks to return in the list. The default is 10 and the maximum is 50. | 100 |
| List ID | The ID of the list. | 456 |
| Offset | The offset of tasks to begin the list within the response. | 0 |
| Project ID | The ID of the project. | 123 |
Select User
Select a Domo user from your instance. | key: selectUser | type: picklist
| Input | Notes | Example |
|---|---|---|
| Connection | The Domo connection to use. | |
| Limit | The amount of users to return in the list. The default is 50 and the maximum is 500. | 100 |
| Offset | The offset of the user ID to begin list of users within the response. | 0 |
{
"result": [
{
"label": "Leonhard Euler",
"key": "27"
}
]
}
Actions
Abort Stream Execution
If needed during an execution, aborts an entire Stream execution. | key: abortStreamExecution
| Input | Notes | Example |
|---|---|---|
| Connection | The Domo connection to use. | |
| Execution ID | The ID of the Stream execution within the Stream, if no Stream execution ID is provided, the current Stream execution will be aborted. | 12345 |
| Stream ID | The ID of the Stream of data being imported into a DataSet. | 67890 |
Add Attachment
Add a multipart form file to a task item as an attachment. | key: addAttachment
| Input | Notes | Example |
|---|---|---|
| Connection | The Domo connection to use. | |
| List ID | The ID of the list. | 456 |
| Project ID | The ID of the project. | 123 |
| Task ID | The ID of the task. | 789 |
Add User To Group
Add user to a group in your Domo instance. | key: addUserToGroup
| Input | Notes | Example |
|---|---|---|
| Connection | The Domo connection to use. | |
| Group ID | The ID of the group. | 871428330 |
| User ID | The ID of the user. | 959463190 |
Commit Stream Execution
Commits stream execution to import combined set of data parts that have been successfully uploaded. | key: commitStreamExecution
| Input | Notes | Example |
|---|---|---|
| Connection | The Domo connection to use. | |
| Execution ID | The ID of the Stream execution within the Stream | 12345 |
| Stream ID | The ID of the Stream of data being imported into a DataSet. | 67890 |
Create Account
When creating an Account, you must specify the Account Type properties. The Account Type properties are different, depending on the type of Account you are trying to create. | key: createAccount
| Input | Notes | Example |
|---|---|---|
| Authenticate By | ||
| Connection | The Domo connection to use. | |
| ID | 123456 | |
| Name | John Doe | |
| Password | ||
| URL | https://example.com | |
| Username | john.doe |
Create Data Set
Creates a new DataSet in your Domo instance. Once the DataSet has been created, data can then be imported into the DataSet. | key: createDataSet
| Input | Notes | Example |
|---|---|---|
| Columns | Array of columns in the DataSet. | |
| Connection | The Domo connection to use. | |
| Description | Description of the DataSet to create. | Sales data for Q1 2024 |
| Name | Name of the DataSet to create | John Doe |
| Rows | Number of rows in the DataSet. | 1000 |
Create Group
Creates a new group in your Domo instance. | key: createGroup
| Input | Notes | Example |
|---|---|---|
| Connection | The Domo connection to use. | |
| Name | The name of the group. | John Doe |
Create List
Creates a new list within the given project id. | key: createList
| Input | Notes | Example |
|---|---|---|
| Connection | The Domo connection to use. | |
| Index | The ordered index of the list within the project. Setting this property will re-order other lists in the project to maintain sequential order. Leaving this property blank will default the index to 1 and shift the index of all other lists. | |
| Name | The name of the list. | John Doe |
| Project ID | The ID of the project. | 123 |
| Type | The type of the list. |
Create Page
Creates a new page in your Domo instance. | key: createPage
| Input | Notes | Example |
|---|---|---|
| Card ID | The ID of the card to add to the page. | ["123", "456"] |
| Connection | The Domo connection to use. | |
| Group ID | The ID of the group that will be given access to view the page. | ["100", "200"] |
| Locked | When true, restricts other users the ability to make edits to page or its content. | |
| Name | The name of the page. | John Doe |
| Parent ID | If provided, the page will be created as a subpage to the page provided | |
| User ID | The ID of the user that will be given access to view the page. | ["959463190", "871428330"] |
Create Project
Create a new project in your Domo instance | key: createProject
| Input | Notes | Example |
|---|---|---|
| Name | Body name | John Doe |
| Connection | The Domo connection to use. | |
| Description | The description of the project. | Sales data for Q1 2024 |
| Due Date | The due date of the project in ISO 8601 format. | 2024-12-31T23:59:59Z |
| Members | Array of user IDs that will be assigned as members of the project. | [27, 105, 93] |
| Member ID | User IDs of members to include in the project. | ["27", "105", "93"] |
| Name | The name of the project. | John Doe |
| Public Body | ||
| Public | When true, the project will be publicly available to other Domo users. | true |
Create Stream
When creating a Stream, specify the DataSet properties (name and description) and as a convenience, the create Stream API will create a DataSet for you. | key: createStream
| Input | Notes | Example |
|---|---|---|
| Columns | ||
| Connection | The Domo connection to use. | |
| DataSet object | The DataSet object associated with this Stream. | ["id", "name", "description"] |
| Description | Sales data for Q1 2024 | |
| Name | John Doe | |
| Update Method | The data import behavior. | |
| Update Method | Update method for body. |
Create Stream Execution
When you’re ready to upload data to your DataSet via a Stream, you first tell Domo that you’re ready to start sending data by creating an Execution. | key: createStreamExecution
| Input | Notes | Example |
|---|---|---|
| Connection | The Domo connection to use. | |
| Stream ID | The ID of the Stream. | 67890 |
Create Task
Add a task to a project list. | key: createTask
| Input | Notes | Example |
|---|---|---|
| Connection | The Domo connection to use. | |
| Contributors | An array of user IDs that are assigned as contributors to the task. | [27, 105] |
| Description | An optional description of the task. | Sales data for Q1 2024 |
| Due Date | The date the task is expected to be completed. | 2024-12-31T23:59:59Z |
| List ID | The ID of the list within a project that the task belongs to. | 456 |
| Owned By | The ID of the Domo user that owns the task. | 959463190 |
| Priority | Priority of task within a list. Setting this property will impact the index of other tasks in the list to maintain sequential order. If not provided the priority will default to 1 and the index of all the other tasks in the list will shift. | 3 |
| Project ID | The ID of the project that the task belongs to. | 123 |
| Tags | An array of tags that have been assigned to the task. | ["urgent", "review"] |
| Task Name | The name of the task. | Complete project review |
| Task Object | The task object to create or update. |
Create User
Creates a new user in your Domo instance. | key: createUser
| Input | Notes | Example |
|---|---|---|
| Alternate Email | User's secondary email in profile. | john.doe.alternate@example.com |
| Connection | The Domo connection to use. | |
User's primary email used in profile. | john.doe@example.com | |
| Employee Number | Employee number within company. | 23432 |
| Locale | Locale used to display to user the system settings throughout Domo application. | en_US |
| Location | Free text that can be used to define office location. | American Fork |
| Name | John Doe | |
| Phone | Primary phone number of user. | 888-361-1078 |
| Role | The role of the user. | Admin |
| Send Invite | When true, sends an email invite to created user. | true |
| Timezone | Time zone used to display to user the system times throughout Domo application. | America/Denver |
| Title | User's job title. | Software Engineer |
| User Body | The user object to create. |
Delete Account
Deletes an Account from your Domo instance. | key: deleteAccount
| Input | Notes | Example |
|---|---|---|
| Account ID | The ID of the account. | 12345 |
| Connection | The Domo connection to use. |
Delete Attachment
Permanently deletes an attachment from your task. | key: deleteAttachment
| Input | Notes | Example |
|---|---|---|
| Attachment ID | The ID of the attachment. | 67890 |
| Connection | The Domo connection to use. | |
| Project ID | The ID of the project that the attachment belongs to. | 123 |
| Task ID | The ID of the task that the attachment belongs to. | 789 |
Delete Data Set
Permanently deletes a DataSet from your Domo instance. This can be done for all DataSets, not just those created through the API. | key: deleteDataSet
| Input | Notes | Example |
|---|---|---|
| Connection | The Domo connection to use. | |
| DataSet ID | The ID of the DataSet. | 5168da8d-1c72-4e31-ba74-f609f73071dd |
Delete Group
Permanently deletes a group from your Domo instance. | key: deleteGroup
| Input | Notes | Example |
|---|---|---|
| Connection | The Domo connection to use. | |
| Group ID | The ID of the group to delete. | 871428330 |
Delete List
Permanently deletes a list from your Domo instance. | key: deleteList
| Input | Notes | Example |
|---|---|---|
| Connection | The Domo connection to use. | |
| List ID | The ID of the list. | 456 |
| Project ID | The ID of the project. | 123 |
Delete Page
Permanently deletes a page from your Domo instance. | key: deletePage
| Input | Notes | Example |
|---|---|---|
| Connection | The Domo connection to use. | |
| Page ID | The ID of the page. | 123456 |
Delete Project
Permanently deletes a project from your Domo instance. | key: deleteProject
| Input | Notes | Example |
|---|---|---|
| Connection | The Domo connection to use. | |
| Project ID | The ID of the project. | 123 |
Delete Stream
Deletes a Stream from your Domo instance. This does not a delete the associated DataSet. | key: deleteStream
| Input | Notes | Example |
|---|---|---|
| Connection | The Domo connection to use. | |
| Stream ID | The ID of the Stream to delete. | 67890 |
Delete User
Permanently deletes a user from your Domo instance. | key: deleteUser
| Input | Notes | Example |
|---|---|---|
| Connection | The Domo connection to use. | |
| User ID | The ID of the user. | 959463190 |
Download Attachment
Downloads an individual attachment given an attachment id. | key: downloadAttachment
| Input | Notes | Example |
|---|---|---|
| Attachment ID | The ID of the attachment. | 67890 |
| Connection | The Domo connection to use. | |
| List ID | The ID of the list. | 456 |
| Project ID | The ID of the project. | 123 |
| Task ID | The ID of the task. | 789 |
Export Data From DataSet
Export data from a DataSet in your Domo instance. | key: exportDataFromDataSet
| Input | Notes | Example |
|---|---|---|
| Connection | The Domo connection to use. | |
| File Name | The filename of the exported CSV. | export_data.csv |
| Include Header | When true, includes table header in export. |
Get Accounts
Retrieve the details of an account type. This includes information on the properties required to create an Account of this type. | key: getAccounts
| Input | Notes | Example |
|---|---|---|
| Account Type ID | The ID of the account type. | 12345 |
| Connection | The Domo connection to use. |
Get Activity Log Entries
Retrieves activity log entries | key: getActivityLogEntries
| Input | Notes | Example |
|---|---|---|
| Connection | The Domo connection to use. | |
| End | The end time in milliseconds of when you want to receive log events. | 1640995200000 |
| Limit | The maximum number of events to retrieve (default is 50, maximum of 1000). | 100 |
| Offset | The offset location of events to retrieve (default is 0). | 0 |
| Start | The start time in milliseconds of when you want to receive log events. | 1609459200000 |
| User | The ID of the user. | 959463190 |
Get Data Set
Retrieves the details of an existing DataSet. | key: getDataSet
| Input | Notes | Example |
|---|---|---|
| Connection | The Domo connection to use. | |
| DataSet ID | The ID of the DataSet. | 5168da8d-1c72-4e31-ba74-f609f73071dd |
Get Group
Retrieves the details of an existing group. | key: getGroup
| Input | Notes | Example |
|---|---|---|
| Connection | The Domo connection to use. | |
| Group ID | The ID of the group. | 871428330 |
Get List
Retrieves the details of an individual list given a project id and a list id. | key: getList
| Input | Notes | Example |
|---|---|---|
| Connection | The Domo connection to use. | |
| List ID | The ID of the list. | 456 |
| Project ID | The ID of the project. | 123 |
Get List Of Attachments
Retrieve details about all of the attachments belonging to a particular task. | key: getListOfAttachments
| Input | Notes | Example |
|---|---|---|
| Connection | The Domo connection to use. | |
| List ID | The ID of the list. | 456 |
| Project ID | The ID of the project. | 123 |
| Task ID | The ID of the task. | 789 |
Get Page
Retrieves the details of an existing page. | key: getPage
| Input | Notes | Example |
|---|---|---|
| Connection | The Domo connection to use. | |
| Page ID | The ID of the page. | 123456 |
Get Project
Retrieves the details of an individual existing project given a project id. Use the special project ID me to return your personal project. | key: getProject
| Input | Notes | Example |
|---|---|---|
| Connection | The Domo connection to use. | |
| Project ID | The ID of the project. | 123 |
Get Project Members
Retrieves a list of ids of the users that are members of the given project id. | key: getProjectMembers
| Input | Notes | Example |
|---|---|---|
| Connection | The Domo connection to use. | |
| Project ID | The ID of the project. | 123 |
Get Stream
Retrieves the details of an existing stream. | key: getStream
| Input | Notes | Example |
|---|---|---|
| Connection | The Domo connection to use. | |
| Fields | Return desired fields: all, id, dataset, updateMethod, createdAt, or modifiedAt. | all |
| Stream ID | The id of the stream. | 67890 |
Get Stream Execution
Import data into a DataSet in your Domo instance. This request will replace the data currently in the DataSet. | key: getStreamExecution
| Input | Notes | Example |
|---|---|---|
| Connection | The Domo connection to use. | |
| Execution ID | The ID of the Stream execution within the Stream. | 12345 |
| Stream ID | The ID of the Stream of data being imported into a DataSet. | 67890 |
Get Task
Retrieves an individual task from a given project id and list id. | key: getTask
| Input | Notes | Example |
|---|---|---|
| Connection | The Domo connection to use. | |
| List ID | The ID of the list. | 456 |
| Project ID | The ID of the project. | 123 |
| Task ID | The ID of the task. | 789 |
Get User
Retrieves the details of an existing user. | key: getUser
| Input | Notes | Example |
|---|---|---|
| Connection | The Domo connection to use. | |
| User ID | The ID of the user. | 959463190 |
Import Data Into DataSet
Import data into a DataSet in your Domo instance. This request will replace the data currently in the DataSet. | key: importDataIntoDataSet
| Input | Notes | Example |
|---|---|---|
| Connection | The Domo connection to use. | |
| CSV Body | The CSV data to import. | Name,Email John Doe,john@example.com Jane Smith,jane@example.com |
| DataSet ID | The ID of the DataSet. | 5168da8d-1c72-4e31-ba74-f609f73071dd |
List Accounts
Get a list of all Accounts for which the user has permissions. | key: listAccounts
| Input | Notes | Example |
|---|---|---|
| Connection | The Domo connection to use. | |
| Limit | The number of Accounts to return in the list. The default is 50 and the maximum is 500. | 100 |
| Offset | The offset of Accounts to begin the list of Accounts within the response. | 0 |
List DataSets
Get a list of all DataSets in your Domo instance. | key: listDataSets
| Input | Notes | Example |
|---|---|---|
| Connection | The Domo connection to use. | |
| Limit | The amount of DataSets to return in the list. The default is 50 and the maximum is 50. | 100 |
| Name Like | If included, will limit the list of DataSets to those with names that contain the string passed in. nameLike is case insensitive. | sales |
| Offset | The offset of the DataSet ID to begin list of users within the response. | 0 |
| Sort | The DataSet field to sort by. Fields prefixed with a negative sign reverses the sort (e.g., '-name' does a reverse sort by the name of the DataSets). | name |
List Groups
Get a list of all groups in your Domo instance. | key: listGroups
| Input | Notes | Example |
|---|---|---|
| Connection | The Domo connection to use. | |
| Limit | The amount of groups to return in the list. The default is 50 and the maximum is 500. | 100 |
| Offset | The offset of the group ID to begin list of groups within the response. | 0 |
List Pages
Get a list of all pages in your Domo instance. | key: listPages
| Input | Notes | Example |
|---|---|---|
| Connection | The Domo connection to use. | |
| Limit | The amount of pages to return in the list. The default is 50 and the maximum is 500. | 100 |
| Offset | The offset of the page ID to begin list of pages within the response. | 0 |
List Project List Tasks
Retrieves all tasks from a given project id and list id. | key: listProjectListTasks
| Input | Notes | Example |
|---|---|---|
| Connection | The Domo connection to use. | |
| Limit | The number of records to offset from the beginning of the result list (defaults to 0) | 100 |
| List ID | The ID of the list. | 456 |
| Offset | The maximum amount of results to return (defaults to 10 with a maximum of 50) | 0 |
| Project ID | The ID of the project. | 123 |
List Project Lists
Retrieves all lists available within a given project id. | key: listProjectLists
| Input | Notes | Example |
|---|---|---|
| Connection | The Domo connection to use. | |
| Project ID | The ID of the project. | 123 |
List Projects
Retrieves a list of all projects that the client scope has access to. | key: listProjects
| Input | Notes | Example |
|---|---|---|
| Connection | The Domo connection to use. |
List Stream Execution
Returns all Stream Execution objects that meet argument criteria from original request. | key: listStreamExecution
| Input | Notes | Example |
|---|---|---|
| Connection | The Domo connection to use. | |
| Limit | The amount of Stream to return in the list. The default is 50 and the maximum is 500. | 100 |
| Offset | The offset of the Stream ID to begin list of users within the response. | 0 |
| Stream ID | The ID of the Stream | 67890 |
List Streams
Get a list of all Streams for which the user has view permissions. | key: listStreams
| Input | Notes | Example |
|---|---|---|
| Connection | The Domo connection to use. | |
| Limit | The amount of Stream to return in the list. The default is 50 and the maximum is 500. | 100 |
| Offset | The offset of the Stream ID to begin list of users within the response. | 0 |
List Users
Get a list of all users in your Domo instance. | key: listUsers
| Input | Notes | Example |
|---|---|---|
| Connection | The Domo connection to use. | |
| Limit | The amount of users to return in the list. The default is 50 and the maximum is 500. | 100 |
| Offset | The offset of the user ID to begin list of users within the response. | 0 |
List Users In Group
List the users in a group in your Domo instance. | key: listUsersInGroup
| Input | Notes | Example |
|---|---|---|
| Connection | The Domo connection to use. | |
| Group ID | The ID of the group. | 871428330 |
| Limit | The amount of groups to return in the list. The default is 50 and the maximum is 500. | 100 |
| Offset | The offset of the group ID to begin list of groups within the response. | 0 |
Query Data Set
Queries the data in an existing Domo DataSet | key: queryDataSet
| Input | Notes | Example |
|---|---|---|
| Connection | The Domo connection to use. | |
| DataSet ID | The ID of the DataSet. | 5168da8d-1c72-4e31-ba74-f609f73071dd |
| SQL | The SQL query to execute. | SELECT * FROM dataset WHERE status = 'active' |
Raw Request
Send raw HTTP request to Domo. | key: rawRequest
| Input | Notes | Example |
|---|---|---|
| Connection | The Domo connection to use. | |
| Data | The HTTP body payload to send to the URL. | {"exampleKey": "Example Data"} |
| Debug Request | Enabling this flag will log out the current request. | false |
| File Data | File Data to be sent as a multipart form upload. | [{key: "example.txt", value: "My File Contents"}] |
| File Data File Names | File names to apply to the file data inputs. Keys must match the file data keys above. | |
| Form Data | The Form Data to be sent as a multipart form upload. | [{"key": "Example Key", "value": new Buffer("Hello World")}] |
| Header | A list of headers to send with the request. | User-Agent: curl/7.64.1 |
| Max Retry Count | The maximum number of retries to attempt. Specify 0 for no retries. | 0 |
| Method | The HTTP method to use. | |
| Query Parameter | A list of query parameters to send with the request. This is the portion at the end of the URL similar to ?key1=value1&key2=value2. | |
| Response Type | The type of data you expect in the response. You can request json, text, or binary data. | json |
| Retry On All Errors | If true, retries on all erroneous responses regardless of type. This is helpful when retrying after HTTP 429 or other 3xx or 4xx errors. Otherwise, only retries on HTTP 5xx and network errors. | false |
| Retry Delay (ms) | The delay in milliseconds between retries. This is used when 'Use Exponential Backoff' is disabled. | 0 |
| Timeout | The maximum time that a client will await a response to its request | 2000 |
| URL | This is the URL to call. | /datasets |
| Use Exponential Backoff | Specifies whether to use a pre-defined exponential backoff strategy for retries. When enabled, 'Retry Delay (ms)' is ignored. | false |
Remove User From Group
Remove a user from a group in your Domo instance. | key: removeUserFromGroup
| Input | Notes | Example |
|---|---|---|
| Connection | The Domo connection to use. | |
| Group ID | The ID of the group. | 871428330 |
| User ID | The ID of the user. | 959463190 |
Search Stream
Returns all Stream objects that meet argument criteria from original request. | key: searchStream
| Input | Notes | Example |
|---|---|---|
| Connection | The Domo connection to use. | |
| Fields | Return desired fields: all, id, dataset, updateMethod, createdAt, or modifiedAt. | all |
| Qualifiers | The search qualifiers to search by available qualifiers: dataSource.id or dataSource.owner.id. | dataSource.id:123 |
Share Account
Share an Account with a User. | key: shareAccount
| Input | Notes | Example |
|---|---|---|
| Account ID | The ID of the Account. | 12345 |
| Connection | The Domo connection to use. | |
| User | The User to share the Account with. | ["959463190", "871428330"] |
Update Account
Updates the specified Account’s metadata as well as the Account’s Type properties. | key: updateAccount
| Input | Notes | Example |
|---|---|---|
| Account ID | The ID of the account to update. | 12345 |
| Connection | The Domo connection to use. | |
| Update Account Body | The account object to update. |
Update Data Set
Updates the specified DataSet’s metadata by providing values to parameters passed. | key: updateDataSet
| Input | Notes | Example |
|---|---|---|
| Connection | The Domo connection to use. | |
| DataSet ID | The ID of the DataSet. | 5168da8d-1c72-4e31-ba74-f609f73071dd |
| Update DataSet Body | The DataSet object to update. |
Update Group
Updates the specified group by providing values to parameters passed. Any parameter left out of the request will cause the specific group’s attribute to remain unchanged. | key: updateGroup
| Input | Notes | Example |
|---|---|---|
| Connection | The Domo connection to use. | |
| Group ID | The ID of the group. | 871428330 |
| Update Group Body | The group object to update. |
Update List
Update the details of a list given an existing project id and list id. | key: updateList
| Input | Notes | Example |
|---|---|---|
| Connection | The Domo connection to use. | |
| Index | The updated index of the list within the project. Updating the index of a list may also change the order of the other lists in the project to remain sequential. | |
| List ID | The ID of the list. | 456 |
| Name | The updated name of the list. | John Doe |
| Project ID | The ID of the project. | 123 |
| Type | The type of the list. | |
| Update List Body | The list object to update. |
Update Page
Updates the specified page by providing values to parameters passed. Any parameter left out of the request will cause the specific page’s attribute to remain unchanged. | key: updatePage
| Input | Notes | Example |
|---|---|---|
| Connection | The Domo connection to use. | |
| Page ID | The ID of the page. | 123456 |
| Update Page Body | The page object to update. |
Update Project
Updates attributes of an existing project in your Domo instance. The following properties are read-only and cannot be updated with this request:id members createdBy createdDate | key: updateProject
| Input | Notes | Example |
|---|---|---|
| Connection | The Domo connection to use. | |
| Description | Updates the description of the project. | Sales data for Q1 2024 |
| Due Date | Updates the due date of the project. | 2024-12-31T23:59:59Z |
| Name | Updates the name of the project. | John Doe |
| Project ID | The ID of the project. | 123 |
| Public | Updates whether or not the project is publicly available to Domo users. | |
| Update Project Body | The project object to update. |
Update Project Members
Update the members of a given project id. | key: updateProjectMembers
| Input | Notes | Example |
|---|---|---|
| Connection | The Domo connection to use. | |
| Project ID | The ID of the project. | 123 |
| Update Project Members Body | Array of user IDs to assign as members of the project. |
Update Stream
Updates the specified Stream’s metadata by providing values to parameters passed. | key: updateStream
| Input | Notes | Example |
|---|---|---|
| Connection | The Domo connection to use. | |
| Stream ID | The ID of the stream to update. | 67890 |
| Update Method Body | The update method configuration. | |
| Update Method | The data import behavior. | REPLACE |
Update Task
Update the details of a task given an existing project id, list id, and task id. | key: updateTask
| Input | Notes | Example |
|---|---|---|
| Connection | The Domo connection to use. | |
| Contributors | An array of user IDs that are assigned as contributors to the task. | [27, 105] |
| Description | Description of the DataSet to create. | Sales data for Q1 2024 |
| Due Date | The due date of the project in ISO 8601 format. | 2024-12-31T23:59:59Z |
| List ID | The ID of the list. | 456 |
| Owned By | The ID of the Domo user that owns the task. | 959463190 |
| Priority | Priority of task within a list. Setting this property will impact the index of other tasks in the list to maintain sequential order. If not provided the priority will default to 1 and the index of all the other tasks in the list will shift. | 3 |
| Project ID | The ID of the project. | 123 |
| Tags | An array of tags that have been assigned to the task. | ["urgent", "review"] |
| Task ID | The ID of the task. | 789 |
| Task Name | The name of the task. | Complete project review |
| Update Task Body | The task object to update. |
Update User
Updates the specified user by providing values to parameters passed. Any parameter left out of the request will cause the specific user’s attribute to remain unchanged. | key: updateUser
| Input | Notes | Example |
|---|---|---|
| Alternate Email | User's secondary email in profile. | john.doe.alternate@example.com |
| Connection | The Domo connection to use. | |
User's primary email used in profile. | john.doe@example.com | |
| Employee Number | Employee number within company. | 23432 |
| Locale | Locale used to display to user the system settings throughout Domo application. | en_US |
| Location | Free text that can be used to define office location. | American Fork |
| Name | User's full name | John Doe |
| Phone | Primary phone number of user. | 888-361-1078 |
| Role | The system role of the user | Admin |
| Roled | The ID of the custom or system role of the user. | 123 |
| Timezone | Time zone used to display to user the system times throughout Domo application. | America/Denver |
| Title | User's job title. | Software Engineer |
| Update User Body | The user object to update. | |
| User ID | The ID of the user. | 959463190 |
Upload Data Part
Creates a data part within the Stream execution to upload chunks of rows to the DataSet. The calling client should keep track of parts and order them accordingly in an increasing sequence. If a part upload fails, retry the upload as all parts must be present before committing the stream execution. | key: uploadDataPart
| Input | Notes | Example |
|---|---|---|
| Connection | The Domo connection to use. | |
| Execution ID | The ID of the Stream execution within the Stream. | 12345 |
| Part ID | The ID of the data part being used to upload a subset of data within the Stream execution. | 1 |
| Stream ID | The ID of the Stream of data being imported into a DataSet. | 67890 |
Changelog
2026-03-31
Various modernizations and documentation updates
2026-03-05
Added inline data sources for stream executions, tasks, users, DataSets, accounts, account types, groups, pages, projects, project lists, and streams to enhance data selection capabilities