Domo

https://www.domo.com/docs/
Admin
Domo is a cloud-based business intelligence and data analytics platform that enables users to...
Tokens:289,362
Snippets:3,342
Trust Score:10
Update:3 months ago
Show doc for...
Tokens:
Raw
### Example manifest.json Structure

Source: https://www.domo.com/docs/portal/Apps/App-Framework/Tutorials/javascript/SugarForce

A complete example of a manifest file configuration.

```json
{
  "name": "SugarForce",
  "version": "0.1.0",
  "size": {
    "width": 5,
    "height": 3
  },
  "collections": [
    {
      "name": "opportunities"
    }
  ],
  "mapping": [
    {
      "dataSetId": "d6906ec6-9a23-40d2-b93c-7bb53f231bce",
      "alias": "leads",
      "fields": []
    }
  ],
  "fileName": "manifest.json",
  "id": "15e5a077-22df-4228-b232-d71dd631394c"
}
```

--------------------------------

### Install Domo CLI

Source: https://www.domo.com/docs/portal/Apps/App-Framework/Tools/domo-CLI

Install the CLI globally using npm.

```bash
npm install -g ryuu
```

--------------------------------

### Install and Import domo.js

Source: https://www.domo.com/docs/portal/Apps/App-Framework/Tools/domo-js

Installation command and module import patterns for ES and CommonJS environments.

```bash
npm install ryuu.js
```

```javascript
// ES modules
import domo from 'ryuu.js';

// CommonJS
const domo = require('ryuu.js').default;
```

--------------------------------

### Install Ryuu Proxy for Vue

Source: https://www.domo.com/docs/portal/Apps/App-Framework/Quickstart/Starter-Kits

Install the development proxy module as a development dependency.

```bash
npm install --save-dev @domoinc/ryuu-proxy
```

--------------------------------

### Define Workflow Start Object

Source: https://www.domo.com/docs/portal/Partner-Developers/Guides/start-a-remote-workflow

Example structure for the startObject parameter, which must match the input names and types defined in the target workflow.

```json
{
  "userId": "123",
  "role": 1,
  "name": "John Doe"
}
```

--------------------------------

### Query Files Response Example

Source: https://www.domo.com/docs/portal/API-Reference/app-framework-apis/Documents-API

Example JSON response returned after a successful file query request.

```json
[
  {
    "id": "00000000-0000-0000-0000-000000000003",
    "path": "rules.txt",
    "name": "rules.txt",
    "fileType": "TEXT",
    "contentType": "text/plain",
    "size": 12345,
    "created": "2025-01-01T00:00:00.000Z",
    "createdBy": 111111111
  }
]
```

--------------------------------

### Install domo-jupyter library

Source: https://www.domo.com/docs/links/jupyter

Use this command to install or update the domo-jupyter library in your environment.

```bash
conda install -c https://domo-conda-prod.s3.amazonaws.com/domo domojupyter=1.1.32
```

--------------------------------

### Install Python SDK dependencies

Source: https://www.domo.com/docs/portal/Getting-Started/sdks

Install the required Python packages using pip.

```bash
pip3 install pydomo requests jsonpickle
```

--------------------------------

### DOMO.getStartDate(dateParam)

Source: https://www.domo.com/docs/portal/Connectors/Custom-Connectors/reference

Sets the start date for the connector.

```APIDOC
## DOMO.getStartDate(dateParam)

### Description
Used to set the start date.

### Parameters
- **Date** (string) - Required - The start date.
```

--------------------------------

### SQL API Request Example

Source: https://www.domo.com/docs/portal/Apps/App-Framework/Guides/getting-data

Example URL for a POST request to the SQL API using the 'sales' alias.

```http
POST /data/v1/sales
```

--------------------------------

### Permissions Array Example

Source: https://www.domo.com/docs/api-reference/workflows-api-product/change-workflow-permissions

Example format for the permissions array field in the request body.

```json
["ADMIN", "READ", "EXECUTE"]
```

--------------------------------

### JavaScript Query Aggregation Example

Source: https://www.domo.com/docs/portal/API-Reference/app-framework-apis/AppDB-API

An example of using the domo.post method to execute a query with multiple aggregation parameters.

