Domo Component
The Domo platform includes a world class data warehouse, robust data pipeline functionality, and visualization engine.
Component key: domoDescription
Domo provides a large suite of enterprise-grade tools thaat 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
Generating 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 be "acmecompany."
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.
Data Sources
Select Account
Select a Domo account. | key: accounts | type: picklist
Select Account Type
Select a Domo account type. | key: accountTypes | type: picklist
Select Group
Select a Domo group. | key: groups | type: picklist
Select Page
Select a Domo page. | key: pages | type: picklist
Select Project
Select a Domo project. | key: projects | type: picklist
Select Project List
Select a Domo project list. | key: projectLists | type: picklist
Select Stream
Select a Domo stream. | key: streams | type: picklist
Actions
Abort Stream Execution
If needed during an execution, aborts an entire Stream execution. | key: abortStreamExecution
Add Attachment
Add a multipart form file to a task item as an attachment. | key: addAttachment
Add User To Group
Add user to a group in your Domo instance. | key: addUserToGroup
Commit Stream Execution
Commits stream execution to import combined set of data parts that have been successfully uploaded. | key: commitStreamExecution
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
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
Create Group
Creates a new group in your Domo instance. | key: createGroup
Create List
Creates a new list within the given project id. | key: createList
Create Page
Creates a new page in your Domo instance. | key: createPage
Create Project
Create a new project in your Domo instance | key: createProject
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
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
Create Task
Add a task to a project list. | key: createTask
Create User
Creates a new user in your Domo instance. | key: createUser
Delete Account
Deletes an Account from your Domo instance. | key: deleteAccount
Delete Attachment
Permanently deletes an attachment from your task. | key: deleteAttachment
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
Delete Group
Permanently deletes a group from your Domo instance. | key: deleteGroup
Delete List
Permanently deletes a list from your Domo instance. | key: deleteList
Delete Page
Permanently deletes a page from your Domo instance. | key: deletePage
Delete Project
Permanently deletes a project from your Domo instance. | key: deleteProject
Delete Stream
Deletes a Stream from your Domo instance. This does not a delete the associated DataSet. | key: deleteStream
Delete User
Permanently deletes a user from your Domo instance. | key: deleteUser
Download Attachment
Downloads an individual attachment given an attachment id. | key: downloadAttachment
Export Data From DataSet
Export data from a DataSet in your Domo instance. | key: exportDataFromDataSet
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
Get Activity Log Entries
Retrieves activity log entries | key: getActivityLogEntries
Get Data Set
Retrieves the details of an existing DataSet. | key: getDataSet
Get Group
Retrieves the details of an existing group. | key: getGroup
Get List
Retrieves the details of an individual list given a project id and a list id. | key: getList
Get List Of Attachments
Retrieve details about all of the attachments belonging to a particular task. | key: getListOfAttachments
Get Page
Retrieves the details of an existing page. | key: getPage
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
Get Project Members
Retrieves a list of ids of the users that are members of the given project id. | key: getProjectMembers
Get Stream
Retrieves the details of an existing stream. | key: getStream
Get Stream Execution
Import data into a DataSet in your Domo instance. This request will replace the data currently in the DataSet. | key: getStreamExecution
Get Task
Retrieves an individual task from a given project id and list id. | key: getTask
Get User
Retrieves the details of an existing user. | key: getUser
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
List Accounts
Get a list of all Accounts for which the user has permissions. | key: listAccounts
List DataSets
Get a list of all DataSets in your Domo instance. | key: listDataSets
List Groups
Get a list of all groups in your Domo instance. | key: listGroups
List Pages
Get a list of all pages in your Domo instance. | key: listPages
List Project List Tasks
Retrieves all tasks from a given project id and list id. | key: listProjectListTasks
List Project Lists
Retrieves all lists available within a given project id. | key: listProjectLists
List Projects
Retrieves a list of all projects that the client scope has access to. | key: listProjects
List Stream Execution
Returns all Stream Execution objects that meet argument criteria from original request. | key: listStreamExecution
List Streams
Get a list of all Streams for which the user has view permissions. | key: listStreams
List Users
Get a list of all users in your Domo instance. | key: listUsers
List Users In Group
List the users in a group in your Domo instance. | key: listUsersInGroup
Query Data Set
Queries the data in an existing Domo DataSet | key: queryDataSet
Raw Request
Send Raw Request to Domo API. | key: rawRequest
Remove User From Group
Remove a user from a group in your Domo instance. | key: removeUserFromGroup
Search Stream
Returns all Stream objects that meet argument criteria from original request. | key: searchStream
Share Account
Share an Account with a User. | key: shareAccount
Update Account
Updates the specified Account’s metadata as well as the Account’s Type properties. | key: updateAccount
Update Data Set
Updates the specified DataSet’s metadata by providing values to parameters passed. | key: updateDataSet
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
Update List
Update the details of a list given an existing project id and list id. | key: updateList
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
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
Update Project Members
Update the members of a given project id. | key: updateProjectMembers
Update Stream
Updates the specified Stream’s metadata by providing values to parameters passed. | key: updateStream
Update Task
Update the details of a task given an existing project id, list id, and task id. | key: updateTask
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
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