Domo Component

The Domo platform includes a world class data warehouse, robust data pipeline functionality, and visualization engine.

Component key: domo

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

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.

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
Limit	The number of Accounts to return in the list. The default is 50 and the maximum is 500.
Offset	The offset of Accounts to begin the list of Accounts within the response.

Select Account Type

Select a Domo account type. | key: accountTypes | type: picklist

Input	Notes	Example
Connection
Limit	The number of Account Types to return in the list. The default is 50 and the maximum is 500.
Offset	The offset of the Account Types to begin list of Account Types within the response.

Select Group

Select a Domo group. | key: groups | type: picklist

Input	Notes	Example
Connection
Limit	The amount of groups to return in the list. The default is 50 and the maximum is 500.
Offset	The offset of the group ID to begin list of groups within the response.

Select Page

Select a Domo page. | key: pages | type: picklist

Input	Notes	Example
Connection
Limit	The amount of pages to return in the list. The default is 50 and the maximum is 500.
Offset	The offset of the page ID to begin list of pages within the response.

Select Project

Select a Domo project. | key: projects | type: picklist

Input	Notes	Example
Connection

Select Project List

Select a Domo project list. | key: projectLists | type: picklist

Input	Notes	Example
Connection
Project ID	The ID of the project.

Select Stream

Select a Domo stream. | key: streams | type: picklist

Input	Notes	Example
Connection
Limit	The amount of Stream to return in the list. The default is 50 and the maximum is 500.
Offset	The offset of the Stream ID to begin list of users within the response.

Actions

Abort Stream Execution

If needed during an execution, aborts an entire Stream execution. | key: abortStreamExecution

Input	Notes	Example
Connection
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.
Stream ID	The ID of the Stream of data being imported into a DataSet.

Add Attachment

Add a multipart form file to a task item as an attachment. | key: addAttachment

Input	Notes	Example
Connection
List ID	The ID of the list.
Project ID	The ID of the project.
Task ID	The ID of the task.

Add User To Group

Add user to a group in your Domo instance. | key: addUserToGroup

Input	Notes	Example
Connection
Group ID	The ID of the group.
User ID	The ID of the user.

Commit Stream Execution

Commits stream execution to import combined set of data parts that have been successfully uploaded. | key: commitStreamExecution

Input	Notes	Example
Connection
Execution ID	The ID of the Stream execution within the Stream
Stream ID	The ID of the Stream of data being imported into a DataSet.

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
ID
Name
Password
URL
Username

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
Description	Description of the DataSet to create
Name	Name of the DataSet to create
Rows

Create Group

Creates a new group in your Domo instance. | key: createGroup

Input	Notes	Example
Connection
Name	The name of the group.

Create List

Creates a new list within the given project id. | key: createList

Input	Notes	Example
Connection
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.
Project ID	The ID of the project.
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
Connection
Group ID	The ID of the group that will be given access to view the page
Locked	will restrict other users the ability to make edits to page or its content - the default value is false
Name	The name of the page.
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

Create Project

Create a new project in your Domo instance | key: createProject

Input	Notes	Example
Name	Body name
Connection
Description	The description of the project.
Due Date	The due date of the project
Members	Array of user ID's that will be assigned as members of the project
Member ID	Body member
Name	The name of the project.
Public Body
Public	Whether or not the project should 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
DataSet object	The DataSet object associated with this Stream.
Description
Name
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
Stream ID	The ID of the Stream.

Create Task

Add a task to a project list. | key: createTask

Input	Notes	Example
Connection
Contributors	An array of user IDs that are assigned as contributors to the task.
Description	An optional description of the task.
Due Date	The date the task is expected to be completed.
List ID	The ID of the list within a project that the task belongs to.
Owned By	The ID of the Domo user that owns the task.
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.
Project ID	The ID of the project that the task belongs to.
Tags	An array of tags that have been assigned to the task.
Task Name	The name of the task.
Task Object	The request body accepts a task object.

Create User

Creates a new user in your Domo instance. | key: createUser