```javascript
const url =
  '/domo/datastores/v1/collections/campaigns/documents/query?groupby=content.campaignName, content.month&count=documentCount&avg=content.clicks avgClicks, content.impressions avgImps&sum=content.clicks sumClicks, content.impressions sumImps&max=content.clicks maxClicks, content.impressions maxImps&min=content.clicks minClicks, content.impressions minImps&orderby=sumClicks descending';

domo.post(url, {}).then((data) => console.log(data));
```

--------------------------------

### Data API Request Example

Source: https://www.domo.com/docs/portal/Apps/App-Framework/Guides/getting-data

Example URL for requesting data from a DataSet with the alias 'sales'.

```http
GET /data/v1/sales
```

--------------------------------

### Example CSV response

Source: https://www.domo.com/docs/portal/API-Reference/app-framework-apis/Data-API

Sample CSV output format.

```text
('first', 'last', 'age');
('Joe', 'Jacobs', '39');
('Henry', 'Woolington', '23');
```

--------------------------------

### Example array-of-objects response

Source: https://www.domo.com/docs/portal/API-Reference/app-framework-apis/Data-API

Sample JSON output for the array-of-objects format.

```json
[
  { "first": "Joe", "last": "Jacobs", "age": 39 },
  { "first": "Henry", "last": "Woolington", "age": 23 }
]
```

--------------------------------

### Get Stream Configuration Request

Source: https://www.domo.com/docs/portal/35115c5c48927-datasets-api

Example request structure for retrieving stream details.

```json
{
  "method": "GET",
  "url": "https://{domo_instance}.domo.com/api/data/v1/streams/{stream_id}",
  "headers": {}
}
```

--------------------------------

### Start Development Server

Source: https://www.domo.com/docs/portal/Apps/App-Framework/Tools/domo-CLI

Launch the local development server with live reload and data proxying.

```bash
domo dev [options]
```

--------------------------------

### Get Queues HTTP Response

Source: https://www.domo.com/docs/portal/ff85f1d956ae2-task-center-api

Example response body containing a list of queue objects.

```http
HTTP/1.1 200 OK
Content-Type: application/json;charset=UTF-8


[
    {
        "id": "168ecd84-4a15-45f6-89d9-021fbbce0481",
        "name": "Review Airplane Part Action Items",
        "description": "Human review of AI generated recommendations for QA process improvements based on product defects in manufacturing QA.",
        "active": true,
        "taskLevelFiltersEnabled": true,
        "taskLevelFilters": null,
        "owner": "8811501",
        "createdBy": "8811501",
        "createdOn": "2023-10-18T14:48:23.314Z",
        "updatedBy": "8811501",
        "updatedOn": "2023-10-18T14:48:23.314Z"
    }
]
```

--------------------------------

### Initialize New App

Source: https://www.domo.com/docs/portal/Apps/App-Framework/Tools/domo-CLI

Create a new custom app design template in a new directory.

```bash
domo init
```

--------------------------------

### Retrieve DataSet Metadata Request

Source: https://www.domo.com/docs/portal/35115c5c48927-datasets-api

Example request structure for the GET /api/data/v3/datasources/:datasetId endpoint.

```json
{
  "method": "GET",
  "url": "https://{instance}.domo.com/api/data/v3/datasources/{datasetId}?part=core,permission",
  "headers": {
    "X-DOMO-Developer-Token": "",
    "Content-Type": "application/json"
  },
}
```

--------------------------------

### Hello World Starter Structure

Source: https://www.domo.com/docs/portal/Apps/App-Framework/Tools/domo-CLI

The file structure generated by the hello world starter template.

```text
<design-name>
  - app.css
  - app.js
  - domo.js
  - index.html
  - manifest.json
```

--------------------------------

### Get Activity Log Response

Source: https://www.domo.com/docs/portal/b90c3866dbc26-activity-log-api

Example response body containing an array of activity log entries.

```json
[
  {
    "userName": "Jae Wilson",
    "userId": "1893952720",
    "userType": "USER",
    "actionType": "VIEWED",
    "objectType": "ACTIVITY_LOG",
    "additionalComment": "Jae Wilson viewed the activity log.",
    "time": 1654205894927,
    "eventText": "Viewed activity log"
  },
  {
    "userName": "Bryan Van Kampen",
    "userId": "587894148",
    "userType": "USER",
    "actionType": "VIEWED",
    "objectType": "PAGE",
    "additionalComment": "Bryan Van Kampen viewed page 'How Should we manage this monster?'.",
    "time": 1654189333186,
    "eventText": "Viewed page"
  }
]
```

