Search
Use the Search API to query Dremio entities such as tables, jobs, views, scripts, and reflections.
Search Object{
"sessionId": "210be060-b680-43ab-8333-f519847802dd",
"nextPageToken": "eyJwYWdlVG9rZW4iOiJRV053Y2pZellETjBjRE4zMGlZaFJXWXRnalpoSlRMd0FETXcwaU5sWlRZelkyTjJRaUdDd3Rua0tNRUdBc2llR0pDTUlCTTFJZ0MiLCJxdWVyeSI6InRlc3QiLCJmaWx0ZXIiOiIifQ",
"results": [
{
"catalogObject": {
"path": ["Prod", "Sales", "Orders"],
"branch": "main",
"type": "TABLE",
"labels": ["finance", "monthly"],
"wiki": "Contains monthly sales data",
"owner": {
"id": "user-1",
"type": "USER",
"username": "data_admin"
},
"createdAt": "2023-01-01T10:00:00Z",
"lastModifiedAt": "2024-01-01T10:00:00Z",
"columns": ["order_id", "amount", "order_date"]
}
}
]
}
Search Attributes
sessionId String
Session identifier to correlate API calls during feedback collection.
Example: "210be060-b680-43ab-8333-f519847802dd"
nextPageToken String
Token of the next page of results to fetch in a paginated response.
Example: "eyJwYWdlVG9rZW4iOiJRV053Y2pZellETjBjRE4zMGlZaFJXWXRnalpoSlRMd0FETXcwaU5sWlRZelkyTjJRaUdDd3Rua0tNRUdBc2llR0pDTUlCTTFJZ0MiLCJxdWVyeSI6InRlc3QiLCJmaWx0ZXIiOiIifQ"
results Array of Object
Array of search results. Each result object can contain a catalogObject, jobObject, scriptObject, or reflectionObject.
Performing a Search
Search for indexed entities such as tables, views, reflections, jobs, functions, scripts, and folders.
Method and URLPOST /v0/api/projects/{project-id}/search
Parameters
query Body String
Search string.
Example: "views with date columns"
filter Body String
Optional Common Expression Language (CEL) filter expression to refine the search.
Example: category in ["TABLE"]
pageToken Body String Optional
Token used to retrieve the next page of results.
Example: "eyJwYWdlVG9rZW4iOiJRV053Y2pZellETjBjRE4zMGlZaFJXWXRnalpoSlRMd0FETXcwaU5sWlRZelkyTjJRaUdDd3Rua0tNRUdBc2llR0pDTUlCTTFJZ0MiLCJxdWVyeSI6InRlc3QiLCJmaWx0ZXIiOiIifQ"
maxResults Body Integer Optional
Maximum number of results to return per page.
Example: 10
Example Requestcurl -X POST 'https://{hostname}/v0/api/projects/{project-id}/search' \
--header 'Content-Type: application/json' \
--header 'Authorization: Bearer <PersonalAccessToken> \
--data-raw {
"query": "revenue",
"filter": "category in [\"JOB\"]",
"pageToken": "",
"maxResults": 20
}'
{
"sessionId": "6e90f536-d4bd-4ab5-b01e-f81aa4f3002d",
"results": [
{
"category": "job",
"jobObject": {
"id": "1802c3f8-05cc-a9fa-417b-0539c5d17700",
"queriedDatasets": [],
"sql": " \"SELECT * FROM test\"",
"jobType": "UI_PREVIEW",
"user": {
"id": "788a3438-db1b-483d-a75f-11b6a5d36f31",
"type": "USER",
"username": "dremio"
},
"startTime": "2025-04-14T16:47:03.981Z",
"finishTime": "2025-04-14T16:47:03.991Z",
"jobStatus": "COMPLETED",
"error": ""
}
},
{
"category": "job",
"jobObject": {
"id": "1802c419-06fb-be51-9cc2-e158ebaeea00",
"queriedDatasets": [],
"sql": "grant all on engine \"test\" to user \"olivier\"",
"jobType": "UI_PREVIEW",
"user": {
"id": "788a3438-db1b-483d-a75f-11b6a5d36f31",
"type": "USER",
"username": "dremio"
},
"startTime": "2025-04-14T16:46:30.717Z",
"finishTime": "2025-04-14T16:46:30.730Z",
"jobStatus": "FAILED",
"error": "GRANT on ENGINE is not supported in this edition."
}
}]
}
Response Status Codes
200 OK
400 Bad Request
401 Unauthorized
500 Internal Server Error
Object Schemas
searchResultObject Object
Search result object. One of the following fields will be populated based on the result type.
category String
The type of the result object.
Enum: FOLDER, SPACE, TABLE, VIEW, REFLECTION, UDF, SCRIPT, JOB, SOURCE
catalogObject Object Optional
If the result is a catalog object, this field contains the SearchCatalogObject.
Example: { "path": [ "testGlue", "folder", "table" ], "type": "TABLE", "labels": [], "createdAt": "2024-09-11T17:59:19.162Z", "lastModifiedAt": "2024-09-11T17:59:19.164Z", "columns": [], "owner": { "id": "ca63ab73-8ee1-467b-811c-224b8f47b9e0", "type": "USER", "username": "user@domain.com" } }
jobObject Object Optional
If the result is a job, this field contains the SearchJobObject.
Example: { "id": "3f6c6332-18bf-487c-b73e-157e91628aaa", "queriedDatasets": [], "sql": "REFRESH DATASET "source"."test-database"."test-table"", "jobType": "METADATA_REFRESH", "user": { "id": "2", "type": "USER", "username": "internal" }, "startTime": "2025-04-14T15:26:14.825Z", "finishTime": "2025-04-14T15:26:39.421Z", "jobStatus": "COMPLETED"}
reflectionObject Object Optional
If the result is a reflection, this field contains the SearchReflectionObject.
Example: { "id": "31ac58b6-0f2f-4d95-b44b-0f80846a3bd3", "name": "Raw Reflection", "datasetType": "table", "datasetPath": [ "Samples", "samples.dremio.com", "NYC-taxi-trips-iceberg" ], "createdAt": "2025-04-15T17:28:16.281Z", "lastModifiedAt": "2025-04-15T17:28:16.281Z", "datasetBranch": "" }
scriptObject Object Optional
If the result is a script, this field contains the SearchScriptObject.
Example: { "id": "1b53bf6c-dd9b-4f16-90e2-23b3c4cfd04f", "name": "test", "owner": { "id": "67f66278-d464-4b7f-b564-e3d58a85bbaf", "type": "USER", "username": "internal" }, "content": "SELECT * FROM\nSamples."samples.dremio.com"."NYC-taxi-trips-iceberg" w\n\n", "createdAt": "2025-04-14T20:48:29.470Z", "lastModifiedAt": "2025-04-15T08:14:45.724Z" }
catalogObject Object
Attributes for folders, tables, functions, and views.
path Array of String
Namespace path to the object.
Example: ["Samples","samples.dremio.com"]
branch String Optional
Versioned branch name.
Example: "main"
type String
Enum: FOLDER, SPACE, TABLE, FUNCTION, VIEW.
labels Array of String Optional
User-defined labels.
Example: ["eng","test"]
wiki String Optional
Markdown-formatted documentation or notes.
Example:
### Orders Table
This table contains **monthly sales data** by region.
owner Object
User or role object.
Example: { "id": "788a3438-db1b-483d-a75f-11b6a5d36f31", "type": "USER", "username": "dremio" }
createdAt DateTime
Creation timestamp (RFC 3339).
Example: "2025-04-14T16:47:03.981Z"
lastModifiedAt DateTime
Last modification timestamp (RFC 3339).
Example: "2025-04-14T16:47:03.981Z"
columns Array of String Optional
Column names.
Example: ["a", "b"]
functionSql String Optional
SQL definition for functions.
Example: For function created with:
-- Example function
CREATE FUNCTION total(a INT, b INT) RETURNS INT RETURN a + b
The functionSql is:
SELECT a + b
jobObject Object
Attributes for jobs.
id String
Unique identifier for the job.
Example: "1802c3f8-05cc-a9fa-417b-0539c5d17700"
queriedDatasets Array of Object
Datasets queried in the job.
Example: [ { "datasetType": "TABLE", "datasetPath": [ "Samples", "samples.dremio.com", "NYC-taxi-trips-iceberg" ] }]
sql String
Executed SQL statement.
Example: "SELECT * FROM Samples."samples.dremio.com"."NYC-taxi-trips-iceberg" LIMIT 5"
jobType String
Type of job: UI_RUN, JDBC, METADATA_REFRESH, etc.
Example: "UI_RUN"
user Object
User or role who ran the job.
Example: { "id": "788a3438-db1b-483d-a75f-11b6a5d36f31", "type": "USER", "username": "dremio" }
startTime DateTime
Job start timestamp.
Example: "2025-04-14T16:47:03.981Z"
finishTime DateTime
Job completion timestamp.
Example: "2025-04-14T16:47:03.981Z"
jobStatus String
Job status: COMPLETED, FAILED, CANCELED.
Example: "COMPLETED"
error String Optional
Error message if the job failed.
Example: "Object 'Samples.samples.dremio.com.NYC-taxi-trips' not found. Please check that it exists in the selected context."
scriptObject Object
Attributes for SQL scripts.
id String
Script identifier.
Example: "396eac66-f5d5-4f46-9c51-9d26dd3fc612"
name String
Name of the script.
Example: "test"
owner Object
User or role object.
Example: { "id": "788a3438-db1b-483d-a75f-11b6a5d36f31", "type": "USER", "username": "dremio" }
content String
SQL content.
Example:
SELECT *
FROM Samples."samples.dremio.com"."NYC-taxi-trips.csv"
LIMIT 1
createdAt DateTime
Creation timestamp.
Example: "2025-04-14T16:47:03.981Z"
lastModifiedAt DateTime
Last modified timestamp.
Example: "2025-04-14T16:47:03.981Z"
reflectionObject Object
Attributes for reflections.
id String
Reflection ID.
Example: "8711a739-3cc5-4830-8f71-8ea5525291d0"
name String
Name of the reflection.
Example: "Raw Reflection"
datasetType String
Enum: TABLE, VIEW
Example: "TABLE"
datasetPath Array of String
Path to the dataset.
Example: ["Samples", "samples.dremio.com", "NYC-taxi-trips-iceberg"]
datasetBranch String
Dataset branch.
Example: "main"
createdAt DateTime
Creation timestamp.
Example: "2025-04-14T16:47:03.981Z"
lastModifiedAt DateTime
Last modified timestamp.
Example: "2025-04-14T16:47:03.981Z"
UserOrRole Object
Used in owner or user fields.
id String
Unique ID of the user or role.
type String
Enum: USER, ROLE.
username String Conditional
Present for USER.
Example: "data_admin"
roleName String Conditional
Present for ROLE.
Example: "ADMIN"