Query Collections
curl --request POST \
--url https://{instance}.domo.com/api/datastores/v1/collections/query \
--header 'Content-Type: application/json' \
--header 'X-DOMO-Developer-Token: <api-key>' \
--data '
{
"collectionFilteringList": [
{
"filterType": "nameof",
"typedValue": "users"
}
],
"sortBy": "createdOn",
"direction": "DESC",
"pageSize": 25,
"pageNumber": 1
}
'import requests
url = "https://{instance}.domo.com/api/datastores/v1/collections/query"
payload = {
"collectionFilteringList": [
{
"filterType": "nameof",
"typedValue": "users"
}
],
"sortBy": "createdOn",
"direction": "DESC",
"pageSize": 25,
"pageNumber": 1
}
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({
collectionFilteringList: [{filterType: 'nameof', typedValue: 'users'}],
sortBy: 'createdOn',
direction: 'DESC',
pageSize: 25,
pageNumber: 1
})
};
fetch('https://{instance}.domo.com/api/datastores/v1/collections/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/api/datastores/v1/collections/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([
'collectionFilteringList' => [
[
'filterType' => 'nameof',
'typedValue' => 'users'
]
],
'sortBy' => 'createdOn',
'direction' => 'DESC',
'pageSize' => 25,
'pageNumber' => 1
]),
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/api/datastores/v1/collections/query"
payload := strings.NewReader("{\n \"collectionFilteringList\": [\n {\n \"filterType\": \"nameof\",\n \"typedValue\": \"users\"\n }\n ],\n \"sortBy\": \"createdOn\",\n \"direction\": \"DESC\",\n \"pageSize\": 25,\n \"pageNumber\": 1\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/api/datastores/v1/collections/query")
.header("X-DOMO-Developer-Token", "<api-key>")
.header("Content-Type", "application/json")
.body("{\n \"collectionFilteringList\": [\n {\n \"filterType\": \"nameof\",\n \"typedValue\": \"users\"\n }\n ],\n \"sortBy\": \"createdOn\",\n \"direction\": \"DESC\",\n \"pageSize\": 25,\n \"pageNumber\": 1\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://{instance}.domo.com/api/datastores/v1/collections/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 \"collectionFilteringList\": [\n {\n \"filterType\": \"nameof\",\n \"typedValue\": \"users\"\n }\n ],\n \"sortBy\": \"createdOn\",\n \"direction\": \"DESC\",\n \"pageSize\": 25,\n \"pageNumber\": 1\n}"
response = http.request(request)
puts response.read_body{
"totalCollectionCount": 1,
"pageSize": 1,
"pageNumber": 1,
"pageCount": 1,
"collections": [
{
"id": "232e6d6c-46e9-49b6-a137-8933f0f05999",
"owner": 870010733,
"name": "users",
"syncEnabled": true,
"createdOn": "2024-01-15T18:42:30.115Z",
"updatedOn": "2024-01-15T18:42:30.115Z",
"documentCount": 42,
"datastoreId": "39b88a97-8247-4c0d-ba1d-8ed78d1a6680",
"datastoreName": "My App Datastore"
}
],
"ownedBy": [
{
"ownerId": "870010733",
"ownerName": "Jane Smith",
"collectionCount": 1
}
],
"createdOn": {
"sevenDaysAgo": 0,
"fifteenDaysAgo": 1,
"thirtyDaysAgo": 1
}
}Query Collections
Filter and sort collections using field-level predicates with pagination.
POST
/
api
/
datastores
/
v1
/
collections
/
query
Query Collections
curl --request POST \
--url https://{instance}.domo.com/api/datastores/v1/collections/query \
--header 'Content-Type: application/json' \
--header 'X-DOMO-Developer-Token: <api-key>' \
--data '
{
"collectionFilteringList": [
{
"filterType": "nameof",
"typedValue": "users"
}
],
"sortBy": "createdOn",
"direction": "DESC",
"pageSize": 25,
"pageNumber": 1
}
'import requests
url = "https://{instance}.domo.com/api/datastores/v1/collections/query"
payload = {
"collectionFilteringList": [
{
"filterType": "nameof",
"typedValue": "users"
}
],
"sortBy": "createdOn",
"direction": "DESC",
"pageSize": 25,
"pageNumber": 1
}
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({
collectionFilteringList: [{filterType: 'nameof', typedValue: 'users'}],
sortBy: 'createdOn',
direction: 'DESC',
pageSize: 25,
pageNumber: 1
})
};
fetch('https://{instance}.domo.com/api/datastores/v1/collections/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/api/datastores/v1/collections/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([
'collectionFilteringList' => [
[
'filterType' => 'nameof',
'typedValue' => 'users'
]
],
'sortBy' => 'createdOn',
'direction' => 'DESC',
'pageSize' => 25,
'pageNumber' => 1
]),
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/api/datastores/v1/collections/query"
payload := strings.NewReader("{\n \"collectionFilteringList\": [\n {\n \"filterType\": \"nameof\",\n \"typedValue\": \"users\"\n }\n ],\n \"sortBy\": \"createdOn\",\n \"direction\": \"DESC\",\n \"pageSize\": 25,\n \"pageNumber\": 1\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/api/datastores/v1/collections/query")
.header("X-DOMO-Developer-Token", "<api-key>")
.header("Content-Type", "application/json")
.body("{\n \"collectionFilteringList\": [\n {\n \"filterType\": \"nameof\",\n \"typedValue\": \"users\"\n }\n ],\n \"sortBy\": \"createdOn\",\n \"direction\": \"DESC\",\n \"pageSize\": 25,\n \"pageNumber\": 1\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://{instance}.domo.com/api/datastores/v1/collections/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 \"collectionFilteringList\": [\n {\n \"filterType\": \"nameof\",\n \"typedValue\": \"users\"\n }\n ],\n \"sortBy\": \"createdOn\",\n \"direction\": \"DESC\",\n \"pageSize\": 25,\n \"pageNumber\": 1\n}"
response = http.request(request)
puts response.read_body{
"totalCollectionCount": 1,
"pageSize": 1,
"pageNumber": 1,
"pageCount": 1,
"collections": [
{
"id": "232e6d6c-46e9-49b6-a137-8933f0f05999",
"owner": 870010733,
"name": "users",
"syncEnabled": true,
"createdOn": "2024-01-15T18:42:30.115Z",
"updatedOn": "2024-01-15T18:42:30.115Z",
"documentCount": 42,
"datastoreId": "39b88a97-8247-4c0d-ba1d-8ed78d1a6680",
"datastoreName": "My App Datastore"
}
],
"ownedBy": [
{
"ownerId": "870010733",
"ownerName": "Jane Smith",
"collectionCount": 1
}
],
"createdOn": {
"sevenDaysAgo": 0,
"fifteenDaysAgo": 1,
"thirtyDaysAgo": 1
}
}Authorizations
Domo Developer Token for authentication.
Query Parameters
Include a summary of collections grouped by owner in the response.
Include a summary of collections grouped by creation date in the response.
Body
application/json
Show child attributes
Show child attributes
Field to sort by. One of: documentCount, createdOn, updatedOn, name, datastoreName.
Available options:
ASC, DESC Number of results per page. Pass -1 to return all results.
1-indexed page number. Pass -1 to return all results.
Response
200 - application/json
OK
Show child attributes
Show child attributes
Aggregate of collections grouped by owner. Present when the ownedBy query parameter is true (default).
Show child attributes
Show child attributes
Aggregate of collections grouped by creation date. Present when the createdOn query parameter is true (default).
Show child attributes
Show child attributes