--------------------------------

### Get Workflow Instance HTTP Response

Source: https://www.domo.com/docs/portal/API-Reference/app-framework-apis/Workflows-API

Example JSON response containing workflow metadata and status.

```json
HTTP/1.1 200 OK
Content-Type: application/json;charset=UTF-8

{
    "id": "2052e10a-d142-4391-a731-2be1ab1c0188", // id of the workflow
    "modelId": "a8afdc89-9491-4ee4-b7c3-b9e9b86c0138", // id of the workflow instance
    "modelName": "AddTwoNumbers", // name of the workflow
    "modelVersion": "1.1.0", // workflow version number
    "createdBy": "8811501", // user id of workflow creator
    "createdOn": "2023-11-15T15:28:57.479Z",
    "updatedBy": "8811501",
    "updatedOn": "2023-11-15T15:28:57.479Z",
    "status": "COMPLETED"
}
```

--------------------------------

### Publish and preview the app

Source: https://www.domo.com/docs/portal/Apps/App-Framework/Tutorials/javascript/SugarForce

Commands to publish the app to a Domo instance and launch a hot-reloading development server.

```bash
domo publish
```

```bash
domo dev
```

--------------------------------

### Get Activity Log Object Types Request

Source: https://www.domo.com/docs/portal/b90c3866dbc26-activity-log-api

Example request to retrieve the list of available object types for filtering.

```json
{
  "method": "GET",
  "url": "https://{domo_instance}.domo.com/api/audit/v1/user-audits/objectTypes",
  "headers": {
    "X-DOMO-Developer-Token": "",
    "Content-Type": "application/json"
  }
}
```

--------------------------------

### Initialize and Query Data with domo.js

Source: https://www.domo.com/docs/portal/Apps/App-Framework/Tools/domo-js

Demonstrates importing the SDK, querying a dataset by alias, and setting up a listener for page filter updates.

```javascript
import domo from 'ryuu.js';

// Query a dataset by its manifest alias
const rows = await domo.data.query('sales');

// React to page filter changes
domo.onFiltersUpdated((filters) => {
  console.log('Filters changed:', filters);
  loadData();
});
```

--------------------------------

### Get Activity Log Request

Source: https://www.domo.com/docs/portal/b90c3866dbc26-activity-log-api

Example request structure for retrieving user activity logs using query parameters.

```json
{
  "method": "GET",
  "url": "https://{domo_instance}.domo.com/api/audit/v1/user-audits?start=1646434158639&end=1654206558639&offset=0&limit=300&objectType=DATAFLOW_TYPE,ACCOUNT",
  "headers": {
    "X-DOMO-Developer-Token": "",
    "Content-Type": "application/json"
  }
}
```

--------------------------------

### Initialize React App with Domo Template

Source: https://www.domo.com/docs/portal/Apps/App-Framework/Quickstart/Starter-Kits

Commands to create a new React project pre-configured with Domo dependencies using different package managers.

```bash
yarn create react-app my-app --template @domoinc
```

```bash
npx create-react-app my-app --template @domoinc
```

```bash
npm init react-app my-app -- --template @domoinc
```

--------------------------------

### Initialize Vue Project

Source: https://www.domo.com/docs/portal/Apps/App-Framework/Quickstart/Starter-Kits

Standard commands to scaffold a new Vue project using the Webpack template.

```bash
vue init webpack my-app
cd my-app
```

--------------------------------

### Get Files Metadata Response

Source: https://www.domo.com/docs/portal/9850f1f9ca01b-files-api

Example of a successful HTTP 200 response returning an array of file metadata objects.