Input	Notes	Example
Alternate Email	User's secondary email in profile.
Connection
Email	User's primary email used in profile.
Employee Number	Employee number within company.
Locale	Locale used to display to user the system settings throughout Domo application.
Location	Free text that can be used to define office location.
Name
Phone	Primary phone number of user.
Role	The role of the user created.	Admin
Send Invite	Send an email invite to created user.
Timezone	Time zone used to display to user the system times throughout Domo application.
Title	User's job title.
User Body

Delete Account

Deletes an Account from your Domo instance. | key: deleteAccount

Input	Notes	Example
Account ID	The ID of the account to delete.
Connection

Delete Attachment

Permanently deletes an attachment from your task. | key: deleteAttachment

Input	Notes	Example
Attachment ID	The ID of the attachment.
Connection
Project ID	The ID of the project that the attachment belongs to.
Task ID	The ID of the task that the attachment belongs to.

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
DataSet ID	The ID of the DataSet.

Delete Group

Permanently deletes a group from your Domo instance. | key: deleteGroup

Input	Notes	Example
Connection
Group ID	The ID of the group to delete.

Delete List

Permanently deletes a list from your Domo instance. | key: deleteList

Input	Notes	Example
Connection
List ID	The ID of the list.
Project ID	The ID of the project.

Delete Page

Permanently deletes a page from your Domo instance. | key: deletePage

Input	Notes	Example
Connection
Page ID	The ID of the page.

Delete Project

Permanently deletes a project from your Domo instance. | key: deleteProject

Input	Notes	Example
Connection
Project ID	The ID of the project.

Delete Stream

Deletes a Stream from your Domo instance. This does not a delete the associated DataSet. | key: deleteStream

Input	Notes	Example
Connection
Stream ID	The ID of the Stream to delete.

Delete User

Permanently deletes a user from your Domo instance. | key: deleteUser

Input	Notes	Example
Connection
User ID	The ID of the user.

Download Attachment

Downloads an individual attachment given an attachment id. | key: downloadAttachment

Input	Notes	Example
Attachment ID	The ID of the attachment.
Connection
List ID	The ID of the list.
Project ID	The ID of the project.
Task ID	The ID of the task.

Export Data From DataSet

Export data from a DataSet in your Domo instance. | key: exportDataFromDataSet

Input	Notes	Example
Connection
File Name	The filename of the exported csv.
Include Header	Include table header.

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.
Connection

Get Activity Log Entries

Retrieves activity log entries | key: getActivityLogEntries

Input	Notes	Example
Connection
End	The end time(milliseconds) of when you want to receive log events.
Limit	The maximum number of events you want to retrieve(default is 50, maximum of 1000).
Offset	The offset location of events you retrieve(default is 0).
Start	The start time(milliseconds) of when you want to receive log events.
User	The Id of the user.

Get Data Set

Retrieves the details of an existing DataSet. | key: getDataSet

Input	Notes	Example
Connection
DataSet ID	The ID of the DataSet.

Get Group

Retrieves the details of an existing group. | key: getGroup

Input	Notes	Example
Connection
Group ID	The ID of the group.

Get List

Retrieves the details of an individual list given a project id and a list id. | key: getList

Input	Notes	Example
Connection
List ID	The ID of the list.
Project ID	The ID of the project.

Get List Of Attachments

Retrieve details about all of the attachments belonging to a particular task. | key: getListOfAttachments

Input	Notes	Example
Connection
List ID	The ID of the list.
Project ID	The ID of the project.
Task ID	The ID of the task.

Get Page

Retrieves the details of an existing page. | key: getPage

Input	Notes	Example
Connection
Page ID	The ID of the page.

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
Project ID	The ID of the project.

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
Project ID	The ID of the project.

Get Stream

Retrieves the details of an existing stream. | key: getStream

Input	Notes	Example
Connection
Fields	Return desired fields: {all} or {id, dataset, updateMethod, createdAt, or modifiedAt}
Stream ID	The id of the stream.

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
Execution ID	The ID of the Stream execution within the Stream.
Stream ID	The ID of the Stream of data being imported into a DataSet.

Get Task

Retrieves an individual task from a given project id and list id. | key: getTask

