Skip to main content
POST
/
query
Query
curl --request POST \
  --url https://{instance}.domo.com/api/search/v1/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"
    ]
  ]
}
'
{
  "facetMap": {},
  "totalResultCount": 1865,
  "sort": {
    "fieldSorts": [
      {
        "field": "createDate",
        "sortOrder": "DESC"
      }
    ],
    "activity": "<unknown>",
    "activitySortType": "<unknown>",
    "metricAction": "<unknown>",
    "isHotness": false,
    "isRelevance": true
  },
  "queryUuid": "d775bcda-f3f6-4c62-b0b1-d3c57a609637",
  "hideSearchObjects": false,
  "searchObjects": [
    {}
  ],
  "searchResultsMap": {}
}

Authorizations

​
X-DOMO-Developer-Token
string
header
required

Domo Developer Token for authentication

Body

application/json
​
query
string
required

The query term. Use * for wildcard

​
entityList
string[][]
required

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]]

​
count
integer
default:10

How many results to return

​
offset
number
default:0

The results offset. Count and offset can only return a total of 10,000 records

​
filters
object[]

Search results must match ALL filters

​
orFilters
object[]

Search results must match ANY filter

​
notFilters
object[]

Search results must NOT match any filter

​
sort
object

How to sort the results. Defaults to relevance sorting

​
facetValuesToInclude
string[]

Facets (or groupings) to include in the search results

​
facetValueLimit
number
default:0

How many of the facet values to return

​
facetValueOffset
number
default:0

The facet value offset

​
includePhonetic
boolean

Whether to use phonetic matching

​
fieldsToReturn
string[]

Define which fields to return. Defaults to all fields

Response

Search results

​
facetMap
object

The facet groupings requested

​
totalResultCount
integer

The total count of results that match the query

Example:

1865

​
sort
object

The sort used in the query

​
queryUuid
string

A unique generated ID

Example:

"d775bcda-f3f6-4c62-b0b1-d3c57a609637"

​
hideSearchObjects
boolean
Example:

false

​
searchObjects
object[]

A list of all search results

​
searchResultsMap
object

Search results grouped as defined by the entityList