```http
HTTP/1.1 200 OK
Content-Type: application/json

[
    {
        "dataFileId": 401,
        "name": "\"SampleFile\"",
        "responsibleUserId": 1089963280,
        "currentRevision": {
            "dataFileRevisionId": 430,
            "dataFileId": 401,
            "contentType": "application/pdf",
            "uploadUserId": 1089963280,
            "sizeBytes": 142783,
            "uploadTimeMillis": 199,
            "md5Hash": "B6C962A9288F132762051A6A33708B90",
            "datetimeUploaded": 1731613990000,
            "scanState": "SAFE",
            "sha256HashValue": "5E3EF0EF4CFAD65A1831D866DEEBD932C5A0AA3484A558FD0D1CA3EB852AE1BF"
        },
        "datetimeCreated": 1731611168000,
        "revisions": [],
        "existing": false
    }
]
```

--------------------------------

### Get Stream Configuration Response

Source: https://www.domo.com/docs/portal/35115c5c48927-datasets-api

Example response body containing stream configuration, data provider details, and schema definitions.

```json
{
    "id": 371,
    "valid": true,
    "invalidExecutionId": null,
    "transport": {
        "type": "CONNECTOR",
        "description": "com.domo.connector.covid19",
        "version": "0"
    },
    "updateMethod": "REPLACE",
    "dataProvider": {
        "id": 2834,
        "key": "covid-19",
        "name": "Covid-19",
        "url": null,
        "defaultConnectorId": null,
        "defaultConnectorLabel": null,
        "authenticationScheme": null,
        "connectorValidatorPresent": false,
        "resourceBundlePresent": false,
        "moduleHandler": null,
        "iconPicker": false,
        "scope": "0",
        "producer": "DOMO",
        "version": "0",
        "dateCreated": 1583529722000,
        "dateUpdated": 1583521641000,
        "visibility": "WITH_CONNECTOR",
        "type": "STANDARD",
        "authenticationSchemeConfiguration": []
    },
    "account": null,
    "dataSource": {
        "id": "dcad2f50-e65e-4259-a9e8-214a3d1e18a7",
        "displayType": "covid-19",
        "dataProviderType": "covid-19",
        "type": "covid-19",
        "name": "DOMO Covid Time Series Tracker Data",
        "owner": {
            "id": "1345408759",
            "name": "Alexis Lorenz (DataMaven)",
            "type": "USER",
            "group": false
        },
        "status": "SUCCESS",
        "created": 1594224795000,
        "lastTouched": 1652481876000,
        "lastUpdated": 1652481807436,
        "nextUpdate": 1652483579534,
        "rowCount": 283429,
        "columnCount": 22,
        "cardInfo": {
            "cardCount": 30,
            "cardViewCount": 0
        },
        "properties": {
            "formulas": {
                "formulas": {
                    "calculation_c8db9ded-314f-41fa-9352-2954139a1302": {
                        "templateId": 422,
                        "id": "calculation_c8db9ded-314f-41fa-9352-2954139a1302",
                        "name": "Filter out Early Results",
                        "formula": "(CASE  WHEN ((CURRENT_DATE = `date`) AND (HOUR(CURRENT_TIMESTAMP) >= 8)) THEN 'TOO EARLY' ELSE 'USE CURRENT' END )",
                        "status": "VALID",
                        "persistedOnDataSource": true,
                        "isAggregatable": false,
                        "bignumber": false,
                        "columnPositions": [
                            {
                                "columnName": "`date`",
                                "columnPosition": 29
                            }
                        ]
                    },
                    "calculation_af03accf-482c-46ce-bb73-eaa008e511d5": {
                        "templateId": 429,
                        "id": "calculation_af03accf-482c-46ce-bb73-eaa008e511d5",
                        "name": "Recovered (Negative)",
                        "formula": "(`recovered_total` * -1)",
                        "status": "VALID",
                        "dataType": "DOUBLE",
                        "persistedOnDataSource": true,
                        "isAggregatable": false,
                        "bignumber": false,
                        "columnPositions": [
                            {
                                "columnName": "`recovered_total`",
                                "columnPosition": 1
                            }
                        ]
                    }
                }
            }
        },
        "state": "SUCCESS",
        "validConfiguration": true,
        "validAccount": true,
        "streamId": 371,
        "transportType": "CONNECTOR",
        "adc": false,
        "adcExternal": false,
        "cloudId": "domo",
        "cloudName": "Domo",
        "permissions": "READ_SHARE",
        "hidden": false,
        "tags": "[\"s_covid-19\",\"udt_MINUTE at undefined\",\"um_REPLACE\",\"covid-19\"]",
        "scheduleActive": true
    },
    "schemaDefinition": {
        "columns": [
            {
                "type": "DATE",
                "name": "date",
                "id": "date",
                "visible": true,
                "metadata": {
                    "colLabel": "date",
                    "colFormat": "",
                    "isEncrypted": false
                }
            },
            {
                "type": "STRING",
                "name": "ISO3",
                "id": "ISO3",
                "visible": true,
                "metadata": {
                    "colLabel": "ISO3",

```

