> ## Documentation Index
> Fetch the complete documentation index at: https://docs.omni.co/llms.txt
> Use this file to discover all available pages before exploring further.
# Run document queries with the Query API
> Programmatically run document queries with the Omni API.
export const categoryIcons = {
'administration': 'lock',
'api': 'terminal',
'connections': 'database',
'dashboards': 'table-columns',
'embed': 'code',
'errors': 'exclamation',
'modeling': 'wrench',
'patterns': 'plus',
'schedules & alerts': 'envelope',
'visualizations': 'chart-column',
'workbooks': 'book'
};
export const GuideSidebar = ({category, relatedLinks, updatedDate}) => {
const [progress, setProgress] = React.useState(0);
React.useEffect(() => {
const sidebar = document.querySelector('.guide-sidebar');
if (!sidebar) return;
let container = sidebar.parentElement;
while (container && !container.querySelector('.guide-header')) {
container = container.parentElement;
}
if (container && !container.classList.contains('guide-page-layout')) {
container.classList.add('guide-page-layout');
}
}, []);
React.useEffect(() => {
const handleScroll = () => {
const scrollTop = window.scrollY;
const docHeight = document.documentElement.scrollHeight - window.innerHeight;
const scrollPercent = docHeight > 0 ? scrollTop / docHeight * 100 : 0;
setProgress(Math.min(100, Math.max(0, scrollPercent)));
};
window.addEventListener('scroll', handleScroll, {
passive: true
});
handleScroll();
return () => window.removeEventListener('scroll', handleScroll);
}, []);
const icon = category ? categoryIcons[category.toLowerCase()] || 'book' : 'book';
return ;
};
export const GuideTitle = ({title}) => {
return
{title}
;
};
The [Document queries API](/api/documents/get-document-queries) provides information about documents and their associated queries. You can use these queries directly with the [Run query API](/api/queries) to programmatically run the document's queries.
## Requirements
To follow the steps in this guide, you'll need an [Omni API key](/api/authentication).
## Steps
```bash title="GET /api/v1/documents/:id/queries" theme={null}
curl -L'https://.omniapp.co/api/v1/documents/12db1a0a/queries' \
-H 'Authorization: Bearer '
```
The query objects returned by the Document Queries API are already structured in the format required by the Query API, making it easy to run these queries programmatically without having to manually build the query structure.
```javascript theme={null}
const document = response.body;
const queryObject = document.queries[0].query;
```
Use the query object directly with the [Run query API](/api/queries) to run the query:
```bash title="POST /api/v1/query/run" theme={null}
curl -L -X POST 'https://.omniapp.co/api/v1/query/run' \
-H 'Authorization: Bearer ' \
-H 'Content-Type: application/json' \
-d '{
"query": {
"limit": 1000,
"sorts": [
{
"column_name": "order_items.created_at[month]",
"sort_descending": false
}
],
"table": "order_items",
"fields": [
"order_items.created_at[month]",
"order_items.sale_price_sum"
],
"filters": {},
"modelId": "7155f419-a071-405c-8426-b4b5d3939049"
}
}'
```