Input	Notes	Example
Connection
List ID	The ID of the list.
Project ID	The ID of the project.
Task ID	The ID of the task.

Get User

Retrieves the details of an existing user. | key: getUser

Input	Notes	Example
Connection
User ID	The ID of the user.

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
CSV Body
DataSet ID	The ID of the DataSet.

List Accounts

Get a list of all Accounts for which the user has permissions. | key: listAccounts

Input	Notes	Example
Connection
Limit	The number of Accounts to return in the list. The default is 50 and the maximum is 500.
Offset	The offset of Accounts to begin the list of Accounts within the response.

List DataSets

Get a list of all DataSets in your Domo instance. | key: listDataSets

Input	Notes	Example
Connection
Limit	The amount of DataSets to return in the list. The default is 50 and the maximum is 50.
Name Like	If included, will limit the list of DataSets to those with names that contain the string passed in. nameLike is case insensitive.
Offset	The offset of the DataSet ID to begin list of users within the response.
Sort	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).

List Groups

Get a list of all groups in your Domo instance. | key: listGroups

Input	Notes	Example
Connection
Limit	The amount of groups to return in the list. The default is 50 and the maximum is 500.
Offset	The offset of the group ID to begin list of groups within the response.

List Pages

Get a list of all pages in your Domo instance. | key: listPages

Input	Notes	Example
Connection
Limit	The amount of pages to return in the list. The default is 50 and the maximum is 500.
Offset	The offset of the page ID to begin list of pages within the response.

List Project List Tasks

Retrieves all tasks from a given project id and list id. | key: listProjectListTasks

Input	Notes	Example
Connection
Limit	The number of records to offset from the beginning of the result list (defaults to 0)
List ID	The ID of the list.
Offset	The maximum amount of results to return (defaults to 10 with a maximum of 50)
Project ID	The ID of the project.

List Project Lists

Retrieves all lists available within a given project id. | key: listProjectLists

Input	Notes	Example
Connection
Project ID	The ID of the project.

List Projects

Retrieves a list of all projects that the client scope has access to. | key: listProjects

Input	Notes	Example
Connection

List Stream Execution

Returns all Stream Execution objects that meet argument criteria from original request. | key: listStreamExecution

Input	Notes	Example
Connection
Limit	The amount of Stream to return in the list. The default is 50 and the maximum is 500.
Offset	The offset of the Stream ID to begin list of users within the response.
Stream ID	The ID of the Stream

List Streams

Get a list of all Streams for which the user has view permissions. | key: listStreams

Input	Notes	Example
Connection
Limit	The amount of Stream to return in the list. The default is 50 and the maximum is 500.
Offset	The offset of the Stream ID to begin list of users within the response.

List Users

Get a list of all users in your Domo instance. | key: listUsers

Input	Notes	Example
Connection
Limit	The amount of users to return in the list. The default is 50 and the maximum is 500.
Offset	The offset of the user ID to begin list of users within the response.

List Users In Group

List the users in a group in your Domo instance. | key: listUsersInGroup

Input	Notes	Example
Connection
Group ID	The ID of the group.
Limit	The amount of groups to return in the list. The default is 50 and the maximum is 500.
Offset	The offset of the group ID to begin list of groups within the response.

Query Data Set

Queries the data in an existing Domo DataSet | key: queryDataSet

Input	Notes	Example
Connection
DataSet ID	The ID of the DataSet.
SQL	The SQL query to execute.

Raw Request

Send raw HTTP request to Domo. | key: rawRequest

Input	Notes	Example
Connection
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.	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.	false
Retry Delay (ms)	The delay in milliseconds between retries.	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.	false

Remove User From Group

Remove a user from a group in your Domo instance. | key: removeUserFromGroup

Input	Notes	Example
Connection
Group ID	The ID of the group.
User ID	The ID of the user.

Search Stream

Returns all Stream objects that meet argument criteria from original request. | key: searchStream

Input	Notes	Example
Connection
Fields	Return desired fields: {all} or {id, dataset, updateMethod, createdAt, or modifiedAt}
Qualifiers	The search qualifiers to search by available qualifiers: dataSource.id or dataSource.owner.id