--------------------------------

### Get Activity Log Object Types Response

Source: https://www.domo.com/docs/portal/b90c3866dbc26-activity-log-api

Example response body containing an array of valid object type strings.

```json
[
  "ACCOUNT",
  "DATAFLOW_TYPE",
  "DATA_SOURCE"
]
```

--------------------------------

### Connect to a Domo Instance

Source: https://www.domo.com/docs/s/article/360043437733?language=en_US

Use these commands to authenticate with a Domo instance using either credentials or an access token.

```bash
connect -u jim.smith@xyzcompany.com -p abc123 -s xyzcompany.domo.com
```

```bash
connect -s xyzcompany.domo.com -t mffde8e727f825ae23e1117070f0ad67cfeb40c607dddd
```

--------------------------------

### POST /domo/workflow/v1/models/{workflowAlias}/start

Source: https://www.domo.com/docs/portal/API-Reference/app-framework-apis/Workflows-API

Starts a specific workflow instance and returns details about the created instance.

```APIDOC
## POST /domo/workflow/v1/models/{workflowAlias}/start

### Description
Starts a Workflow and returns details about the Workflow Instance.

### Method
POST

### Endpoint
/domo/workflow/v1/models/{workflowAlias}/start

### Parameters
#### Path Parameters
- **workflowAlias** (String) - Required - The name given to the Workflow in the manifest

#### Request Body
- **parameters** (Object) - Required - An object containing the start parameters required to run the workflow, corresponding to the aliasName defined in the manifest.json file.

### Request Example
{
  "parameter1": "value1",
  "parameter2": "value2"
}

### Response
#### Success Response (200)
- **id** (String) - The id of the workflow
- **modelId** (String) - The id of the workflow instance
- **modelName** (String) - The name of the workflow
- **modelVersion** (String) - The workflow version number
- **createdBy** (String) - The user id of the workflow creator
- **createdOn** (String) - The timestamp of creation
- **updatedBy** (String) - The user id of the last updater
- **updatedOn** (String) - The timestamp of the last update
- **status** (String) - The status of the workflow (null, IN_PROGRESS, CANCELED, or COMPLETED)

#### Response Example
{
    "id": "2052e10a-d142-4391-a731-2be1ab1c0188",
    "modelId": "a8afdc89-9491-4ee4-b7c3-b9e9b86c0138",
    "modelName": "AddTwoNumbers",
    "modelVersion": "1.1.0",
    "createdBy": "8811501",
    "createdOn": "2023-11-15T15:28:57.479Z",
    "updatedBy": "8811501",
    "updatedOn": "2023-11-15T15:28:57.479Z",
    "status": "null"
}
```

--------------------------------

### Initial manifest.json configuration

Source: https://www.domo.com/docs/portal/Apps/App-Framework/Tutorials/javascript/ReturnFlow

The initial configuration file defining the app name, size, and DataSet mapping.

```json
{
  "name": "Return Flow",
  "version": "1.0.0",
  "size": {
    "width": 1,
    "height": 1
  },
  "mapping": [
    {
      "dataSetId": "77b63b77-540a-407e-b217-78f0b262596c",
      "alias": "returns",
      "fields": []
    }
  ]
}
```

--------------------------------

### Create Angular Project

Source: https://www.domo.com/docs/portal/Apps/App-Framework/Quickstart/Starter-Kits

Initial steps to scaffold a new Angular application for Domo development.

```bash
$ ng new domo-app
$ cd domo-app
```

--------------------------------

### Retrieve start date

Source: https://www.domo.com/docs/portal/Connectors/Custom-Connectors/reference

Extracts the start date from connector metadata parameters.

