curl --request POST \
--url https://{instance}.domo.com/query \
--header 'Content-Type: application/json' \
--header 'X-DOMO-Developer-Token: <api-key>' \
--data '
{
"count": 20,
"offset": 0,
"query": "sales data",
"filters": [],
"sort": {},
"facetValuesToInclude": [],
"facetValueLimit": 0,
"facetValueOffset": 0,
"includePhonetic": true,
"entityList": [
[
"dataflow"
]
]
}
'import requests
url = "https://{instance}.domo.com/query"
payload = {
"count": 20,
"offset": 0,
"query": "sales data",
"filters": [],
"sort": {},
"facetValuesToInclude": [],
"facetValueLimit": 0,
"facetValueOffset": 0,
"includePhonetic": True,
"entityList": [["dataflow"]]
}
headers = {
"X-DOMO-Developer-Token": "<api-key>",
"Content-Type": "application/json"
}
response = requests.post(url, json=payload, headers=headers)
print(response.text)const options = {
method: 'POST',
headers: {'X-DOMO-Developer-Token': '<api-key>', 'Content-Type': 'application/json'},
body: JSON.stringify({
count: 20,
offset: 0,
query: 'sales data',
filters: [],
sort: {},
facetValuesToInclude: [],
facetValueLimit: 0,
facetValueOffset: 0,
includePhonetic: true,
entityList: [['dataflow']]
})
};
fetch('https://{instance}.domo.com/query', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));<?php
$curl = curl_init();
curl_setopt_array($curl, [
CURLOPT_URL => "https://{instance}.domo.com/query",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "POST",
CURLOPT_POSTFIELDS => json_encode([
'count' => 20,
'offset' => 0,
'query' => 'sales data',
'filters' => [
],
'sort' => [
],
'facetValuesToInclude' => [
],
'facetValueLimit' => 0,
'facetValueOffset' => 0,
'includePhonetic' => true,
'entityList' => [
[
'dataflow'
]
]
]),
CURLOPT_HTTPHEADER => [
"Content-Type: application/json",
"X-DOMO-Developer-Token: <api-key>"
],
]);
$response = curl_exec($curl);
$err = curl_error($curl);
curl_close($curl);
if ($err) {
echo "cURL Error #:" . $err;
} else {
echo $response;
}package main
import (
"fmt"
"strings"
"net/http"
"io"
)
func main() {
url := "https://{instance}.domo.com/query"
payload := strings.NewReader("{\n \"count\": 20,\n \"offset\": 0,\n \"query\": \"sales data\",\n \"filters\": [],\n \"sort\": {},\n \"facetValuesToInclude\": [],\n \"facetValueLimit\": 0,\n \"facetValueOffset\": 0,\n \"includePhonetic\": true,\n \"entityList\": [\n [\n \"dataflow\"\n ]\n ]\n}")
req, _ := http.NewRequest("POST", url, payload)
req.Header.Add("X-DOMO-Developer-Token", "<api-key>")
req.Header.Add("Content-Type", "application/json")
res, _ := http.DefaultClient.Do(req)
defer res.Body.Close()
body, _ := io.ReadAll(res.Body)
fmt.Println(string(body))
}HttpResponse<String> response = Unirest.post("https://{instance}.domo.com/query")
.header("X-DOMO-Developer-Token", "<api-key>")
.header("Content-Type", "application/json")
.body("{\n \"count\": 20,\n \"offset\": 0,\n \"query\": \"sales data\",\n \"filters\": [],\n \"sort\": {},\n \"facetValuesToInclude\": [],\n \"facetValueLimit\": 0,\n \"facetValueOffset\": 0,\n \"includePhonetic\": true,\n \"entityList\": [\n [\n \"dataflow\"\n ]\n ]\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://{instance}.domo.com/query")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Post.new(url)
request["X-DOMO-Developer-Token"] = '<api-key>'
request["Content-Type"] = 'application/json'
request.body = "{\n \"count\": 20,\n \"offset\": 0,\n \"query\": \"sales data\",\n \"filters\": [],\n \"sort\": {},\n \"facetValuesToInclude\": [],\n \"facetValueLimit\": 0,\n \"facetValueOffset\": 0,\n \"includePhonetic\": true,\n \"entityList\": [\n [\n \"dataflow\"\n ]\n ]\n}"
response = http.request(request)
puts response.read_body{
"facetMap": {},
"totalResultCount": 1865,
"sort": {
"fieldSorts": [
{
"field": "createDate",
"sortOrder": "DESC"
}
],
"activity": null,
"activitySortType": null,
"metricAction": null,
"isHotness": false,
"isRelevance": true
},
"queryUuid": "d775bcda-f3f6-4c62-b0b1-d3c57a609637",
"hideSearchObjects": false,
"searchObjects": [
{}
],
"searchResultsMap": {}
}Search for entities in Domo with filters, sorting, and faceting capabilities
curl --request POST \
--url https://{instance}.domo.com/query \
--header 'Content-Type: application/json' \
--header 'X-DOMO-Developer-Token: <api-key>' \
--data '
{
"count": 20,
"offset": 0,
"query": "sales data",
"filters": [],
"sort": {},
"facetValuesToInclude": [],
"facetValueLimit": 0,
"facetValueOffset": 0,
"includePhonetic": true,
"entityList": [
[
"dataflow"
]
]
}
'import requests
url = "https://{instance}.domo.com/query"
payload = {
"count": 20,
"offset": 0,
"query": "sales data",
"filters": [],
"sort": {},
"facetValuesToInclude": [],
"facetValueLimit": 0,
"facetValueOffset": 0,
"includePhonetic": True,
"entityList": [["dataflow"]]
}
headers = {
"X-DOMO-Developer-Token": "<api-key>",
"Content-Type": "application/json"
}
response = requests.post(url, json=payload, headers=headers)
print(response.text)const options = {
method: 'POST',
headers: {'X-DOMO-Developer-Token': '<api-key>', 'Content-Type': 'application/json'},
body: JSON.stringify({
count: 20,
offset: 0,
query: 'sales data',
filters: [],
sort: {},
facetValuesToInclude: [],
facetValueLimit: 0,
facetValueOffset: 0,
includePhonetic: true,
entityList: [['dataflow']]
})
};
fetch('https://{instance}.domo.com/query', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));<?php
$curl = curl_init();
curl_setopt_array($curl, [
CURLOPT_URL => "https://{instance}.domo.com/query",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "POST",
CURLOPT_POSTFIELDS => json_encode([
'count' => 20,
'offset' => 0,
'query' => 'sales data',
'filters' => [
],
'sort' => [
],
'facetValuesToInclude' => [
],
'facetValueLimit' => 0,
'facetValueOffset' => 0,
'includePhonetic' => true,
'entityList' => [
[
'dataflow'
]
]
]),
CURLOPT_HTTPHEADER => [
"Content-Type: application/json",
"X-DOMO-Developer-Token: <api-key>"
],
]);
$response = curl_exec($curl);
$err = curl_error($curl);
curl_close($curl);
if ($err) {
echo "cURL Error #:" . $err;
} else {
echo $response;
}package main
import (
"fmt"
"strings"
"net/http"
"io"
)
func main() {
url := "https://{instance}.domo.com/query"
payload := strings.NewReader("{\n \"count\": 20,\n \"offset\": 0,\n \"query\": \"sales data\",\n \"filters\": [],\n \"sort\": {},\n \"facetValuesToInclude\": [],\n \"facetValueLimit\": 0,\n \"facetValueOffset\": 0,\n \"includePhonetic\": true,\n \"entityList\": [\n [\n \"dataflow\"\n ]\n ]\n}")
req, _ := http.NewRequest("POST", url, payload)
req.Header.Add("X-DOMO-Developer-Token", "<api-key>")
req.Header.Add("Content-Type", "application/json")
res, _ := http.DefaultClient.Do(req)
defer res.Body.Close()
body, _ := io.ReadAll(res.Body)
fmt.Println(string(body))
}HttpResponse<String> response = Unirest.post("https://{instance}.domo.com/query")
.header("X-DOMO-Developer-Token", "<api-key>")
.header("Content-Type", "application/json")
.body("{\n \"count\": 20,\n \"offset\": 0,\n \"query\": \"sales data\",\n \"filters\": [],\n \"sort\": {},\n \"facetValuesToInclude\": [],\n \"facetValueLimit\": 0,\n \"facetValueOffset\": 0,\n \"includePhonetic\": true,\n \"entityList\": [\n [\n \"dataflow\"\n ]\n ]\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://{instance}.domo.com/query")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Post.new(url)
request["X-DOMO-Developer-Token"] = '<api-key>'
request["Content-Type"] = 'application/json'
request.body = "{\n \"count\": 20,\n \"offset\": 0,\n \"query\": \"sales data\",\n \"filters\": [],\n \"sort\": {},\n \"facetValuesToInclude\": [],\n \"facetValueLimit\": 0,\n \"facetValueOffset\": 0,\n \"includePhonetic\": true,\n \"entityList\": [\n [\n \"dataflow\"\n ]\n ]\n}"
response = http.request(request)
puts response.read_body{
"facetMap": {},
"totalResultCount": 1865,
"sort": {
"fieldSorts": [
{
"field": "createDate",
"sortOrder": "DESC"
}
],
"activity": null,
"activitySortType": null,
"metricAction": null,
"isHotness": false,
"isRelevance": true
},
"queryUuid": "d775bcda-f3f6-4c62-b0b1-d3c57a609637",
"hideSearchObjects": false,
"searchObjects": [
{}
],
"searchResultsMap": {}
}Authorizations
Domo Developer Token for authentication
Body
The query term. Use * for wildcard
Which entities to perform the query on. Entities can be grouped together.
Valid entities include: [[account], [alert], [app], [beast_mode], [card], [connector], [data_app], [dataset], [dataflow], [group], [page], [user]]
How many results to return
The results offset. Count and offset can only return a total of 10,000 records
Search results must match ALL filters
- Option 1
- Option 2
- Option 3
- Option 4
- Option 5
- Option 6
- Option 7
- Option 8
- Option 9
Show child attributes
Show child attributes
Search results must match ANY filter
- Option 1
- Option 2
- Option 3
- Option 4
- Option 5
- Option 6
- Option 7
- Option 8
- Option 9
Show child attributes
Show child attributes
Search results must NOT match any filter
- Option 1
- Option 2
- Option 3
- Option 4
- Option 5
- Option 6
- Option 7
- Option 8
- Option 9
Show child attributes
Show child attributes
How to sort the results. Defaults to relevance sorting
Show child attributes
Show child attributes
Facets (or groupings) to include in the search results
How many of the facet values to return
The facet value offset
Whether to use phonetic matching
Define which fields to return. Defaults to all fields
Response
Search results
The facet groupings requested
Show child attributes
Show child attributes
The total count of results that match the query
1865
The sort used in the query
Show child attributes
Show child attributes
A unique generated ID
"d775bcda-f3f6-4c62-b0b1-d3c57a609637"
false
A list of all search results
Search results grouped as defined by the entityList
Show child attributes
Show child attributes