Share an Account with a User. | key: shareAccount

Input	Notes	Example
Account ID	The ID of the Account.
Connection
User	The User to share the Account with.

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.
Connection
Update Account Body

Update Data Set

Updates the specified DataSet’s metadata by providing values to parameters passed. | key: updateDataSet

Input	Notes	Example
Connection
DataSet ID	The ID of the DataSet.
Update DataSet Body

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
Group ID	The ID of the group.
Update Group Body

Update List

Update the details of a list given an existing project id and list id. | key: updateList

Input	Notes	Example
Connection
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.
Name	The updated name of the list.
Project ID	The ID of the project.
Type	The type of the list.
Update List Body

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
Page ID	The ID of the page.
Update Page Body

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
Description	Updates the description of the project.
Due Date	Updates the due date of the project.
Name	Updates the name of the project.
Project ID	The ID of the project.
Public	Updates whether or not the project is publicly available to Domo users.
Update Project Body

Update Project Members

Update the members of a given project id. | key: updateProjectMembers

Input	Notes	Example
Connection
Project ID	The ID of the project.
Update Project Members Body

Update Stream

Updates the specified Stream’s metadata by providing values to parameters passed. | key: updateStream

Input	Notes	Example
Connection
Stream ID	The ID of the stream to update.
Update Method Body
Update Method	The data import behavior.

Update Task

Update the details of a task given an existing project id, list id, and task id. | key: updateTask

Input	Notes	Example
Connection
Contributors	An array of user IDs that are assigned as contributors to the task.
Description	Description of the DataSet to create
Due Date	The due date of the project
List ID	The ID of the list.
Owned By	The ID of the Domo user that owns the task.
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.
Project ID	The ID of the project.
Tags	An array of tags that have been assigned to the task.
Task ID	The ID of the task.
Task Name	The name of the task.
Update Task Body

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.
Connection
Email	User's primary email used in profile.
Employee Number	Employee number within company.
Locale	Locale used to display to user the system settings throughout Domo application.
Location	Free text that can be used to define office location.
Name	User's full name
Phone	Primary phone number of user.
Role	The system role of the user	Admin
Roled	The ID of the custom or system role of the user.
Timezone	Time zone used to display to user the system times throughout Domo application.
Title	User's job title.
Update User Body
User ID	The ID of the user.

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
Execution ID	The ID of the Stream execution within the Stream.
Part ID	The ID of the data part being used to upload a subset of data within the Stream execution.
Stream ID	The ID of the Stream of data being imported into a DataSet.

The Domo platform includes a world class data warehouse, robust data pipeline functionality, and visualization engine.

Description​

Connections​

Domo OAuth Connection​

Data Sources​

Select Account​

Select Account Type​

Select Group​

Select Page​

Select Project​

Select Project List​

Select Stream​

Actions​

Abort Stream Execution​

Add Attachment​

Add User To Group​

Commit Stream Execution​

Create Account​

Create Data Set​

Create Group​

Create List​

Create Page​

Create Project​

Create Stream​

Create Stream Execution​

Create Task​

Create User​

Delete Account​

Delete Attachment​

Delete Data Set​

Delete Group​

Delete List​

Delete Page​

Delete Project​

Delete Stream​

Delete User​

Download Attachment​

Export Data From DataSet​

Get Accounts​

Get Activity Log Entries​

Get Data Set​

Get Group​

Get List​

Get List Of Attachments​

Get Page​

Get Project​

Get Project Members​

Get Stream​

Get Stream Execution​

Get Task​

Get User​

Import Data Into DataSet​

List Accounts​

List DataSets​

List Groups​

List Pages​

List Project List Tasks​

List Project Lists​

List Projects​

List Stream Execution​

List Streams​

List Users​

List Users In Group​

Query Data Set​

Raw Request​

Remove User From Group​

Search Stream​

Share Account​

Update Account​

Update Data Set​

Update Group​

Update List​

Update Page​

Update Project​

Update Project Members​

Update Stream​

Update Task​

Update User​

Upload Data Part​