```javascript
var startDate = DOMO.getStartDate(metadata.parameters['Date']);
```

--------------------------------

### Domo CLI Options

Source: https://www.domo.com/docs/portal/Apps/App-Framework/Tools/domo-CLI

Common flags for versioning, SSL configuration, and manifest specification.

```bash
domo -v
```

```bash
domo -s
```

```bash
domo -m
```

```bash
domo -h
```

```bash
domo [command] -h
```

--------------------------------

### Initialize Opportunity Form

Source: https://www.domo.com/docs/portal/Apps/App-Framework/Tutorials/javascript/SugarForce

Setup the form configuration and trigger the initial data load.

```javascript
(function () {
  const opportunity = {
    company_name: new AutoComplete(getLeads),
    amount: 0,
    notes: '',
  };

  addButton(opportunity, createOpportunity);

  getOpportunities();
})();
```

--------------------------------

### Configure a PromptTemplate

Source: https://www.domo.com/docs/s/article/000005544

Create a reusable prompt template with placeholders for dynamic text insertion.

```python
from domojupyter.ai.models.PromptTemplate import PromptTemplate

template_text = "Summarize the following text:\n{text}"
prompt = PromptTemplate(template=template_text)
```

--------------------------------

### Implement initial data fetching in app.js

Source: https://www.domo.com/docs/portal/Apps/App-Framework/Guides/handling-data-updates

Initial logic to fetch data from a Domo dataset and update the UI.

```javascript
(function (domo) {
  var COUNTER = 0;
  var TOTAL = 0;

  // main function to fetch data from domo
  function getData(alias) {
    COUNTER += 1;
    domo.get('/data/v1/' + alias + '?sum=total').then(function (data) {
      TOTAL = data[0].total;
      updateUI();
    });
  }

  // add variables to UI
  function updateUI() {
    var totalEl = document.getElementById('total');
    var counterEl = document.getElementById('updateCount');

    totalEl.innerHTML = TOTAL.toString();
    counterEl.innerHTML = COUNTER.toString();
  }

  // initial fetch
  console.info('App Ready...');
  getData('sales');
})(domo);
```

--------------------------------

### Define a complete app manifest

Source: https://www.domo.com/docs/portal/Apps/App-Framework/Guides/manifest

A comprehensive example of a manifest.json file including datasets, collections, workflows, channels, and package mappings.

```json
{
  "name": "My App Design",
  "version": "0.0.1",
  "fullpage": true,
  "size": {
    "width": 4,
    "height": 3
  },
  "datasetsMapping": [
    {
      "alias": "sales",
      "dataSetId": "5168da8d-1c72-4e31-ba74-f609f73071dd",
      "fields": [
        {
          "alias": "amount",
          "columnName": "Sales Amount"
        },
        {
          "alias": "name",
          "columnName": "Client Name"
        },
        {
          "alias": "startDate",
          "columnName": "Contract Initiation Date"
        }
      ]
    }
  ],
  "collections": [
    {
      "name": "CommentsTable",
      "schema": {
        "columns": [
          { "name": "user", "type": "STRING" },
          { "name": "comment", "type": "STRING" }
        ]
      },
      "syncEnabled": true
    },
    {
      "name": "Users"
    }
  ],
  "workflowMapping": [
    {
      "alias": "workflow1",
      "parameters": [
        {
          "aliasedName": "num1",
          "type": "number",
          "list": false,
          "children": null
        },
        {
          "aliasedName": "num2",
          "type": "number",
          "list": false,
          "children": null
        }
      ]
    },
    {
      "alias": "workflow2",
      "parameters": [
        {
          "aliasedName": "thing1",
          "type": "number",
          "list": false,
          "value": 2,
          "children": null
        },
        {
          "aliasedName": "thing2",
          "type": "number",
          "list": false,
          "children": null
        }
      ]
    }
  ],
  "channels": {
    "publishes": [
      {
        "name": "selection:changed",
        "description": "Fires when the user selects a row",
        "sticky": true
      }
    ],
    "subscribes": [
      {
        "name": "filter:region",
        "description": "Applies a region filter"
      }
    ]
  },
  "packageMapping": [
    {
      "alias": "awesomeFunction",
      "parameters": [
        {
          "alias": "number1AppInput",
          "type": "number",
          "nullable": false,
          "isList": false,
          "children": null
        },
        {
          "alias": "number2AppInput",
          "type": "number",
          "nullable": false,
          "isList": false,
          "children": null
        }
      ],
      "output": {
        "alias": "sumAppOutput",
        "type": "number",
        "children": null
      }
    }
  ]
}
```

--------------------------------

### View project structure

Source: https://www.domo.com/docs/portal/Apps/App-Framework/Tutorials/javascript/SugarForce

The standard directory structure for a newly initialized Domo app.

```text
+ components
    - autocomplete.js
    - floatingactionbutton.js
    - modal.js
    - router.js
    - table.js
+ js
    - app.js
    - domo.js
    - domoPhoenixWithMaps.js
    - helpers.js
    - home.js
    - leads.js
    - opportunities.js
    - reports.js
+ styles
    - app.css
index.html
manifest.json
thumbnail.png
```

--------------------------------

### Perform Text-to-SQL Request

Source: https://www.domo.com/docs/portal/ffvznqc76b2b5-ai-services-api

A minimal request example using default model settings and system prompts.

```json
{
  "method": "POST",
  "url": "https://{instance}.domo.com/api/ai/v1/text/sql",
  "headers": {
    "X-DOMO-Developer-Token": "",
    "Content-Type": "application/json"
  },
  "body": {
    "input": "What are my total sales by region?",
    "dataSourceSchemas": [
      {
        "dataSourceName": "Store Sales",
        "description": "",
        "columns": [
          {
            "type": "STRING",
            "name": "product",
            "description": ""
          },
          {
            "type": "LONG",
            "name": "store",
            "description": ""
          },
          {
            "type": "LONG",
            "name": "amount",
            "description": ""
          },
          {
            "type": "DATETIME",
            "name": "timestamp'",
            "description": ""
          },
          {
            "type": "STRING",
            "name": "region",
            "description": ""
          }
        ]
      }
    ]
  }
}
```

--------------------------------

### Install R Libraries via CRAN

Source: https://www.domo.com/docs/s/article/7440921035671

Use this command in the workspace terminal to install R packages.

```r
install.packages("cluster")
```

--------------------------------

### Workflow Start HTTP Response

Source: https://www.domo.com/docs/portal/API-Reference/app-framework-apis/Workflows-API

The JSON response returned upon successfully starting a workflow instance.

```http
HTTP/1.1 200 OK
Content-Type: application/json;charset=UTF-8

{
    "id": "2052e10a-d142-4391-a731-2be1ab1c0188", // id of the workflow
    "modelId": "a8afdc89-9491-4ee4-b7c3-b9e9b86c0138", // id of the workflow instance
    "modelName": "AddTwoNumbers", // name of the workflow
    "modelVersion": "1.1.0", // workflow version number
    "createdBy": "8811501", // user id of workflow creator
    "createdOn": "2023-11-15T15:28:57.479Z",
    "updatedBy": "8811501",
    "updatedOn": "2023-11-15T15:28:57.479Z",
    "status": "null"
}
```

--------------------------------

### Domo CLI Command Help

Source: https://www.domo.com/docs/portal/Apps/App-Framework/Tools/domo-CLI

Display available commands and usage information.

```bash
domo --help
```

--------------------------------

### Search Files using domo.post

Source: https://www.domo.com/docs/portal/API-Reference/app-framework-apis/Documents-API

Examples of listing all files and performing advanced searches using the domo.post helper method.

```javascript
// Example 1: List all files
domo
  .post(`/domo/files/v1/filesets/${documentCollectionId}/files/search`, {})
  .then((result) => console.log(result.files))
  .catch((error) => console.error(`Error: ${error}`));

// Example 2: Advanced search with directory path and filters
domo
  .post(
    `/domo/files/v1/filesets/${documentCollectionId}/files/search?directoryPath=reports&limit=20`,
    {
      // Sort by file name in ascending order
      fieldSort: [
        {
          field: "name",
          order: "ASC",
        },
      ],
      // Filter files by name
      filters: [
        {
          field: "name",
          value: [".pdf"],
          operator: "LIKE",
        },
      ],
      // Filter files created in past 30 days
      dateFilters: [
        {
          field: "created",
          start: new Date(Date.now() - 30 * 24 * 60 * 60 * 1000).toISOString(), // 30 days ago as ISO string
          end: new Date().toISOString(), // Current time as ISO string
        },
      ],
    },
  )
  .then((result) => console.log(result.files))
  .catch((error) => console.error(`Error: ${error}`));
```

--------------------------------

### Install mcp-remote

Source: https://www.domo.com/docs/s/article/MCP-Manually-Connect

Install the required bridge tool via npm to enable remote MCP server support.

```bash
npm install mcp-remote
```

--------------------------------

### Text-to-SQL Request Body Example

Source: https://www.domo.com/docs/portal/API-Reference/app-framework-apis/AI-Service-Layer-API

A sample JSON request body demonstrating the use of prompt templates, parameters, and custom data source schemas.

```json
{
  "input": "Create a sql query to show me total sales.",
  "promptTemplate": {
    "template": "${input}. Show me the ${measure} for the last ${timeframe}"
  },
  "parameters": {
    "measure": "sales",
    "timeframe": "3 months"
  },
  "model": "8dc5737d-0bc8-425b-ad0d-5d6ec1a99e72",
  "dataSourceSchemas": [
    {
      "dataSourceName": "Sales",
      "description": "Sales Data",
      "columns": [
        {
          "name": "Date",
          "type": "date"
        },
        {
          "name": "Sales",
          "type": "number"
        }
      ]
    }
  ]
}
```

--------------------------------

### Install Python Libraries via Pip

Source: https://www.domo.com/docs/s/article/7440921035671

Use this command in the workspace terminal to install or update Python libraries.

```bash
pip install -U scikit-learn
```

--------------------------------

### All Users Response Examples

Source: https://www.domo.com/docs/portal/API-Reference/app-framework-apis/User-API

JSON response structures for fetching all users with and without detailed information.

```json
[
 {
     "id": 1,
     "displayName": "User One",
     "avatarKey": "/domo/avatars/v1/avatars/dev/86/420BB31EE19FDDBA8096F19ACD4C4D.jpg",
     "role": "Admin"
 },
 {
     "id": 3,
     "displayName": "User Two",
     "avatarKey": "/domo/avatars/v1/avatars/dev/86/510BB31EE19FDDBA8046F18ACD3C5D.jpg",
     "role": "Privileged"
 },
...
]
```

```json
[
 {
     "id": 1,
     "displayName": "User One",
     "avatarKey": "/domo/avatars/v1/avatars/dev/86/420BB31EE19FDDBA8096F19ACD4C4D.jpg",
     "role": "Admin",
     "detail": {
        "title": "",
        "email": "userone@domo.com",
        "phoneNumber": "",
        "employeeNumber": 1,
        "pending": false
    }
 },
 {
     "id": 2,
     "displayName": "User Two",
     "avatarKey": "/domo/avatars/v1/avatars/dev/86/510BB31EE19FDDBA8046F18ACD3C5D.jpg",
     "role": "Privileged",
     "detail": {
        "title": "",
        "email": "usertwo@domo.com",
        "phoneNumber": "",
        "employeeNumber": 2,
        "pending": false
    }
 },
...
]
```

--------------------------------

### Install Libraries in Jupyter Workspace

Source: https://www.domo.com/docs/links/jupyter

Install external Python libraries using the conda package manager via the terminal.

```bash
conda install seaborn -y
```

--------------------------------

### Get Beast Mode Request

Source: https://www.domo.com/docs/portal/bff3ab39f7a6b-beast-modes

Use this GET request to retrieve a specific Beast Mode calculation. Ensure the X-DOMO-Developer-Token header is populated with a valid token.

```json
{
  "method": "GET",
  "url": "https://{instance}.domo.com/api/query/v1/functions/template/{beastmodeId}",
  "headers": {
    "X-DOMO-Developer-Token": "",
    "Content-Type": "application/json"
  }
}
```

--------------------------------

### Publish Custom App

Source: https://www.domo.com/docs/portal/Apps/App-Framework/Tools/domo-CLI

Upload assets from the current directory as a Custom App design.

```bash
domo publish [options]
```
Tokens:
Raw